@stencila/schema
Version:
Stencila schema and other specifications
117 lines (116 loc) • 2.93 kB
JSON
{
"title": "SoftwareSession",
"@id": "stencila:SoftwareSession",
"role": "primary",
"status": "experimental",
"description": "Represents a runtime session with the resources and image that is required by software to execute.\n",
"properties": {
"type": {
"description": "The name of the type and all descendant types.",
"type": "string",
"enum": [
"SoftwareSession"
],
"default": "SoftwareSession",
"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"
},
"volumeMounts": {
"@id": "stencila:volumeMount",
"description": "Volumes to mount in the session.",
"type": "array",
"items": [
{
"$ref": "Mount.schema.json"
}
],
"from": "SoftwareSession",
"aliases": [
"volumeMount"
]
},
"cpuResource": {
"@id": "stencila:cpuResource",
"allOf": [
{
"$ref": "ResourceParameters.schema.json"
}
],
"from": "SoftwareSession"
},
"memoryResource": {
"@id": "stencila:memoryResource",
"allOf": [
{
"$ref": "ResourceParameters.schema.json"
}
],
"from": "SoftwareSession"
},
"environment": {
"@id": "stencila:environment",
"description": "Definition of the environment to execute this session in.",
"allOf": [
{
"$ref": "Environment.schema.json"
}
],
"from": "SoftwareSession"
}
},
"required": [
"type",
"environment"
],
"source": "https://github.com/stencila/schema/blob/master/schema/software/SoftwareSession.schema.yaml",
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://stencila.github.com/schema/SoftwareSession.schema.json",
"category": "software",
"children": [],
"descendants": [],
"type": "object",
"aliases": true,
"additionalProperties": false,
"parent": "Thing"
}