Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2025-10-27 11:02:16 +01:00
Code Issues Projects Releases Wiki Activity

docs: update segments availability notices (#1729)

Browse Source 
* docs: change segment availability notice

* docs: update availability note + add some prettier changes

* docs: format imports with prettier
This commit is contained in:
Thomas Heartman 2022-06-22 10:53:24 +02:00 committed by GitHub
parent 18c720f4e9
commit b3320bf74b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,16 +1,19 @@
--- ---
title: /api/admin/segments title: /api/admin/segments
--- ---
import ApiRequest from '@site/src/components/ApiRequest'
export const basePath = "api/admin/segments" import ApiRequest from '@site/src/components/ApiRequest'; export const basePath = "api/admin/segments"; export const path = (p) => `${basePath}/${p}`;
export const path = (p) => `${basePath}/${p}`
:::info Availability :::info Availability
Segments are an **experimental feature** available to some Unleash Pro and Unleash Enterprise users. [Get in touch](https://slack.unleash.run) if you'd like to help us develop this feature.
Segments are available to Unleash Pro and Unleash Enterprise users since **Unleash 4.13**.
::: :::
:::note :::note
To use the admin API, you'll need to [create and use an admin API token](../../user_guide/token.md). To use the admin API, you'll need to [create and use an admin API token](../../user_guide/token.md).
::: :::
The segments API lets you create, read, update, and delete [segments](../../reference/segments.mdx). The segments API lets you create, read, update, and delete [segments](../../reference/segments.mdx).
@ -326,7 +329,9 @@ This section describes the data objects returned by the endpoints in the segment
#### Description #### Description
:::note `values` and `value` :::note `values` and `value`
Some constraint operators only support single values. If a constraint uses one of these operators, the payload will contain a `value` property with the correct value. However, for backwards compatibility reasons, the payload will *also* contain a `values` property. If the operator accepts multiple values, the `value` property will not be present. Visit the [strategy constraints documentation](../../advanced/strategy-constraints.md) for more information on what operators support what number of values. Some constraint operators only support single values. If a constraint uses one of these operators, the payload will contain a `value` property with the correct value. However, for backwards compatibility reasons, the payload will *also* contain a `values` property. If the operator accepts multiple values, the `value` property will not be present. Visit the [strategy constraints documentation](../../advanced/strategy-constraints.md) for more information on what operators support what number of values.
::: :::
| Property | Type | Required | Description | Example value | | Property | Type | Required | Description | Example value |

4
website/docs/reference/segments.mdx
View File

@ -3,7 +3,9 @@ title: Segments
--- ---
:::info Availability :::info Availability
Segments are an **experimental feature** available to some Unleash Pro and Unleash Enterprise users. [Get in touch](https://slack.unleash.run) if you'd like to help us develop this feature.
Segments are available to Unleash Pro and Unleash Enterprise users since **Unleash 4.13**.
::: :::
A **segment** is a reusable collection of [strategy constraints](../advanced/strategy-constraints.md). A **segment** is a reusable collection of [strategy constraints](../advanced/strategy-constraints.md).