mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
d5fbd0b743
## What This (admittedly massive) PR updates the "physical" documentation structure and fixes url inconsistencies and SEO problems reported by marketing. The main points are: - remove or move directories : advanced, user_guide, deploy, api - move the files contained within to the appropriate one of topics, how-to, tutorials, or reference - update internal doc links and product links to the content - create client-side redirects for all the urls that have changed. A number of the files have been renamed in small ways to better match their url and to make them easier to find. Additionally, the top-level api directory has been moved to /reference/api/legacy/unleash (see the discussion points section for more on this). ## Why When moving our doc structure to diataxis a while back, we left the "physical' files lying where they were, because it didn't matter much to the new structure. However, that did introduce some inconsistencies with where you place docs and how we organize them. There's also the discrepancies in whether urls us underscores or hyphens (which isn't necessarily the same as their file name), which has been annoying me for a while, but now has also been raised by marketing as an issue in terms of SEO. ## Discussion points The old, hand-written API docs have been moved from /api to /reference/api/legacy/unleash. There _is_ a /reference/api/unleash directory, but this is being populated by the OpenAPI plugin, and mixing those could only cause trouble. However, I'm unsure about putting /legacy/ in the title, because the API isn't legacy, the docs are. Maybe we could use another path? Like /old-docs/ or something? I'd appreciate some input on this.
2.0 KiB
2.0 KiB
| title |
|---|
| /api/admin/context |
The context feature is only available as part of Unleash Enterprise. In order to access the API programmatically you need to make sure you obtain a API token with admin permissions.
List context fields defined in Unleash
GET https://unleash.host.com/api/admin/context
Returns a list of context fields defined in Unleash.
Example response:
[
{
"name": "appName",
"description": "Allows you to constrain on application name",
"stickiness": false,
"sortOrder": 2,
"createdAt": "2020-03-05T19:33:19.784Z"
},
{
"name": "environment",
"description": "Allows you to constrain on application environment",
"stickiness": false,
"sortOrder": 0,
"legalValues": ["qa", "dev", "prod"],
"createdAt": "2020-03-05T19:33:19.784Z"
},
{
"name": "tenantId",
"description": "Control rollout to your tenants",
"stickiness": true,
"sortOrder": 10,
"legalValues": ["company-a, company-b"],
"createdAt": "2020-03-05T19:33:19.784Z"
},
{
"name": "userId",
"description": "Allows you to constrain on userId",
"stickiness": false,
"sortOrder": 1,
"createdAt": "2020-03-05T19:33:19.784Z"
}
]
Create a new context field
POST https://unleash.host.com/api/admin/context
Creates a new context field.
Body
{
"name": "region",
"description": "Control rollout based on region",
"legalValues": ["asia", "eu", "europe"],
"stickiness": true
}
Update a context field
PUT https://unleash.host.com/api/context/:name
Updates a new context field
Body
{
"name": "region",
"description": "Control rollout based on region",
"legalValues": ["asia", "eu"],
"stickiness": true
}
Delete a context field
DELETE https://unleash.host.com/api/admin/context/:name
Deletes the context field with name=name.