1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-14 00:19:16 +01:00

Updated strategy-api documentation

This commit is contained in:
ivaosthu 2016-12-17 13:03:31 +01:00
parent 63037b35c3
commit d301d75817

View File

@ -76,4 +76,35 @@ Used to fetch all defined strategies and their defined paramters.
},
```
Used to create a new Strategy. Name is required and must be unique. It is also required to have a parameters array, but it can be empty.
Used to create a new Strategy. Name is required and must be unique. It is also required to have a parameters array, but it can be empty.
### Update strategy
`PUT: http://unleash.host.com/api/strategies/:name`
**Body**
```json
{
"name": "gradualRollout",
"description": "Gradual rollout to logged in users with updated desc",
"parameters": [
{
"name": "percentage",
"type": "percentage",
"description": "How many percent should the new feature be active for.",
"required": false
},
{
"name": "group",
"type": "string",
"description": "Group key to use when hasing the userId. Makes sure that the same user get different value for different groups",
"required": false
}
]
},
```
Used to update a Strategy definition. Name can't be changed.
**PS! I can be dangerous to change a implemnted strategy as the implementation also might need to be changed**