@stencila/schema/dist/built/Include.schema.json

Stencila schema and other specifications

{
  "title": "Include",
  "@id": "stencila:Include",
  "description": "A directive to include content from an external source (e.g. file, URL) or content.\n",
  "role": "secondary",
  "status": "experimental",
  "properties": {
    "type": {
      "description": "The type of node.",
      "type": "string",
      "const": "Include",
      "from": "Include",
      "enum": [
        "Include"
      ],
      "default": "Include"
    },
    "source": {
      "description": "The JSON Reference to the included content.",
      "type": "string",
      "from": "Include"
    },
    "content": {
      "description": "The content to be included. This is either obtained from the source (when specified).",
      "type": "string",
      "from": "Include"
    },
    "mimetype": {
      "description": "The MIME type of the content.",
      "type": "string",
      "from": "Include"
    },
    "parsed": {
      "description": "A SHA1 hash of the content and mimetype the last time that the content was included.",
      "type": "string",
      "from": "Include"
    },
    "value": {
      "description": "The tree of nodes imported from the content.",
      "type": "object",
      "oneOf": [
        {
          "$ref": "Datatable.schema.json"
        },
        {
          "$ref": "Table.schema.json"
        }
      ],
      "from": "Include"
    }
  },
  "anyOf": [
    {
      "required": [
        "source"
      ]
    },
    {
      "required": [
        "content",
        "mimetype"
      ]
    }
  ],
  "dependencies": {
    "parsed": [
      "content",
      "mimetype"
    ],
    "value": [
      "parsed"
    ]
  },
  "source": "https://github.com/stencila/schema/blob/master/schema/Include.schema.yaml",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://stencila.github.com/schema/Include.schema.json",
  "category": ".",
  "children": [],
  "descendants": [],
  "type": "object",
  "additionalProperties": false
}