bfg-schemautil 0.2.0

A set of utilities to generate JSON Schema from simple JSON objects

JSON Schema is good but very verbose. Writing it by hand is hard. This library defines a simpler version of JSON Schema. It supports only part of the full spec and turns that simpler format into standard JSON Schema.

Examples:

an object

{
    "x": "string",
    "y": "number",
}

nullable fields

{
    "x?": "string",
}

"x?" is a shortcut for

{
    "x": ["string", "null"],
}

union fields

{
    "x": ["string", "number"],
}

array

{
    "x": ["string"],
}

enum (uses set type in python)

{
    "x": {1,2,3,"unknown",null},
}

complex union type

{
    "x": [
        "number",
        { "z": "string" },
    ],
}

By default, the object schema is strict: all properties are required, and no extra properties are allowed.

Code example:

from schemautil import object_schema

object_schema({
    "x": "string",
    "y": "number",
})