Skip to content
Console
On this page

Glossaries

A Glossary is the terms shared by the catalogs that name it, one per brand or product family.

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

A Glossary is the terms shared by the catalogs that name it, one per brand or product family.

Service Sylphx Localization · Resource type localization.sylphx.com/Glossary · Name pattern orgs/{org}/projects/{project}/envs/{env}/glossaries/{glossary} · Shape spec_status

Not available yet. Sylphx Localization is declared in the registry but no backend serves it: every call answers 501 with the problem code UNIMPLEMENTED.

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/glossaries/{glossary}.
uidstringgls_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specGlossarySpecDesired state. Required.
statusGlossaryStatusObserved state. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a glossary.
GETlistLists glossarys.
POSTcreateCreates a glossary.
PATCHupdateUpdates a glossary.
DELETEdeleteDeletes a glossary.

get

Gets a glossary.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/glossaries/glossary · scope localization:read · effect read · not available yet · Request, response and examples

list

Lists glossarys.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/glossaries · scope localization:read · effect read · not available yet · paginated · Request, response and examples

create

Creates a glossary.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/glossaries · scope localization:write · effect write · not available yet · Request, response and examples

update

Updates a glossary.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/glossaries/glossary · scope localization:write · effect write · not available yet · Request, response and examples

delete

Deletes a glossary.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/glossaries/glossary · scope localization:write · effect destructive · not available yet · Request, response and examples