@stencila/schema/dist/CodeChunk.schema.json

{
  "title": "CodeChunk",
  "@id": "stencila:CodeChunk",
  "extends": "CodeExecutable",
  "category": "code",
  "role": "secondary",
  "status": "unstable",
  "description": "A executable chunk of code.",
  "properties": {
    "type": {
      "@id": "schema:type",
      "description": "The name of the type.",
      "type": "string",
      "enum": [
        "CodeChunk"
      ],
      "default": "CodeChunk",
      "from": "Entity"
    },
    "id": {
      "@id": "schema:id",
      "description": "The identifier for this item.",
      "type": "string",
      "from": "Entity"
    },
    "meta": {
      "@id": "stencila:meta",
      "description": "Metadata associated with this item.",
      "type": "object",
      "from": "Entity"
    },
    "text": {
      "@id": "schema:text",
      "description": "The text of the code.",
      "type": "string",
      "from": "Code"
    },
    "programmingLanguage": {
      "@id": "schema:programmingLanguage",
      "description": "The programming language of the code.",
      "type": "string",
      "from": "Code",
      "isOverride": true
    },
    "mediaType": {
      "@id": "schema:encodingFormat",
      "aliases": [
        "encodingFormat"
      ],
      "description": "Media type, typically expressed using a MIME format, of the code.",
      "$comment": "This property allows the differentiation of formats using the same programming language\nor variants of a programming language. An example is using `programmingLanguage` \"json\" and\n`encodingFormat` \"application/ld+json\" for JSON-LD code examples.\n",
      "type": "string",
      "from": "Code"
    },
    "compileDigest": {
      "@id": "stencila:compileDigest",
      "description": "The SHA-256 digest of the `text`, `programmingLanguage` and `mediaType` properties the last time the node was compiled.",
      "type": "string",
      "$comment": "Used to determine whether it is necessary to re-compile the node (i.e. to semantically analyse it\nfor dependencies).\n",
      "from": "CodeExecutable"
    },
    "executeDigest": {
      "@id": "stencila:executeDigest",
      "description": "The SHA-256 digest of `compileDigest` and the `executeDigest`s of all dependencies, the last time the node was executed.",
      "type": "string",
      "$comment": "Used to determine whether it is necessary to re-execute the code.\n",
      "from": "CodeExecutable"
    },
    "errors": {
      "@id": "stencila:errors",
      "description": "Errors when compiling (e.g. syntax errors) or executing the chunk.",
      "type": "array",
      "items": {
        "$ref": "CodeError.schema.json"
      },
      "from": "CodeExecutable",
      "isArray": true,
      "isPlural": true,
      "aliases": [
        "error"
      ]
    },
    "duration": {
      "@id": "stencila:duration",
      "description": "Duration in seconds of the last execution of the code.",
      "type": "number",
      "minimum": 0,
      "from": "CodeExecutable"
    },
    "label": {
      "@id": "stencila:label",
      "description": "A short label for the CodeChunk.",
      "type": "string",
      "from": "CodeChunk"
    },
    "caption": {
      "@id": "schema:caption",
      "description": "A caption for the CodeChunk.",
      "$comment": "An array of nodes or, to be compatible with https://schema.org/caption, a string.\n",
      "anyOf": [
        {
          "type": "array",
          "items": {
            "$ref": "BlockContent.schema.json"
          }
        },
        {
          "type": "string"
        }
      ],
      "from": "CodeChunk"
    },
    "outputs": {
      "@id": "stencila:outputs",
      "description": "Outputs from executing the chunk.",
      "type": "array",
      "items": {
        "$ref": "Node.schema.json"
      },
      "from": "CodeChunk",
      "isArray": true,
      "isPlural": true,
      "aliases": [
        "output"
      ]
    }
  },
  "examples": [
    {
      "type": "CodeChunk",
      "programmingLanguage": "python",
      "text": "print('Hello world!')"
    }
  ],
  "file": "CodeChunk.schema.yaml",
  "children": [],
  "descendants": [],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.stenci.la/v1/CodeChunk.schema.json",
  "source": "https://github.com/stencila/schema/blob/master/schema/CodeChunk.schema.yaml",
  "type": "object",
  "propertyAliases": {
    "encodingFormat": "mediaType",
    "error": "errors",
    "output": "outputs"
  },
  "additionalProperties": false,
  "required": [
    "type",
    "text",
    "programmingLanguage"
  ]
}