gsadmin/unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2026-10-14 00:10:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: Fix formatting all the things

Browse Source
This commit is contained in:
ivaosthu
2018-11-22 11:20:28 +01:00
committed by Ivar Conradi Østhus
parent b24a7b06f3
commit 8a53d8dca2
31 changed files with 808 additions and 782 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api/admin/feature-toggles-api.md
+16 -20
View File
@@ -7,12 +7,10 @@ title: /api/admin/features
`GET: http://unleash.host.com/api/admin/features`
This endpoint is the one all admin ui should use to fetch all available feature toggles
from the _unleash-server_. The response returns all active feature toggles and their
current strategy configuration. A feature toggle will have _at least_ one configured strategy.
A strategy will have a `name` and `parameters` map.
This endpoint is the one all admin ui should use to fetch all available feature toggles from the _unleash-server_. The response returns all active feature toggles and their current strategy configuration. A feature toggle will have _at least_ one configured strategy. A strategy will have a `name` and `parameters` map.
**Example response:**
```json
{
"version": 2,
@@ -53,8 +51,7 @@ A strategy will have a `name` and `parameters` map.
`GET: http://unleash.host.com/api/admin/features/:featureName`
Used to fetch details about a specific featureToggle. This is mostly provded to make it easy to
debug the API and should not be used by the client implementations.
Used to fetch details about a specific featureToggle. This is mostly provded to make it easy to debug the API and should not be used by the client implementations.
```json
{
@@ -70,13 +67,13 @@ debug the API and should not be used by the client implementations.
}
```
### Create a new Feature Toggle
`POST: http://unleash.host.com/api/admin/features/`
**Body:**
```json
```json
{
"name": "Feature.A",
"description": "lorem ipsum..",
@@ -90,17 +87,17 @@ debug the API and should not be used by the client implementations.
}
```
Used by the admin-dashboard to create a new feature toggles. The name **must be unique**,
otherwise you will get a _403-response_.
Used by the admin-dashboard to create a new feature toggles. The name **must be unique**, otherwise you will get a _403-response_.
Returns 200-respose if the feature toggle was created successfully.
Returns 200-respose if the feature toggle was created successfully.
### Update a Feature Toggle
`PUT: http://unleash.host.com/api/admin/features/:toggleName`
**Body:**
```json
```json
{
"name": "Feature.A",
"description": "lorem ipsum..",
@@ -114,18 +111,15 @@ Returns 200-respose if the feature toggle was created successfully.
}
```
Used by the admin dashboard to update a feature toggles. The name has to match an
existing features toggle.
Used by the admin dashboard to update a feature toggles. The name has to match an existing features toggle.
Returns 200-respose if the feature toggle was updated successfully.
Returns 200-respose if the feature toggle was updated successfully.
### Archive a Feature Toggle
`DELETE: http://unleash.host.com/api/admin/features/:toggleName`
Used to archive a feature toggle. A feature toggle can never be totally be deleted,
but can be archived. This is a design decision to make sure that a old feature
toggle suddenly reappears becuase someone else re-using the same name.
Used to archive a feature toggle. A feature toggle can never be totally be deleted, but can be archived. This is a design decision to make sure that a old feature toggle suddenly reappears becuase someone else re-using the same name.
## Archive
@@ -136,6 +130,7 @@ toggle suddenly reappears becuase someone else re-using the same name.
Used to fetch list of archived feature toggles
**Example response:**
```json
{
"version": 1,
@@ -162,10 +157,11 @@ Used to fetch list of archived feature toggles
`POST http://unleash.host.com/api/admin/archive/revive`
**Body:**
```json
```json
{
"name": "Feature.A"
}
```
Used to revive a feature toggle.
Used to revive a feature toggle.