all_ontology_schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Valid Ontology Term JSON Schema",
  "description": "Schema for file containing metadata for Ontology Terms accepted in dataset submissions to CZ CellXGene Data Portal.",
  "type": "object",
  "propertyNames": {
    "$ref": "ontology_term_id_schema.json#/definitions/supported_term_id"
  },
  "additionalProperties": {
    "type": "object",
    "properties": {
      "label": {
        "type": "string",
        "description": "human-readable name for the ontology entry."
      },
      "description": {
        "type": "string",
        "description": "Optional description of the ontology entry."
      },
      "deprecated": {
        "type": "boolean",
        "description": "Indicates whether the ontology entry is deprecated."
      },
      "ancestors": {
        "type": "object",
        "description": "A map of ancestor ontology terms that this term is a subclass of, keyed to the distance from the term.",
        "propertyNames": {
          "$ref": "ontology_term_id_schema.json#/definitions/supported_term_id"
        },
        "additionalProperties": {
          "type": "integer"
        }
      },
      "comments": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "minItems": 0,
        "description": "Optional comments regarding the ontology entry from ontology curators."
      },
      "term_tracker": {
        "type": "string",
        "format": "uri",
        "description": "Optional URL to track discussion around the term's history and changes."
      },
      "consider": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "minItems": 0,
        "description": "Suggests alternative IDs to consider in place of this ontology entry."
      },
      "replaced_by": {
        "type": "string",
        "pattern": "^\\w+:\\w+$",
        "description": "If deprecated, the ID of the ontology entry that should canonically replace this one."
      },
      "synonyms": {
          "type": "array",
          "items": {
          "type": "string"
          },
          "minItems": 0,
          "description": "Optional list of synonym labels for the ontology entry."
      }
    },
    "required": [
      "label",
      "deprecated",
      "ancestors"
    ],
    "additionalProperties": false
  }
}