From 683e33915f06fdd4b9612b8149ecb2e2f8a46132 Mon Sep 17 00:00:00 2001 From: Thomas Heartman Date: Mon, 4 Apr 2022 14:33:38 +0200 Subject: [PATCH] docs: update payload for activation strategies --- website/docs/api/admin/segments.mdx | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/website/docs/api/admin/segments.mdx b/website/docs/api/admin/segments.mdx index 613d1c0312b..24cb76853f2 100644 --- a/website/docs/api/admin/segments.mdx +++ b/website/docs/api/admin/segments.mdx @@ -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"` |