Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-01-25 00:07:47 +01:00
Code Issues Projects Releases Wiki Activity

fix: improve import/export documentation

Browse Source 
See #496:
https://github.com/Unleash/unleash/issues/496#issuecomment-692772884
This commit is contained in:
Ivar Conradi Østhus 2020-09-25 09:43:23 +02:00
parent 4a3c136167
commit c0785e1e34
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/import-export.md
View File

@ -9,7 +9,7 @@ Unleash supports import and export of feature-toggles and strategies at startup
All import mechanisms support a `drop` parameter which will clean the database before import (all strategies and features will be removed). All import mechanisms support a `drop` parameter which will clean the database before import (all strategies and features will be removed).
> You should never use this in production environments. > You should be careful when using `drop` parmeter in production environments, as it will clean current state.
## Runtime import & export ## Runtime import & export
@ -37,12 +37,12 @@ If you want the database to be cleaned before import (all strategies and feature
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 queryparameters: You can customize the export with queryparameters:
| Parameter | Default | Description | | Parameter | Default | Description |
| -------------- | ------- | --------------------------------------------------- | | --- | --- | --- |
| format | `json` | Export format, either `json` or `yaml` | | format | `json` | Export format, either `json` or `yaml` |
| download | `false` | If the exported data should be downloaded as a file | | download | `false` | If the exported data should be downloaded as a file |
| featureToggles | `true` | Include feature-toggles in the exported data | | featureToggles | `true` | Include feature-toggles in the exported data |
| strategies | `true` | Include strategies in the exported data | | strategies | `true` | Include strategies in the exported data |
For example if you want to download all feature-toggles as yaml: For example if you want to download all feature-toggles as yaml: