json-schema-utils 0.8.4

JSON Schema Utils

JSON Schema Utils

Random utilities to analyze and manipulate JSON Schema.

Installation

Install latest version with pip from PyPI or directly from GitHub:

python -m venv venv
source venv/bin/activate
# from PyPI:
pip install json_schema_utils
# OR from latest sources:
pip install git+https://github.com/zx80/json-schema-utils.git

Inline Schema References

Replace references $ref by their definitions.

# no $id
jsu-inline -m "file:// ./tests" tests/*.schema.json
# with $id
jsu-inline -a tests/foo.schema.json

Simplify Schema

Apply various schema simplifications:

• remove type-incompatible keywords and formats, with warnings.
• try to move up list-of-one-schema *Of.
• simplify type lists.
• change list-of-one enum to const.
• detect some cases of infeasible schemas.
• remove uneffective keywords in corner cases.

jsu-simpler tests/*.schema.json

Check JSON Values against a Schema

Check a JSON values match a given schema using either jsonschema or jschon implementations.

jsu-check tests/foo.schema.json tests/foo.*.value.json

JSON Schema Stats and Issues

Generate a report about JSON schemas, including possible bugs.

jsu-stats tests/*.schema.json

This script is extracted from JSON Schema Stats which has been updated to depend on this module.

JSON Prettyprinter

jsu-pretty --indent 2 --sort-keys tests/*.schema.json

You could also use jq . for this purpose.

JSON Schema to JSON Model Conversion

Convert a subset of JSON Schema to JSON Model. The subset should comply with some restrictions described in Section 6 of An Analysis of Defects in Public JSON Schemas by Claire Yannou-Medrala and Fabien Coelho:

• const, enum, $ref, type, allOf, anyOf, oneOf should be exclusive.
• some keywords are not supported: multipleOf, contains
• conditions if then else are translated to the logical equivalent: {if: C, then: T, else: E} is (C and T) or (not C and E)

jsu-model test/foo.schema.json

TODO

• Testing. CI.
• stats: warn instead of errors on unsure issues under if/then/else/not.
• propagate non type under containers (*Of, if, then, else, reference?) to reduce false positive errors/warnings.
• simplify: deduplicate constants in enum?