sdf-schema.json

{
  "title": "SDF Schema",
  "description": "old, pre-1.0 JSON-schema.org definitions for validating SDF instances against the SDF model.",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "properties": {
    "info": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "copyright": {
          "type": "string"
        },
        "license": {
          "type": "string"
        }
      },
      "required": ["title", "version", "copyright", "license"],
      "additionalProperties": false
    },
    "namespace": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "defaultnamespace": {
      "type": "string"
    },
    
    "odmThing": {
      "description": "Thing is a composition of objects that work together in some way",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/thingqualities"
      }
    },
    "odmProduct": {
      "description": "Product is a composition of things and objects that can model a SKU-level instance of a product",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/productqualities"
      }
    },
    "odmObject": {
      "description": "Object is a set of Properties, Actions, and Events that together perform a particular function",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/objectqualities"
      }
    },
    "odmProperty": {
      "description": "Property represents the state of an instance of an object",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/propertyqualities"
      }
    },
    "odmAction": {
      "description": "Action is a directive to invoke an application layer verb associated with an object",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/actionqualities"
      }
    },
    "odmEvent": {
      "description": "Event represents an occurence of something associated with an object",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/eventqualities"
      }
    },
    "odmData": {
      "description": "Data represents a piece of information that can be the state of a property or a parameter to an action or a signal in an event",
      "type": "object",
      "additionalProperties": {
        "$ref": "#/definitions/dataqualities"
      }
    }
  },

  "definitions": {
    "sdf-pointer": {
          "type": "string",
          "format": "uri-reference"
    },
    "pointer-list": {
      "type": "array",
      "items": {
        "$ref": "#/definitions/sdf-pointer"
      }
    },
    "commonqualities": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string"
        },
        "$comment": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "odmRef": {
          "$ref": "#/definitions/sdf-pointer"
        },
        "odmType": {
          "type": "object",
          "properties": {
            "$ref": {
              "type": "string"
            },
          "additionalProperties": false        
          }
        },
        "odmRequired": {
          "$ref": "#/definitions/pointer-list"
        }
      },
      "required": []
    },

    "thingqualities": {
      "allOf": [
        {
          "$ref": "#/definitions/commonqualities"
        },
        {
          "type": "object",
          "properties": {
            "odmObject": {"$ref": "#/properties/odmObject"},
            "odmThing": {"$ref": "#/properties/odmThing"}
          }
        }
      ]
    },

    "productqualities": {
      "allOf": [
        {
          "$ref": "#/definitions/commonqualities"
        },
        {
          "type": "object",
          "properties": {
            "odmObject": {"$ref": "#/properties/odmObject"},
            "odmThing": {"$ref": "#/properties/odmThing"}
          }
        }
      ]
    },

    "objectqualities": {
      "allOf": [
        {
          "$ref": "#/definitions/commonqualities"
        },
        {
          "type": "object",
          "properties": {
            "odmObject": {"$ref": "#/properties/odmObject"},
            "odmProperty": {"$ref": "#/properties/odmProperty"},
            "odmAction": {"$ref": "#/properties/odmAction"},
            "odmEvent": {"$ref": "#/properties/odmEvent"},
            "odmData": {"$ref": "#/properties/odmData"}
          }
        }
      ]
    },

    "propertyqualities": {
      "allOf": [
        {
          "$ref": "#/definitions/dataqualities"
        }
      ]
    },

    "actionqualities": {
      "allOf":[
        {
          "$ref": "#/definitions/commonqualities"
        },
        {
          "type": "object",
          "properties": {
            "odmInputData": {
              "$ref": "#/definitions/pointer-list"
            },
            "odmRequiredInputData": {
              "$ref": "#/definitions/pointer-list"
            },
            "odmOutputData": {
              "$ref": "#/definitions/pointer-list"
            }          
          }
        }
      ]   
    },

    "eventqualities": {
      "allOf":[
        {
          "$ref": "#/definitions/commonqualities"
        },
        {
          "type": "object",
          "properties": {
            "odmOutputData": {
              "$ref": "#/definitions/pointer-list"
            }          
          }
        }
      ]    
    },

    "dataqualities": {
      "allOf": [
        {
          "$ref":"#/definitions/commonqualities"
        },
        {
          "$ref":"#/definitions/jsonschema"
        },
        {
          "type": "object",
          "properties": {
            "units": {
              "type": "string"
            },
            "scaleMinimum": {
              "type": "number"
            },
            "scaleMaximum": {
              "type": "number"
            },
            "observable": {
              "type": "boolean"
            },
            "readable": {
              "type": "boolean"
            },
            "writable": {
              "type": "boolean"
            },
            "nullable": {
              "type": "boolean"
            },
            "widthInBits": {
              "type": "number"
            },
            "subtype":{
              "type": "string",
              "enum": ["bytestring", "unixtime"]
            },
            "contentFormat": {
              "type": "string"
            }
          }
        }
      ]
    },

    "jsonschema": {
      "type": "object",
      "properties": {
        "$comment": {
          "type": "string"
        },
        "$ref": {
          "$ref": "#/definitions/sdf-pointer"
        },
        "type": {
          "type": "string",
          "enum": [
            "number",
            "string",
            "boolean",
            "integer",
            "array",
            "object"
          ]
        },
        "enum": {
          "type": "array",
          "minItems": 1
        },
        "const": {
          "oneOf": [
            { "type": "number"},
            { "type": "string"},
            { "type": "boolean"},
            { "type": "array"},
            { "type": "object"},
            { "type": "null"}
          ]
        },
        "default": {
          "oneOf": [
            { "type": "number"},
            { "type": "string"},
            { "type": "boolean"},
            { "type": "array"},
            { "type": "object"},
            { "type": "null"}
          ]
        },
        "pattern": {
          "type": "string"
        },
        "format": {
          "type": "string",
          "enum": [
            "date-time",
            "date",
            "time",
            "duration",
            "email",
            "idn-email",
            "hostname",
            "idn-hostname",
            "ipv4",
            "ipv6",
            "uri",
            "uri-reference",
            "iri",
            "iri-reference",
            "uuid",
            "uri-template",
            "json-pointer",
            "relative-json-pointer",
            "regex"
          ]
        },
        "minimum": {
          "type": "number"
        },
        "maximum": {
          "type": "number"
        },
        "exclusiveMinimum": {
          "type": "boolean"
        },
        "exclusiveMaximum": {
          "type": "boolean"
        },
        "multipleOf": {
          "type": "number"
        },
        "maxLength": {
          "type": "number"
        },
        "minLength": {
          "type": "number"
        },
        "oneOf": {
          "type": "array",
          "minItems": 1
        },
        "anyOf": {
          "type": "array",
          "minItems": 1
        },
        "allOf": {
          "type": "array",
          "minItems": 1
        },
        "items": {
          "oneOf": [
            {
              "type": "array"
            },
            {
              "type": "object"
            }
          ]
        },
        "contains": {
          "oneOf": [
            {
              "type": "array"
            },
            {
              "type": "object"
            }
          ]
        },
        "minItems": {
          "type": "number"
        },
        "maxItems": {
          "type": "number"
        },
        "uniqueItems": {
          "type": "boolean"
        },
        "properties": {
          "type": "object"
        }
      }
    }
  }
}