@stencila/schema/dist/SoftwareSession.schema.json

{
  "title": "SoftwareSession",
  "@id": "stencila:SoftwareSession",
  "extends": "Thing",
  "role": "primary",
  "status": "experimental",
  "category": "code",
  "description": "Definition of a compute session, including its software and compute resource\nrequirements and status.\n",
  "$comment": "Usually used to define the environment that is required to execute an\nexecutable document.\n\nThis is \"inspired\" by the [OCI Runtime Config Schema](https://github.com/opencontainers/runtime-spec/blob/master/schema/config-schema.json)\nThere are a number of properties that did not seem relevant to our use as well as some\nreferences that did not seem to be required. We try to stay consistent with the naming\nused but have dereferenced and combined the config schema and \n[Linux Schema](https://github.com/opencontainers/runtime-spec/blob/master/schema/defs-linux.json) \nto use the cpu and memory limits.\n",
  "properties": {
    "type": {
      "@id": "schema:type",
      "description": "The name of the type.",
      "type": "string",
      "enum": [
        "SoftwareSession"
      ],
      "default": "SoftwareSession",
      "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"
    },
    "alternateNames": {
      "@id": "schema:alternateName",
      "description": "Alternate names (aliases) for the item.",
      "type": "array",
      "items": {
        "type": "string"
      },
      "from": "Thing",
      "isArray": true,
      "isPlural": true,
      "aliases": [
        "alternateName"
      ]
    },
    "description": {
      "@id": "schema:description",
      "description": "A description of the item.",
      "$comment": "Allows for the description to be an array of nodes (e.g. an array of inline content,\nor a couple of paragraphs), or a string. The `minItems` restriction avoids a string\nbeing coerced into an array with a single string item.\n",
      "anyOf": [
        {
          "type": "array",
          "items": {
            "$ref": "BlockContent.schema.json"
          }
        },
        {
          "type": "array",
          "items": {
            "$ref": "InlineContent.schema.json"
          },
          "minItems": 2
        },
        {
          "type": "string"
        }
      ],
      "from": "Thing"
    },
    "identifiers": {
      "@id": "schema:identifier",
      "description": "Any kind of identifier for any kind of Thing.",
      "$comment": "Some identifiers have specific properties e.g the `issn` property for\nthe `Periodical` type. These should be used in preference to this\nproperty which is intended for identifiers that do not yet have a\nspecific property. Identifiers can be represented as strings, but\nusing a `PropertyValue` will usually be better because it allows\nfor `propertyID` (i.e. the type of identifier).\n",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "PropertyValue.schema.json"
          },
          {
            "type": "string"
          }
        ]
      },
      "from": "Thing",
      "isArray": true,
      "isPlural": true,
      "aliases": [
        "identifier"
      ]
    },
    "images": {
      "@id": "schema:image",
      "description": "Images of the item.",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "ImageObject.schema.json"
          },
          {
            "type": "string",
            "format": "uri"
          }
        ]
      },
      "from": "Thing",
      "isArray": true,
      "isPlural": true,
      "aliases": [
        "image"
      ]
    },
    "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"
    },
    "environment": {
      "@id": "stencila:environment",
      "description": "The software environment to execute this session in.",
      "allOf": [
        {
          "$ref": "SoftwareEnvironment.schema.json"
        }
      ],
      "from": "SoftwareSession"
    },
    "dateStart": {
      "@id": "schema:startDate",
      "description": "The date-time that the session began.",
      "allOf": [
        {
          "$ref": "Date.schema.json"
        }
      ],
      "from": "SoftwareSession"
    },
    "dateEnd": {
      "@id": "schema:endDate",
      "description": "The date-time that the session ended.",
      "allOf": [
        {
          "$ref": "Date.schema.json"
        }
      ],
      "from": "SoftwareSession"
    },
    "status": {
      "@id": "stencila:sessionStatus",
      "description": "The status of the session (starting, stopped, etc).",
      "enum": [
        "Unknown",
        "Starting",
        "Started",
        "Stopping",
        "Stopped",
        "Failed"
      ],
      "from": "SoftwareSession"
    },
    "clientsRequest": {
      "@id": "stencila:clientsRequest",
      "description": "The maximum number of concurrent clients requested for the session.",
      "type": "number",
      "minimum": 0,
      "from": "SoftwareSession"
    },
    "clientsLimit": {
      "@id": "stencila:clientsLimit",
      "description": "The maximum number of concurrent clients the session is limited to.",
      "type": "number",
      "minimum": 0,
      "from": "SoftwareSession"
    },
    "durationRequest": {
      "@id": "stencila:durationRequest",
      "description": "The maximum duration (seconds) requested for the session.",
      "type": "number",
      "minimum": 0,
      "from": "SoftwareSession"
    },
    "durationLimit": {
      "@id": "stencila:durationLimit",
      "description": "The maximum duration (seconds) the session is limited to.",
      "type": "number",
      "minimum": 0,
      "from": "SoftwareSession"
    },
    "timeoutRequest": {
      "@id": "stencila:timeoutRequest",
      "description": "The inactivity timeout (seconds) requested for the session.",
      "type": "number",
      "minimum": 0,
      "from": "SoftwareSession"
    },
    "timeoutLimit": {
      "@id": "stencila:timeoutLimit",
      "description": "The inactivity timeout (seconds) the session is limited to.",
      "type": "number",
      "minimum": 0,
      "from": "SoftwareSession"
    },
    "cpuRequest": {
      "@id": "stencila:cpuRequest",
      "description": "The amount of CPU requested for the session.",
      "type": "number",
      "minimum": 0,
      "from": "SoftwareSession"
    },
    "cpuLimit": {
      "@id": "stencila:cpuLimit",
      "description": "The amount of CPU the session is limited to.",
      "type": "number",
      "minimum": 0,
      "from": "SoftwareSession"
    },
    "memoryRequest": {
      "@id": "stencila:memoryRequest",
      "description": "The amount of memory requested for the session.",
      "type": "number",
      "minimum": 0,
      "from": "SoftwareSession"
    },
    "memoryLimit": {
      "@id": "stencila:memoryLimit",
      "description": "The amount of memory that the session is limited to.",
      "type": "number",
      "minimum": 0,
      "from": "SoftwareSession"
    },
    "networkTransferRequest": {
      "@id": "stencila:networkTransferRequest",
      "description": "The amount of network data transfer (GiB) requested for the session.",
      "type": "number",
      "minimum": 0,
      "from": "SoftwareSession"
    },
    "networkTransferLimit": {
      "@id": "stencila:networkTransferLimit",
      "description": "The amount of network data transfer (GiB) that the session is limited to.",
      "type": "number",
      "minimum": 0,
      "from": "SoftwareSession"
    },
    "volumeMounts": {
      "@id": "stencila:volumeMounts",
      "description": "Volumes to mount in the session.",
      "type": "array",
      "items": {
        "$ref": "VolumeMount.schema.json"
      },
      "from": "SoftwareSession",
      "isArray": true,
      "isPlural": true,
      "aliases": [
        "volumeMount"
      ]
    }
  },
  "file": "SoftwareSession.schema.yaml",
  "children": [],
  "descendants": [],
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://schema.stenci.la/v1/SoftwareSession.schema.json",
  "source": "https://github.com/stencila/schema/blob/master/schema/SoftwareSession.schema.yaml",
  "type": "object",
  "propertyAliases": {
    "alternateName": "alternateNames",
    "identifier": "identifiers",
    "image": "images",
    "volumeMount": "volumeMounts"
  },
  "additionalProperties": false,
  "required": [
    "type"
  ]
}