Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity

chore(docs): additional removal notices of state api/service (#7197)

Browse Source
This commit is contained in:
David Leek 2024-05-29 08:37:40 +02:00 committed by GitHub
parent b592255ce7
commit 4a41e624a6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
website/docs/how-to/how-to-import-export.md
View File

@ -9,9 +9,9 @@ The import and export API first appeared in Unleash 3.3.0.
::: :::
:::caution Deprecation notice :::caution Removal notice
Api admin state is deprecated from version 5. We recommend using the new [Environment Import & Export](https://docs.getunleash.io/reference/deploy/environment-import-export). Api admin state is deprecated from version 5 and removed from version 6. We recommend using the new [Environment Import & Export](https://docs.getunleash.io/reference/deploy/environment-import-export).
::: :::
@ -33,7 +33,7 @@ Be careful when using the `drop` parameter in production environments: cleaning
:::caution Removal notice :::caution Removal notice
State Service has been removed as of Unleash 6.0 State Service has been removed as of Unleash 6
::: :::
@ -58,6 +58,12 @@ It is also possible to not override existing feature flags (and strategies) by u
### API Export {#api-export} ### API Export {#api-export}
:::caution Removal notice
State API has been removed as of Unleash 6
:::
The api endpoint `/api/admin/state/export` will export feature-toggles and strategies as json by default. The api endpoint `/api/admin/state/export` will export feature-toggles and strategies as json by default.
You can customize the export with query parameters: You can customize the export with query parameters:
@ -76,6 +82,12 @@ For example if you want to download just feature-toggles as yaml:
### API Import {#api-import} ### API Import {#api-import}
:::caution Removal notice
State API has been removed as of Unleash 6
:::
:::caution Importing environments in Unleash 4.19 and below :::caution Importing environments in Unleash 4.19 and below
This is only relevant if you use **Unleash 4.19 or earlier**: This is only relevant if you use **Unleash 4.19 or earlier**:
@ -108,6 +120,12 @@ Example usage:
## Startup import {#startup-import} ## Startup import {#startup-import}
:::caution Removal notice
State service startup import has been removed as of Unleash 6
:::
You can import flags and strategies on startup by using an import file in JSON or YAML format. As with other forms of imports, you can also choose to remove the current flag and strategy configuration in the database before importing. You can import flags and strategies on startup by using an import file in JSON or YAML format. As with other forms of imports, you can also choose to remove the current flag and strategy configuration in the database before importing.
Unleash lets you do this both via configuration parameters and environment variables. The relevant parameters/variables are: Unleash lets you do this both via configuration parameters and environment variables. The relevant parameters/variables are:

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

@ -3,9 +3,9 @@ id: state
title: /api/admin/state title: /api/admin/state
--- ---
:::caution Deprecation notice :::caution Removal notice
Api admin state is deprecated from version 5. We recommend using the new [Environment Import & Export](https://docs.getunleash.io/reference/deploy/environment-import-export). Api admin state is deprecated from version 5 and removed in version 6. We recommend using the new [Environment Import & Export](https://docs.getunleash.io/reference/deploy/environment-import-export).
::: :::