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

docs: segment names don't need to be url-friendly.

Browse Source
This commit is contained in:
Thomas Heartman 2022-04-04 11:44:37 +02:00
parent 020e94e358
commit e4c2e8807d
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -73,11 +73,11 @@ A segment with the provided name already exists.
Use a JSON object with the following properties to create a new segment. Use a JSON object with the following properties to create a new segment.
| Property | Type | Required | Description | Example value | | Property | Type | Required | Description | Example value |
|---------------|--------------------------------------------|----------|------------------------------------------------|--------------------------------------------------| |---------------|--------------------------------------------|----------|----------------------------------|--------------------------------------------------|
| `name` | string | Yes | The name of the segment. Must be URL friendly. | `"mobile-users"` | | `name` | string | Yes | The name of the segment. | `"mobile-users"` |
| `description` | string | No | A description of the segment. | `"This segment is for users on mobile devices."` | | `description` | string | No | A description of the segment. | `"This segment is for users on mobile devices."` |
| `constraints` | list of [constraint objects](#iconstraint) | Yes | The constraints in this segment. | `[]` | | `constraints` | list of [constraint objects](#iconstraint) | Yes | The constraints in this segment. | `[]` |
## Get segment by ID ## Get segment by ID