Sign in

v2

OpenAPI 3.0.02026-08-051996591.2 MB
Glossaries

Update glossary

Updates the metadata of a glossary.

patch/v2/glossaries/{glossary_key}

Path parameters

glossary_keystring required

A user-provided key that uniquely identifies a glossary.

Example:eng-acronyms

The unique key of the glossary to update.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Request body

namestring

Updated name for the glossary.

descriptionstring

Updated description.

Example request

{
  "name": "Platform Acronyms"
}

Response

The updated glossary.

keystring required

A user-provided key that uniquely identifies a glossary.

namestring required

Human-readable name for the glossary.

descriptionstring

A description of what this glossary covers.

num_entriesinteger

The number of entries currently in the glossary.

created_atstring date-time

Timestamp when the glossary was created.

updated_atstring date-time

Timestamp when the glossary was last updated.

Example response

{
  "key": "eng-acronyms",
  "name": "Engineering Acronyms",
  "description": "Common engineering and infrastructure acronyms used by the platform team.",
  "num_entries": 142,
  "created_at": "2026-03-01T10:00:00Z",
  "updated_at": "2026-03-15T14:30:00Z"
}