Skip to content

Commit 4a0f31b

Browse files
authored
Fix validation CLI documentation (#183)
2 parents 9154755 + 1015250 commit 4a0f31b

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

content/api/cli.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ In these commands:
2828

2929
## Validating declarations
3030

31-
{{< refItem name="ota validate [--services <service_id>...] [--types <terms_type>...]" description="Check that all declarations allow recording a snapshot and a version properly. If service IDs are provided, check only those services." example="npx ota validate --services \"Facebook\" \"LinkedIn\" --types \"Privacy Policy\" \"Terms of Service\"" />}}
31+
{{< refItem name="ota validate declarations [--services <service_id>...] [--types <terms_type>...]" description="Check that all declarations allow recording a snapshot and a version properly. If service IDs are provided, check only those services." example="npx ota validate declarations --services \"Facebook\" --types \"Privacy Policy\"" />}}
3232

33-
{{< refItem name="ota validate --schema-only [--services <service_id>...] [--types <terms_type>...]" description="Check that all declarations are readable by the engine. Allows for a much faster check of declarations, but does not check that the terms are actually accessible." example="npx ota validate --schema-only --services \"Facebook\" \"LinkedIn\" --types \"Privacy Policy\" \"Terms of Service\"" />}}
33+
{{< refItem name="ota validate declarations --schema-only [--services <service_id>...] [--types <terms_type>...]" description="Check that all declarations are readable by the engine. Allows for a much faster check of declarations, but does not check that the terms are actually accessible." example="npx ota validate declarations --schema-only --services \"Facebook\" --types \"Privacy Policy\"" />}}
3434

35-
{{< refItem name="ota validate --modified" description="Run ota validate only on files that have been modified in Git" example="npx ota validate --modified" />}}
35+
{{< refItem name="ota validate declarations --modified" description="Run ota validate only on files that have been modified in Git" example="npx ota validate declarations --modified" />}}
3636

3737
## Linting declarations
3838

@@ -42,6 +42,10 @@ In these commands:
4242

4343
{{< refItem name="ota lint --modified" description="Run ota lint only on files that have been modified in Git" example="npx ota lint --modified" />}}
4444

45+
## Validating metadata file
46+
47+
{{< refItem name="ota validate metadata" description="Check that the metadata file structure is valid" example="npx ota validate metadata" />}}
48+
4549
## Publishing dataset
4650

4751
{{< refItem name="ota dataset [--file <filename>]" description="Export the versions dataset into a ZIP file and publish it to GitHub releases. The dataset title and the URL of the versions repository are defined in the configuration." example="npx ota dataset --file dataset.zip" />}}

0 commit comments

Comments
 (0)