glossary

Create glossary term

Create a new glossary term with name, definition, and optional metadata

post/api/v1/glossary/

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-API-Key
    • or API key in header Authorization

Request body

definitionstring required
descriptionstring
metadataobject
namestring required
parent_term_idstring

Response

Created

created_atstring
definitionstring

Definition is what the last run wrote. On a term a person has worded themselves the read path serves UserDefinition here instead, so a caller always gets the wording the catalog stands behind.

deleted_atstring
descriptionstring
idstring
metadataobject
namestring
parent_term_idstring
tagsstring[]
updated_atstring
user_definitionstring

UserDefinition is the wording a person gave the term. Ingestion reads it and never writes it, so it survives every run.

Changes