Merge pull request #18 from stvoutsin/20240109-readme

Update run options documentation
stvoutsin · Jan 9, 2024 · e82c27a · e82c27a
2 parents 4646244 + f102f67
commit e82c27a
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -54,7 +54,7 @@ If using docker-compose to run the library, this step is handled for you.
     # Create an instance of TAPValidator
     tap_validator = TAPValidator(config)
 
-    # Run the desired action (COMPARISON, VALIDATION, TABLE_VALIDATION_ONLY)
+    # Run the desired action (COMPARISON, VALIDATION, TABLE_VALIDATION)
     asyncio.run(tap_validator.run(mode="COMPARISON", fullscan=False))
 
 

diff --git a/src/tapvalidator/tap_validator.py b/src/tapvalidator/tap_validator.py
@@ -6,8 +6,10 @@
 validates various aspects of a TAP Service, or if TABLE_VALIDATION_ONLY is the run
 mode, only the Tables of a TAP Service are validated.
 
-TABLE_VALIDATION_ONLY can be used for healthchecking a TAP Service and
+TABLE_VALIDATION can be used for healthchecking a TAP Service and
 its underlying SQL Database
+VALIDATION does a test of various parts of the TAP Service
+COMPARISON compares two TAP Services with a list of queries
 """
 import asyncio
 import click