bfg-schemautil 0.1.0

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

schemautil

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

Example

Given the following object schema:

{
  "type": "object",
  "properties": {
    "a": { "type": "string" },
    "b": { "type": "string" }
  },
  "required": ["a", "b"],
  "additionalProperties": false
}

You can generate this schema using:

obj_schema({"a": "string", "b": "string"})

Rules

• All fields are required and additionalProperties is always set to false.
• To make a field nullable, add a ? to the end of its name.
  Example: {"a": "string", "b?": "string"} (b is nullable)
• To define an array, wrap the type in brackets.
  Example: {"a": "string", "b": ["string"]} (b is an array of strings)
  Note: There should be only one type in the array.
• To define a field that can be one of multiple types, list the types in brackets.
  Example: {"a": "string", "b": ["string", "number"]} (b can be a string or a number)