json-schema-for-avro-schema-1-7-3.json

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "title": "avro-schema",
    "description": "JSON Schema for an Apache Avro schema, version 1.7.3",
    "notes": [
        "Adapted from https://github.com/fge/sample-json-schemas",
        "The Apache Avro project does not appear to define json schemas for its avro schema spec.",
        "I'm using this as a test-bed for adding unit analysis information to Avro schema resolution."
    ],
    "oneOf": [
        { "type": "string" },
        {
            "type": "object",
            "required": [ "type" ],
            "properties": {
                "type": { "$ref": "#/definitions/primitiveTypes" }
            }
        },
        { "$ref": "#/definitions/record" },
        { "$ref": "#/definitions/enum" },
        { "$ref": "#/definitions/array" },
        { "$ref": "#/definitions/map" },
        { "$ref": "#/definitions/union" },
        { "$ref": "#/definitions/fixed" }
    ],
    "definitions": {
        "primitiveTypes": {
            "description": "One primitive type",
            "enum": [ "null", "boolean", "int", "long", "float", "double", "bytes", "string" ]
        },
        "record": {
            "description": "A record",
            "type": "object",
            "required": [ "type", "name", "fields" ],
            "properties": {
                "type": { "enum": [ "record" ] },
                "name": { "$ref": "#/definitions/nameOrNamespace" },
                "nameOrNamespace": { "$ref": "#/definitions/nameOrNamespace" },
                "doc": { "type": "string" },
                "aliases": { "$ref": "#/definitions/aliases" },
                "fields": {
                    "type": "array",
                    "items": { "$ref": "#/definitions/field" }
                }
            }
        },
        "enum": {
            "description": "an enum as defined by the Avro specification",
            "type": "object",
            "required": [ "type", "name", "symbols" ],
            "properties": {
                "type": { "enum": [ "enum" ] },
                "name": { "$ref": "#/definitions/nameOrNamespace" },
                "nameOrNamespace": { "$ref": "#/definitions/nameOrNamespace" },
                "aliases": { "$ref": "#/definitions/aliases" },
                "doc": { "type": "string" },
                "symbols": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                        "type": "string",
                        "minLength": 1,
                        "pattern": "^(?![_\\d])\\w+$"
                    },
                    "uniqueItems": true
                }
            }
        },
        "array": {
            "description": "An array as defined by the Avro specification",
            "notes": [ "spec doesn't say whether \"items\" is required!" ],
            "type": "object",
            "required": [ "type" ],
            "properties": {
                "type": { "enum": [ "array" ] },
                "items": { "$ref": "#" }
            }
        },
        "map": {
            "description": "A map as defined by the Avro specification",
            "notes": [ "spec doesn't say whether \"values\" is required!" ],
            "type": "object",
            "required": [ "type" ],
            "properties": {
                "type": { "enum": [ "map" ] },
                "values": { "$ref": "#" }
            }
        },
        "union": {
            "description": "A union of schemas",
            "type": "array",
            "uniqueItems": true,
            "items": {
                "allOf": [
                    { "$ref": "#" },
                    { "not": { "$ref": "#/definitions/union" } }
                ]
            }
        },
        "fixed": {
            "description": "A fixed type, as defined by the Avro specification",
            "type": "object",
            "required": [ "type", "name", "size" ],
            "properties": {
                "type": { "enum": [ "fixed" ] },
                "name": { "$ref": "#/definitions/nameOrNamespace" },
                "nameOrNamespace": { "$ref": "#/definitions/nameOrNamespace" },
                "size": {
                    "type": "integer",
                    "minimum": 0,
                    "exclusiveMinimum": true
                },
                "aliases": { "$ref": "#/definitions/aliases" }
            }
        },
        "nameOrNamespace": {
            "description": "what a nameOrNamespace can be",
            "type": "string",
            "pattern": "^[A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)*$"
        },
        "aliases": {
            "type": "array",
            "minItems": 1,
            "uniqueItems": true,
            "items": {"$ref": "#/definitions/nameOrNamespace" }
        },
        "field": {
            "description": "One field in a record",
            "type": "object",
            "required": [ "name", "type" ],
            "properties": {
                "name": { "$ref": "#/definitions/nameOrNamespace" },
                "doc": { "type": "string" },
                "type": { "$ref": "#" },
                "unit": { "$ref": "https://raw.githubusercontent.com/erikerlandson/unit-analysis-json-schema/master/unit-analysis-schema.json#/definitions/unit_expr" },
                "default": {
                    "description": "default value, depending on the type"
                },
                "order": {
                    "enum": [ "ascending", "descending", "ignore" ]
                },
                "aliases": { "$ref": "#/definitions/aliases" }
            }
        }
    }
}