mirror of
https://github.com/Unleash/unleash.git
synced 2024-10-28 19:06:12 +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.
1.1 KiB
1.1 KiB
| title |
|---|
| /api/admin/archive |
In order to access the admin API endpoints you need to identify yourself. Unless you're using the
noneauthentication method, you'll need to create an ADMIN token and add an Authorization header using the token.
Fetch archived toggles
GET http://unleash.host.com/api/admin/archive/features
Used to fetch list of archived feature toggles
Example response:
{
"version": 1,
"features": [
{
"name": "Feature.A",
"description": "lorem ipsum",
"type": "release",
"stale": false,
"variants": [],
"tags": [],
"strategy": "default",
"parameters": {}
}
]
}
Revive feature toggle
POST http://unleash.host.com/api/admin/archive/revive/:featureName
Response: 200 OK - When feature toggle was successfully revived.
Delete an archived feature toggle
DELETE http://unleash.host.com/api/admin/archive/:featureName
Will fully remove the feature toggle and associated configuration. Impossible to restore after this action.