schemadescriptor.schema.json

{
  "meta:license": [
    "Copyright 2018 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/"
  ],
  "$id": "https://ns.adobe.com/xdm/common/desciptors/schemadescriptor",
  "$schema": "http://json-schema.org/draft-06/schema#",
  "title": "Schema Descriptor",
  "meta:extensible": true,
  "meta:abstract": false,
  "type": "object",
  "description":
    "A descriptor that contains metadata about an XDM schema, including an optional property and array item selector, used to address the descriptor to a specific property or item.",
  "definitions": {
    "descriptor": {
      "properties": {
        "@id": {
          "title": "Identifier",
          "type": "string",
          "format": "uri",
          "description":
            "The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'"
        },
        "@type": {
          "title": "Type",
          "type": "string",
          "description": "The type of descriptor this object represents",
          "meta:enum": {}
        },
        "xdm:sourceSchema": {
          "title": "Source Schema",
          "type": "string",
          "format": "uri",
          "description":
            "The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'"
        },
        "xdm:sourceProperty": {
          "title": "Source Property",
          "type": "string",
          "description":
            "When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by `xdm:sourceSchema`."
        },
        "xdm:sourceItem": {
          "title": "Source Item",
          "description":
            "When present, the selector used to match a specific item in the array pointed to by `sourceProperty`",
          "$ref":
            "https://ns.adobe.com/xdm/common/descriptors/itemselector#/definitions/selector"
        }
      }
    }
  },
  "allOf": [
    {
      "$ref": "https://ns.adobe.com/xdm/common/extensible#/definitions/@context"
    },
    {
      "$ref": "#/definitions/descriptor"
    }
  ],
  "meta:status": "experimental"
}