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

Stencila schema and other specifications

{
  "title": "Environment",
  "@id": "stencila:Environment",
  "role": "primary",
  "status": "experimental",
  "description": "A computational environment.",
  "properties": {
    "type": {
      "description": "The name of the type and all descendant types.",
      "type": "string",
      "enum": [
        "Environment"
      ],
      "default": "Environment",
      "from": "Thing"
    },
    "id": {
      "description": "The identifier for this item.",
      "type": "string",
      "from": "Thing"
    },
    "alternateNames": {
      "@id": "schema:alternateName",
      "description": "Alternate names (aliases) for the item.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "from": "Thing",
      "aliases": [
        "alternateName"
      ]
    },
    "description": {
      "@id": "schema:description",
      "description": "A description of the item.",
      "type": "string",
      "from": "Thing"
    },
    "meta": {
      "@id": "stencila:meta",
      "description": "Metadata associated with this item.",
      "type": "object",
      "from": "Thing"
    },
    "name": {
      "@id": "schema:name",
      "description": "The name of the item.",
      "type": "string",
      "from": "Thing"
    },
    "url": {
      "@id": "schema:url",
      "description": "The URL of the item.",
      "type": "string",
      "format": "uri",
      "from": "Thing"
    },
    "extends": {
      "@id": "stencila:extends",
      "description": "Other environments that this environment extends by adding or removing packages.,",
      "type": "array",
      "items": {
        "$ref": "Environment.schema.json"
      },
      "from": "Environment",
      "aliases": [
        "extend"
      ]
    },
    "adds": {
      "@id": "stencila:adds",
      "description": "The packages that this environment adds to the base environments listed under `extends` (if any).,",
      "type": "array",
      "items": {
        "$ref": "SoftwareSourceCode.schema.json"
      },
      "from": "Environment",
      "aliases": [
        "add"
      ]
    },
    "removes": {
      "@id": "stencila:removes",
      "description": "The packages that this environment removes from the base environments listed under `extends` (if any).,",
      "type": "array",
      "items": {
        "$ref": "SoftwareSourceCode.schema.json"
      },
      "from": "Environment",
      "aliases": [
        "remove"
      ]
    },
    "environmentSource": {
      "@id": "stencila:environmentSource",
      "description": "Source of environment definition. For example, a URL to a Dockerfile, a path to Singularity recipe file,\nor a path to a filesystem folder.,\n",
      "allOf": [
        {
          "type": "string"
        }
      ],
      "from": "Environment"
    }
  },
  "required": [
    "type",
    "name"
  ],
  "source": "https://github.com/stencila/schema/blob/master/schema/software/Environment.schema.yaml",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://stencila.github.com/schema/Environment.schema.json",
  "category": "software",
  "children": [],
  "descendants": [],
  "type": "object",
  "aliases": true,
  "additionalProperties": false,
  "parent": "Thing"
}