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

docs: update payload for activation strategies

Browse Source
This commit is contained in:
Thomas Heartman 2022-04-04 14:33:38 +02:00
parent bf9f9e9d6d
commit 683e33915f
1 changed files with 18 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
website/docs/api/admin/segments.mdx
View File

@ -345,18 +345,27 @@ Some constraint operators only support single values. If a constraint uses one o
``` json
{
"id": "strategy-id",
"name": "flexibleRollout",
"id": "64fbe72b-d107-4b26-b6b8-4fead08d286c",
"constraints": [],
"parameters": {}
"environment": "default",
"featureName": "my-feature",
"parameters": {},
"projectId": "my-project",
"strategyName": "flexibleRollout",
"createdAt": "2022-05-30T20:45:24.000Z"
}
```
#### Description
| Property | Type | Required | Description | Example value |
|----------------|---------------------------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
| `id` | string | No | The ID of the strategy. | `"strategy id"` |
| `name` | string | Yes | The name of the activation strategy. | `flexibleRollout` |
| `constraints` | a list of [constraint objects](#constraint-type-description). | No | The list of constraints applied to this strategy. | `[]` |
| `parameters` | object | Yes | A list of parameters for the strategy. | `{}` |
| Property | Type | Required | Description | Example value |
|----------------|---------------------------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------|
| `id` | GUID string | No | The ID of the strategy. | `"64fbe72b-d107-4b26-b6b8-4fead08d286c"` |
| `constraints` | a list of [constraint objects](#constraint-type-description). | No | The list of constraints applied to this strategy. | `[]` |
| `environment` | string | Yes | The name of the strategy's environment. | `"development"` |
| `featureName` | string | Yes | The name of the feature the strategy is applied to. | `"my-feature"` |
| `parameters` | object | Yes | Parameters for the strategy. | `{}` |
| `projectId` | string | Yes | The name of the current project. | `"my-project"` |
| `strategyName` | string | Yes | The name of the strategy. | `"flexibleRollout"` |
| `parameters` | boolean string | No | Whether the constraint operator is case sensitive or not. Only [applies to some string-based operators](../../advanced/strategy-constraints.md#string-operators). | `false` |
| `createdAt` | timestamp string | Yes | The time when the segment was created. Format: `YYYY-MM-DDThh:mm:ss.sTZD` | `"2022-04-23T13:56:24.45+01:00"` |