Schemas Overview

All schemas that are included in the Typeregistry share a common set of metadata that are used to describe the types. For an easier overview, this set of metadata is described here once and omitted from the individual definitions.

General Schema

  • name

    • please use printable ascii characters without blank
    • Type: string
    • path: #/properties/name
    • The value must match this pattern: ^([!-~])+$
    • Length: ≤ 256

  • description

    • Type: string
    • path: #/properties/description
    • The value must match this pattern: (.|)*
    • Length: ≤ 8192

  • versioning

    • Type: object
    • path: #/properties/versioning
    • Properties
      • version
        • Type: string
        • path: #/properties/versioning/properties/version
      • previousVersion
        • path: #/properties/versioning/properties/previousVersion
      • nextVersion
        • path: #/properties/versioning/properties/nextVersion

  • provenance

    • Type: object
    • path: #/properties/provenance
    • Properties
      • contributors
        • Type: array
        • path: #/properties/provenance/properties/contributors
          • Items
          • Type: object
          • path: #/properties/provenance/properties/contributors/items
          • Properties
            • Name
              • Full name of the contributor
              • Type: string
              • path: #/properties/provenance/properties/contributors/items/properties/Name
            • ORCID
              • Type: string
              • path: #/properties/provenance/properties/contributors/items/properties/ORCID
      • creationDate
        • Type: string
        • path: #/properties/provenance/properties/creationDate
        • String format must be a "datetime"
      • lastModificationDate
        • Type: string
        • path: #/properties/provenance/properties/lastModificationDate
        • String format must be a "datetime"

  • ExpectedUse

    • Type: string
    • path: #/properties/ExpectedUse
    • String format must be a "textarea"
    • Length: ≤ 1024

  • Aliases

    • Provide a list of aliases as alternatives to the chosen name.
    • Type: array
    • path: #/properties/Aliases
      • Items
      • Type: string
      • path: #/properties/Aliases/items