@stencila/schema/schema/software/SoftwareSourceCode.schema.yaml

Stencila schema and other specifications

title: SoftwareSourceCode
'@id': schema:SoftwareSourceCode
$extends: ../CreativeWork.schema.yaml
role: primary
status: unstable
description: |
  Computer programming source code. Example: Full (compile ready) solutions, code snippet samples, scripts, templates.
properties:
  codeRepository:
    '@id': schema:codeRepository
    description: |
      Link to the repository where the un-compiled, human readable code and related code is located (SVN, github, CodePlex)
    type: string
    format: uri
  codeSampleType:
    '@id': schema:codeSampleType
    description: |
      What type of code sample: full (compile ready) solution, code snippet, inline code, scripts, template.
    type: string
  maintainers:
    '@id': codemeta:maintainer
    description: |
      The people or organizations who maintain the software.
    type: array
    items:
      - $ref: Organization.schema.yaml
      - $ref: Person.schema.yaml
  programmingLanguage:
    '@id': schema:programmingLanguage
    description: |
      The computer programming language.
    type: string
  runtimePlatform:
    '@id': schema:runtimePlatform
    description: |
      Runtime platform or script interpreter dependencies (Example - Java v1, Python2.3, .Net Framework 3.0).
    type: array
    items:
      - type: string
  softwareRequirements:
    '@id': schema:softwareRequirements
    description: |
      Component dependency requirements for application. 
      This includes runtime environments and shared libraries that 
      are not included in the application distribution package, but 
      required to run the application (Examples include DirectX, Java or .NET runtime).
    type: array
    items:
      anyOf:
        - $ref: SoftwareSourceCode.schema.yaml
        - $ref: SoftwareApplication.schema.yaml
        - type: string
  targetProducts:
    '@id': schema:targetProduct
    description: |
      Target Operating System / Product to which the code applies.
      If applies to several versions, just the product name can be used.
    type: array
    items:
      - $ref: SoftwareApplication.schema.yaml