OpenMetadata/docs/openmetadata-apis/schemas/entities/glossary.md

Glossary

This schema defines the Glossary entity. A Glossary is collection of hierarchical GlossaryTerms.

$id:https//:open-metadata.org/schema/entity/data/glossary.json

Type: object

This schema does not accept additional properties.

Properties

• id required
  • Unique identifier of a glossary instance.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • Preferred name for the glossary term.
  • $ref: #/definitions/name
  • Type: string
• displayName
  • Display Name that identifies this glossary.
  • Type: string
• description
  • Description of the glossary.
  • Type: string
• version
  • Metadata version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
  • $ref: ../../type/basic.json#/definitions/timestamp
• updatedBy
  • User who made the update.
  • Type: string
• href
  • Link to the resource corresponding to this entity.
  • $ref: ../../type/basic.json#/definitions/href
• reviewers
  • User references of the reviewers for this glossary.
  • Type: array
    • Items
    • $ref: ../../type/entityReference.json
• owner
  • Owner of this glossary.
  • $ref: ../../type/entityReference.json
• usageCount
  • Count of how many times terms from this glossary are used.
  • Type: integer
• tags
  • Tags for this glossary.
  • Type: array
    • Items
    • $ref: ../../type/tagLabel.json
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/changeDescription
• deleted
  • When true indicates the entity has been soft deleted.
  • Type: boolean
  • Default: false

Type definitions in this schema

name

• Name that identifies a glossary term.
• Type: string
• Length: between 1 and 128

This document was updated on: Wednesday, March 9, 2022