Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-19 00:15:43 +01:00
Code Issues Projects Releases Wiki Activity

fix: updated API docs to reflect v4.3

Browse Source
This commit is contained in:
Ivar Conradi Østhus 2021-12-06 10:56:16 +01:00
parent 975458b449
commit 2a65e16646
No known key found for this signature in database
GPG Key ID: 31AC596886B0BD09
3 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
website/docs/api/admin/feature-toggles-api-v2.md
View File

@ -5,6 +5,7 @@ title: /api/admin/projects/:projectId
> In order to access the admin API endpoints you need to identify yourself. You'll need to [create an ADMIN token](/user_guide/api-token) and add an Authorization header using the token. > In order to access the admin API endpoints you need to identify yourself. You'll need to [create an ADMIN token](/user_guide/api-token) and add an Authorization header using the token.
**Available sense Unleash v4.3**
In this document we will guide you on how you can work with feature toggles and their configuration. Please remember the following details: In this document we will guide you on how you can work with feature toggles and their configuration. Please remember the following details:
@ -12,9 +13,6 @@ In this document we will guide you on how you can work with feature toggles and
- A feature toggle exists _across all environments_. - A feature toggle exists _across all environments_.
- A feature toggle can take different configuration, activation strategies, per environment. - A feature toggle can take different configuration, activation strategies, per environment.
TODO: Need to explain the following in a bit more details:
- The _default_ environment
> We will in this guide use [HTTPie](https://httpie.io) commands to show examples on how to interact with the API. > We will in this guide use [HTTPie](https://httpie.io) commands to show examples on how to interact with the API.

2
website/docs/api/admin/feature-toggles-api.md
View File

@ -5,6 +5,8 @@ title: /api/admin/features
> In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/user_guide/api-token) and add an Authorization header using the token. > In order to access the admin API endpoints you need to identify yourself. Unless you're using the `none` authentication method, you'll need to [create an ADMIN token](/user_guide/api-token) and add an Authorization header using the token.
**This API was deprecated as part of the v4.3 release and will be removed in v5.0. See [/api/admin/projects/:projectId](/api/admin/feature-toggles-v2) instead.**
### Fetching Feature Toggles {#fetching-feature-toggles} ### Fetching Feature Toggles {#fetching-feature-toggles}
`GET: http://unleash.host.com/api/admin/features` `GET: http://unleash.host.com/api/admin/features`

3
website/sidebars.js
View File

@ -76,6 +76,8 @@ module.exports = {
], ],
'Admin API': [ 'Admin API': [
'api/admin/features', 'api/admin/features',
'api/admin/projects',
'api/admin/feature-toggles-v2',
'api/admin/features-archive', 'api/admin/features-archive',
'api/admin/strategies', 'api/admin/strategies',
'api/admin/metrics', 'api/admin/metrics',
@ -84,7 +86,6 @@ module.exports = {
'api/admin/feature-types', 'api/admin/feature-types',
'api/admin/addons', 'api/admin/addons',
'api/admin/context', 'api/admin/context',
'api/admin/projects',
'api/admin/user-admin', 'api/admin/user-admin',
], ],
'Client SDK API': [ 'Client SDK API': [