meta.schema.json

{
  "meta:license": [
    "Copyright 2017 Adobe Systems Incorporated. All rights reserved.",
    "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
    "you may not use this file except in compliance with the License. You may obtain a copy",
    "of the License at https://creativecommons.org/licenses/by/4.0/"
  ],
  "$schema": "http://json-schema.org/draft-06/schema#",
  "$id": "https://ns.adobe.com/xdm/meta",
  "title": "Meta-Schema for XDM",
  "type": "object",
  "description": "All Schema files have to adhere to this style guide.",
  "definitions": {
    "extending-all-of": {
      "type": "array",
      "minItems": 2,
      "items": {
        "type": "object",
        "properties": {
          "$ref": {
            "anyOf": [
              {
                "type": "string",
                "format": "uri"
              },
              {
                "type": "string",
                "pattern": "#/definitions/[a-z0-9]+"
              }
            ]
          }
        }
      }
    }
  },
  "properties": {
    "$schema": {
      "const": "http://json-schema.org/draft-06/schema#"
    },
    "$id": {
      "type": "string",
      "format": "uri",
      "pattern": "(https://ns\\.adobe\\.com/xdm/[a-z0-9-/]*)|(http://schema\\.org/.*)|(http://ns.adobe.com/adobecloud/core/1.0.*)|([http|https]://ns\\.adobe\\.com/adobecloudplatform/.*)|(https://tools\\.ietf\\.org/html/draft-kelly-json-hal-08/.*)|(http://www.iptc\\.org/.*)|(https://id3\\.org/id3v2.4/.*)|(https://ns\\.adobe\\.com/experience/[a-z0-9-/]*)|(https://ns\\.adobe\\.com/b2b/[a-z0-9-/]*)|(https://ns\\.airship\\.com/[a-z0-9-/]*)|(https://ns\\.algolia\\.com/[a-z0-9-/]*)|(https://ns\\.braze\\.com/[a-z0-9-/]*)|(https://ns\\.fhir\\.org/[a-z0-9-/]*)"
    },
    "meta:license": {
      "type": "array",
      "items": [
        {
          "type": "string",
          "pattern": "(Copyright 201[7-9] .*\\. All rights reserved\\.)|(Copyright 202[0-9] .*\\. All rights reserved\\.)"
        },
        {
          "type": "string",
          "const": "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license"
        },
        {
          "type": "string",
          "const": "you may not use this file except in compliance with the License. You may obtain a copy"
        },
        {
          "type": "string",
          "const": "of the License at https://creativecommons.org/licenses/by/4.0/"
        }
      ]
    },
    "meta:extensible": {
      "type": "boolean",
      "default": false,
      "description": "Set this `true` if the schema can be extended by other schemas."
    },
    "meta:auditable": {
      "type": "boolean",
      "default": false,
      "description": "Set this `true` if entities of this schema can have an audit record."
    },
    "meta:extends": {
      "oneOf": [
        {
          "type": "string",
          "format": "uri"
        },
        {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          }
        }
      ]
    },
    "meta:descriptors": {
      "type": "array",
      "items": {
        "type": "object",
        "$ref": "https://ns.adobe.com/xdm/common/descriptors/schemadescriptor#/definitions/descriptor"
      }
    },
    "meta:xdmType": {
      "description": "signals the logical data type of a field",
      "type": "string",
      "enum": [
        "string",
        "number",
        "long",
        "int",
        "short",
        "byte",
        "boolean",
        "date",
        "date-time",
        "map"
      ]
    },
    "type": {
      "type": "string",
      "const": "object"
    },
    "title": {
      "type": "string",
      "minLength": 3
    },
    "dcx:typeRestriction": {
      "type": "string",
      "pattern": "^(\\w+|\\*)/([-.\\w.]+|\\*)\\+dcx$",
      "description": "The DCX format or group of formats this schema can be applied to in validation workflows."
    }
  },
  "allOf": [
    {
      "oneOf": [
        {
          "properties": {
            "meta:extensible": {
              "const": true
            }
          },
          "required": ["definitions", "meta:extensible"]
        },
        {
          "properties": {
            "meta:extensible": {
              "const": false
            }
          }
        }
      ]
    },
    {
      "anyOf": [
        {
          "properties": {
            "meta:extends": {
              "type": "string",
              "format": "uri"
            },
            "allOf": { "$ref": "#/definitions/extending-all-of" }
          },
          "required": ["meta:extends", "allOf"]
        },
        {
          "properties": {
            "meta:extends": {
              "type": "array",
              "minItems": 1,
              "items": {
                "format": "uri",
                "type": "string"
              }
            },
            "allOf": { "$ref": "#/definitions/extending-all-of" }
          },
          "required": ["meta:extends", "allOf"]
        },
        {
          "properties": {
            "meta:extends": {
              "default": null,
              "const": null
            }
          }
        }
      ]
    },
    {
      "required": [
        "$schema",
        "$id",
        "meta:license",
        "type",
        "title",
        "description",
        "meta:status"
      ]
    }
  ],
  "meta:status": {
    "title": "Status",
    "description": "Indicates if the schema’s level of stability. Defined values are: stable, stabilizing, and experimental.",
    "type": "string",
    "meta:enum": ["stable", "stabilizing", "experimental", "deprecated"]
  }
}