@stencila/schema/dist/CodeError.schema.json

Extensions to schema.org to support semantic, composable, parameterize-able and executable documents

{
  "title": "CodeError",
  "@id": "stencila:CodeError",
  "extends": "Entity",
  "role": "tertiary",
  "status": "unstable",
  "category": "code",
  "description": "An error that occurred when parsing, compiling or executing a Code node.",
  "properties": {
    "type": {
      "@id": "schema:type",
      "description": "The name of the type.",
      "type": "string",
      "enum": [
        "CodeError"
      ],
      "default": "CodeError",
      "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"
    },
    "errorType": {
      "@id": "stencila:errorType",
      "description": "The type of error e.g. \"SyntaxError\", \"ZeroDivisionError\".",
      "$comment": "Many languages have the concept of alternative types of errors.\nFor example, Python has various [classes of exceptions](https://docs.python.org/3/tutorial/errors.html).\nThis property is intended to be used for storing these type names as additional\ninformation that maybe useful to the user attempting to resolve the error.\n",
      "type": "string",
      "from": "CodeError"
    },
    "errorMessage": {
      "@id": "stencila:errorMessage",
      "aliases": [
        "message"
      ],
      "description": "The error message or brief description of the error.",
      "type": "string",
      "from": "CodeError"
    },
    "stackTrace": {
      "@id": "stencila:stackTrace",
      "aliases": [
        "trace"
      ],
      "description": "Stack trace leading up to the error.",
      "type": "string",
      "from": "CodeError"
    }
  },
  "required": [
    "type",
    "errorMessage"
  ],
  "file": "CodeError.schema.yaml",
  "children": [],
  "descendants": [],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.stenci.la/v1/CodeError.schema.json",
  "source": "https://github.com/stencila/schema/blob/master/schema/CodeError.schema.yaml",
  "type": "object",
  "propertyAliases": {
    "message": "errorMessage",
    "trace": "stackTrace"
  },
  "additionalProperties": false
}