glossary

Update glossary term

Update an existing glossary term by its ID

put/api/v1/glossary/{id}

Path parameters

idstring required

Glossary Term ID

Request body

definitionstring
descriptionstring
metadataobject
namestring
parent_term_idstring

Response

OK

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