Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
Glossaries
A Glossary is the terms shared by the catalogs that name it, one per brand or product family.
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
#Fields
| Field | Type | What it is |
|---|---|---|
name | string | orgs/{org}/projects/{project}/envs/{env}/glossaries/{glossary}. |
uid | string | gls_<cell><ulid>; never reused. Output only. |
meta | ResourceMeta | Resource metadata. |
spec | GlossarySpec | Desired state. Required. |
status | GlossaryStatus | Observed 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.
| Method | Call | What it does |
|---|---|---|
GET | get | Gets a glossary. |
GET | list | Lists glossarys. |
POST | create | Creates a glossary. |
PATCH | update | Updates a glossary. |
DELETE | delete | Deletes 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 · 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 · 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 · 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 · 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 · Request, response and examples