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

docs: deprecation notice on state api (#3561)

Browse Source 
## About the changes
Update documentation about the deprecation of state API.

Related to https://github.com/Unleash/unleash/issues/1265
This commit is contained in:
Gastón Fournier 2023-04-21 09:19:22 +02:00 committed by GitHub
parent 824c3e4f4d
commit b593bdd404
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
website/docs/reference/api/legacy/unleash/admin/state.md
View File

@ -3,6 +3,12 @@ id: state
title: /api/admin/state
---
:::caution Deprecation notice
Api admin state is deprecated from version 5. We recommend using `/api/admin/features-batch` instead for [import](https://docs.getunleash.io/reference/api/unleash/import-toggles) and [export](https://docs.getunleash.io/reference/api/unleash/export-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](/how-to/how-to-create-api-tokens) and add an Authorization header using the token.
### Export Feature Toggles & Strategies {#export-feature-toggles--strategies}

8
website/docs/reference/deploy/import-export.md
View File

@ -1,5 +1,5 @@
---
title: Import & Export
title: '[Deprecated] Import & Export'
---
import ApiRequest from '@site/src/components/ApiRequest'
@ -9,6 +9,12 @@ The import and export API first appeared in Unleash 3.3.0.
:::
:::caution Deprecation notice
Api admin state is deprecated from version 5. We recommend using `/api/admin/features-batch` instead for [import](https://docs.getunleash.io/reference/api/unleash/import-toggles) and [export](https://docs.getunleash.io/reference/api/unleash/export-features).
:::
Unleash supports import and export of feature toggles and strategies at startup and during runtime. The main purpose of the import/export feature is to bootstrap new Unleash instances with feature toggles and their configuration. If you are looking for a granular way to keep seperate Unleash instances in sync we strongly recommend that you take a look at the Unleash Admin APIs.
The import mechanism guarantees that: