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

Stencila schema and other specifications

{
  "title": "ResourceParameters",
  "@id": "stencila:ResourceParameters",
  "role": "secondary",
  "status": "experimental",
  "description": "Describes limits or requested amounts for a particular resource (e.g. memory or CPU).\n",
  "properties": {
    "type": {
      "description": "The name of the type and all descendant types.",
      "type": "string",
      "enum": [
        "ResourceParameters"
      ],
      "default": "ResourceParameters",
      "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"
    },
    "resourceLimit": {
      "@id": "stencila:resourceLimit",
      "description": "The maximum amount of the resource that can be used.",
      "type": "number",
      "minimum": 0,
      "from": "ResourceParameters"
    },
    "resourceRequested": {
      "@id": "stencila:resourceRequested",
      "description": "The amount of the resource that has been requested (and possibly reserved).",
      "type": "number",
      "minimum": 0,
      "from": "ResourceParameters"
    }
  },
  "source": "https://github.com/stencila/schema/blob/master/schema/software/ResourceParameters.schema.yaml",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://stencila.github.com/schema/ResourceParameters.schema.json",
  "category": "software",
  "children": [],
  "descendants": [],
  "type": "object",
  "additionalProperties": false,
  "required": [
    "type"
  ],
  "parent": "Thing"
}