@stencila/schema/schema/Include.schema.yaml

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.
role: secondary
status: experimental
properties:
  type:
    description: The type of node.
    type: string
    const: Include
  source:
    description: The JSON Reference to the included content.
    type: string
  content:
    description: The content to be included. This is either obtained from the source (when specified).
    type: string
  mimetype:
    description: The MIME type of the content.
    type: string
  parsed:
    description: A SHA1 hash of the content and mimetype the last time that the content was included.
    type: string
  value:
    description: The tree of nodes imported from the content.
    type: object
    oneOf:
      - $ref: Datatable.schema.yaml
      - $ref: Table.schema.yaml
# Either needs to have `source` specified (from which `content` and `mimetype` are derived)
# or have `content` and `mimetype` specified.
anyOf:
  - required:
      - source
  - required:
      - content
      - mimetype
dependencies:
  parsed:
    - content
    - mimetype
  value:
    - parsed