json.schema.api.data.createGlossaryTerm.json Maven / Gradle / Ivy

Go to download
{
  "$id": "https://open-metadata.org/schema/api/data/createGlossaryTerm.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateGlossaryTermRequest",
  "description": "Create Glossary term entity request",
  "type": "object",
  "javaType": "org.openmetadata.catalog.api.data.CreateGlossaryTerm",
  "javaInterfaces": ["org.openmetadata.core.entity.interfaces.CreateEntity"],

  "properties": {
    "glossary": {
      "description": "Reference to the glossary that this term is part of.",
      "$ref": "../../type/entityReference.json"
    },
    "parent": {
      "description": "Reference to the parent glossary term. When null, the term is at the root of the glossary.",
      "$ref": "../../type/entityReference.json"
    },
    "name": {
      "description": "Preferred name for the glossary term.",
      "$ref": "../../entity/data/glossaryTerm.json#/definitions/name"
    },
    "displayName": {
      "description": "Display Name that identifies this glossary term.",
      "type": "string"
    },
    "description": {
      "description": "Description of the glossary term.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "synonyms": {
      "description": "Alternate names that are synonyms or near-synonyms for the glossary term.",
      "type": "array",
      "items": {
        "$ref": "../../entity/data/glossaryTerm.json#/definitions/name"
      }
    },
    "relatedTerms": {
      "description": "Other glossary terms that are related to this glossary term.",
      "$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
    },
    "references": {
      "description": "Link to a reference from an external glossary.",
      "type": "array",
      "items": {
        "$ref": "../../entity/data/glossaryTerm.json#/definitions/termReference"
      }
    },
    "reviewers": {
      "description": "User names of the reviewers for this glossary.",
      "$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
    },
    "tags": {
      "description": "Tags for this glossary term.",
      "type": "array",
      "items": {
        "$ref": "../../type/tagLabel.json"
      },
      "default": null
    }
  },
  "required": ["glossary", "name", "description"],
  "additionalProperties": false
}