Usage

JSON Schema utility functions and commands.

Compatibility Validation

It validates compatibility between different JSON schemas versions.

A schema is backward compatible if the fields’ type remain the same in all JSON schemas declaring it and JSON schemas are type consistent within themselves too.

>>> import json
>>> from io import open
>>>
>>> import doschema.validation
>>> from doschema.utils import detect_encoding
>>>
>>> schemas = [
...     './examples/jsonschema_for_repetition.json',
...     './examples/jsonschema_repetition.json'
... ]
>>>
>>> schema_validator = doschema.validation.JSONSchemaValidator()
>>> for schema in schemas:
...     with open(schema, 'rb') as infile:
...         byte_file = infile.read()
...         encoding = detect_encoding(byte_file)
...         string_file = byte_file.decode(encoding)
...         json_schema = json.loads(string_file)
...         schema_validator.validate(json_schema, schema)

By default the index of “array” “items” are ignored. Thus all the values of an array should have the same type in order to be compatible. This behavior can be disabled by setting “ignore_index = False” in the validator’s constructor.

>>> import json
>>> from io import open
>>>
>>> import doschema.validation
>>> from doschema.utils import detect_encoding
>>>
>>> schemas = [
...     './examples/jsonschema_with_index_option.json'
... ]
>>>
>>> schema_validator = doschema.validation.JSONSchemaValidator(
...     ignore_index = False
... )
>>> for schema in schemas:
...     with open(schema, 'rb') as infile:
...         byte_file = infile.read()
...         encoding = detect_encoding(byte_file)
...         string_file = byte_file.decode(encoding)
...         json_schema = json.loads(string_file)
...         schema_validator.validate(json_schema, schema)

CLI usage

$ doschema validate jsonschema_for_repetition.json \
jsonschema_repetition.json
$ doschema validate jsonschema_with_index_option.json --with_index