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

docs: small fixes (#2688)

Browse Source 
## What

This PR contains two small doc updates/fixes:

1. Update the availability notice on SSO syncing to indicate that it has
been released.
2. Add a note to the Import API description that importing environments
will make Unleash delete API keys belonging to those environments.

## Why

1. To keep the docs up to date.
2. Because this behavior surprised (and rightly so, I'd say) a user, who
then suddenly had all their SDKs unable to connect.

Co-authored-by: Nuno Góis <github@nunogois.com>
This commit is contained in:
Thomas Heartman 2022-12-14 15:26:41 +01:00 committed by GitHub
parent a54d53a117
commit 160b9a0604
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/docs/how-to/how-to-set-up-group-sso-sync.md
View File

@ -4,7 +4,7 @@ title: How set up user group SSO syncing
:::info availability
User group syncing is planned to be released in Unleash 4.18 and will be available for enterprise customers.
User group syncing was released in Unleash 4.18 and is available for enterprise customers.
:::

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

@ -64,6 +64,12 @@ For example if you want to download just feature-toggles as yaml:
### API Import {#api-import}
:::caution Importing environments
If you import an environment into an instance that already has that environment defined, Unleash will delete any API keys created specifically for that environment. This is to prevent unexpected access to the newly imported environments.
:::
You can import feature-toggles and strategies by POSTing to the `/api/admin/state/import` endpoint (keep in mind this will require authentication).\
You can either send the data as JSON in the POST-body or send a `file` parameter with `multipart/form-data` (YAML files are also accepted here).
@ -76,7 +82,11 @@ You can customize the import with query parameters:
If you want the database to be cleaned before import (**all strategies and features will be removed**), specify a `drop` query parameter.
> You should never use this in production environments.
:::caution
You should be cautious about using the `drop` query parameter in production environments.
:::
Example usage: