Skip to content

Commit

Permalink
#40: updated readme to include zip file option
Browse files Browse the repository at this point in the history
  • Loading branch information
mohit-s96 committed Jul 31, 2023
1 parent 2623081 commit 532e990
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions lib/schema/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
```bash
$ reso-certification-utils schema --help

Usage: reso-certification-utils schema [options]
Usage: reso-certification-utils schema [options]

Generate a schema or validate a payload against a schema
Expand All @@ -14,9 +15,9 @@ Options:
-o, --outputPath <string> Path tho the directory to store the generated schema
-p, --payloadPath <string> Path to the payload that needs to be validated
-s, --schemaPath <string> Path to the generated JSON schema
-e, --errorPath <string> Path to save error reports in case of failed validation
-e, --errorPath <string> Path to save error reports in case of failed validation. Defaults to "./errors"
-a, --additionalProperties Pass this flag to allow additional properties in the schema
-r, --resource <string> The resource for which to generate the schema
-z, --zipFilePath <string> Path to a zip file containing JSON payloads
-h, --help display help for command
```
Expand All @@ -34,4 +35,4 @@ Additional options:
```bash
reso-certification-utils schema -v -p <path to payloads json file> -s <path to the schema json file>
```
AJV errors could be large depending on how many errors are found. To save the errors in a file we can pass the directory where we want to save the errors file with `-e <path to error directory>`.
AJV errors could be large depending on how many errors are found. To save the errors in a file we can pass the directory where we want to save the errors file with `-e <path to error directory>`. By default they will be saved inside `./errors`.

0 comments on commit 532e990

Please sign in to comment.