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

Stencila schema and other specifications

{
  "title": "SoftwareSourceCode",
  "@id": "schema:SoftwareSourceCode",
  "role": "primary",
  "status": "unstable",
  "description": "Computer programming source code. Example: Full (compile ready) solutions, code snippet samples, scripts, templates.\n",
  "properties": {
    "type": {
      "description": "The name of the type and all descendant types.",
      "type": "string",
      "enum": [
        "SoftwareSourceCode",
        "CodeChunk",
        "CodeExpr"
      ],
      "default": "SoftwareSourceCode",
      "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"
    },
    "authors": {
      "@id": "schema:author",
      "description": "The authors of this this creative work.",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "Person.schema.json"
          },
          {
            "$ref": "Organization.schema.json"
          }
        ]
      },
      "from": "CreativeWork",
      "aliases": [
        "author"
      ]
    },
    "citations": {
      "@id": "schema:citation",
      "description": "Citations or references to other creative works, such as another publication, \nweb page, scholarly article, etc.\n",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string"
          },
          {
            "$ref": "CreativeWork.schema.json"
          }
        ]
      },
      "from": "CreativeWork",
      "aliases": [
        "citation"
      ]
    },
    "content": {
      "@id": "stencila:content",
      "description": "The structured content of this creative work c.f. property `text`.",
      "type": "array",
      "items": {
        "$ref": "Node.schema.json"
      },
      "from": "CreativeWork"
    },
    "dateCreated": {
      "@id": "schema:dateCreated",
      "description": "Date/time of creation.",
      "anyOf": [
        {
          "type": "string",
          "format": "date"
        },
        {
          "type": "string",
          "format": "date-time"
        }
      ],
      "from": "CreativeWork"
    },
    "dateModified": {
      "@id": "schema:dateModified",
      "description": "Date/time of most recent modification.",
      "anyOf": [
        {
          "type": "string",
          "format": "date"
        },
        {
          "type": "string",
          "format": "date-time"
        }
      ],
      "from": "CreativeWork"
    },
    "datePublished": {
      "@id": "schema:datePublished",
      "aliases": [
        "date"
      ],
      "description": "Date of first publication.",
      "anyOf": [
        {
          "type": "string",
          "format": "date"
        },
        {
          "type": "string",
          "format": "date-time"
        }
      ],
      "from": "CreativeWork"
    },
    "editors": {
      "@id": "schema:editor",
      "description": "Persons who edited the CreativeWork.\n",
      "type": "array",
      "items": {
        "$ref": "Person.schema.json"
      },
      "from": "CreativeWork",
      "aliases": [
        "editor"
      ]
    },
    "funders": {
      "@id": "schema:funder",
      "description": "Person or organisation that funded the CreativeWork.\n",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "Person.schema.json"
          },
          {
            "$ref": "Organization.schema.json"
          }
        ]
      },
      "from": "CreativeWork",
      "aliases": [
        "funder"
      ]
    },
    "isPartOf": {
      "@id": "schema:isPartOf",
      "description": "An item or other CreativeWork that this CreativeWork is a part of.\n",
      "allOf": [
        {
          "$ref": "CreativeWork.schema.json"
        }
      ],
      "from": "CreativeWork"
    },
    "licenses": {
      "@id": "schema:license",
      "description": "License documents that applies to this content, typically indicated by URL.\n",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "type": "string",
            "format": "uri"
          },
          {
            "$ref": "CreativeWork.schema.json"
          }
        ]
      },
      "from": "CreativeWork",
      "aliases": [
        "license"
      ]
    },
    "parts": {
      "@id": "schema:hasParts",
      "aliases": [
        "hasParts",
        "part"
      ],
      "description": "Elements of the collection which can be a variety of different elements, \nsuch as Articles, Datatables, Tables and more.\n",
      "type": "array",
      "items": {
        "$ref": "CreativeWork.schema.json"
      },
      "from": "CreativeWork"
    },
    "publisher": {
      "@id": "schema:publisher",
      "description": "A publisher of the CreativeWork.\n",
      "anyOf": [
        {
          "$ref": "Person.schema.json"
        },
        {
          "$ref": "Organization.schema.json"
        }
      ],
      "from": "CreativeWork"
    },
    "text": {
      "@id": "schema:text",
      "description": "The textual content of this creative work.",
      "type": "string",
      "from": "CreativeWork"
    },
    "title": {
      "@id": "schema:headline",
      "aliases": [
        "headline"
      ],
      "type": "string",
      "from": "CreativeWork"
    },
    "version": {
      "@id": "schema:version",
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "number"
        }
      ],
      "from": "CreativeWork"
    },
    "codeRepository": {
      "@id": "schema:codeRepository",
      "description": "Link to the repository where the un-compiled, human readable code and related code is located (SVN, github, CodePlex)\n",
      "type": "string",
      "format": "uri",
      "from": "SoftwareSourceCode"
    },
    "codeSampleType": {
      "@id": "schema:codeSampleType",
      "description": "What type of code sample: full (compile ready) solution, code snippet, inline code, scripts, template.\n",
      "type": "string",
      "from": "SoftwareSourceCode"
    },
    "maintainers": {
      "@id": "codemeta:maintainer",
      "description": "The people or organizations who maintain the software.\n",
      "type": "array",
      "items": [
        {
          "$ref": "Organization.schema.json"
        },
        {
          "$ref": "Person.schema.json"
        }
      ],
      "from": "SoftwareSourceCode",
      "aliases": [
        "maintainer"
      ]
    },
    "programmingLanguage": {
      "@id": "schema:programmingLanguage",
      "description": "The computer programming language.\n",
      "type": "string",
      "from": "SoftwareSourceCode"
    },
    "runtimePlatform": {
      "@id": "schema:runtimePlatform",
      "description": "Runtime platform or script interpreter dependencies (Example - Java v1, Python2.3, .Net Framework 3.0).\n",
      "type": "array",
      "items": [
        {
          "type": "string"
        }
      ],
      "from": "SoftwareSourceCode"
    },
    "softwareRequirements": {
      "@id": "schema:softwareRequirements",
      "description": "Component dependency requirements for application. \nThis includes runtime environments and shared libraries that \nare not included in the application distribution package, but \nrequired to run the application (Examples include DirectX, Java or .NET runtime).\n",
      "type": "array",
      "items": {
        "anyOf": [
          {
            "$ref": "SoftwareSourceCode.schema.json"
          },
          {
            "$ref": "SoftwareApplication.schema.json"
          },
          {
            "type": "string"
          }
        ]
      },
      "from": "SoftwareSourceCode",
      "aliases": [
        "softwareRequirement"
      ]
    },
    "targetProducts": {
      "@id": "schema:targetProduct",
      "description": "Target Operating System / Product to which the code applies.\nIf applies to several versions, just the product name can be used.\n",
      "type": "array",
      "items": [
        {
          "$ref": "SoftwareApplication.schema.json"
        }
      ],
      "from": "SoftwareSourceCode",
      "aliases": [
        "targetProduct"
      ]
    }
  },
  "source": "https://github.com/stencila/schema/blob/master/schema/software/SoftwareSourceCode.schema.yaml",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://stencila.github.com/schema/SoftwareSourceCode.schema.json",
  "category": "software",
  "children": [
    "CodeChunk",
    "CodeExpr"
  ],
  "descendants": [
    "CodeChunk",
    "CodeExpr"
  ],
  "type": "object",
  "aliases": true,
  "additionalProperties": false,
  "required": [
    "type"
  ],
  "parent": "CreativeWork"
}