Skip to content

Commit

Permalink
fix: updated API docs to reflect v4.3
Browse files Browse the repository at this point in the history
  • Loading branch information
ivarconr committed Dec 6, 2021
1 parent 98d64fc commit 642a237
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
4 changes: 1 addition & 3 deletions website/docs/api/admin/feature-toggles-api-v2.md
Expand Up @@ -5,16 +5,14 @@ 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.
**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:

- All feature toggles exists _inside a project_.
- A feature toggle exists _across all environments_.
- 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.
Expand Down
2 changes: 2 additions & 0 deletions website/docs/api/admin/feature-toggles-api.md
Expand Up @@ -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.
**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}

`GET: http://unleash.host.com/api/admin/features`
Expand Down
3 changes: 2 additions & 1 deletion website/sidebars.js
Expand Up @@ -76,6 +76,8 @@ module.exports = {
],
'Admin API': [
'api/admin/features',
'api/admin/projects',
'api/admin/feature-toggles-v2',
'api/admin/features-archive',
'api/admin/strategies',
'api/admin/metrics',
Expand All @@ -84,7 +86,6 @@ module.exports = {
'api/admin/feature-types',
'api/admin/addons',
'api/admin/context',
'api/admin/projects',
'api/admin/user-admin',
],
'Client SDK API': [
Expand Down

1 comment on commit 642a237

@vercel
Copy link

@vercel vercel bot commented on 642a237 Dec 6, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.