Skip to content

Commit 7d4aae5

Browse files
authored
chore: document flag metadata / ui (#299)
Signed-off-by: Mark Phelps <[email protected]>
1 parent 6b02900 commit 7d4aae5

File tree

3 files changed

+25
-0
lines changed

3 files changed

+25
-0
lines changed

changelog/overview.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ description: Recent updates to Flipt, including new SDKs and other improvements.
44
mode: "wide"
55
---
66

7+
<Update label="January 2025">
8+
9+
## Flag Metadata
10+
11+
Added support for metadata on flags in the Flipt UI.
12+
13+
![Flag Metadata Example](/images/concepts/flags_metadata.png)
14+
15+
</Update>
16+
717
<Update label="November 2024">
818

919
## Prometheus Analytics Storage

concepts.mdx

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,21 @@ Boolean flags can be configured with [rollout](#rollouts) rules to determine whi
7979

8080
![Boolean Flags Example](/images/concepts/flags_boolean.png)
8181

82+
### Metadata
83+
84+
All flags can have metadata associated with them. This metadata is stored in the Flipt backend and can be used to add additional information about a flag.
85+
86+
Metadata is stored as a JSON object and is not used for evaluation. You can retrieve flag metadata using the [Get Flag](/reference/flags/get-flag) API.
87+
88+
In the Flipt UI, metadata is displayed in the flag details section. The UI allows you to add, edit, and delete metadata and provides a more user-friendly interface for managing metadata by specifying key-value pairs and their data types.
89+
90+
Currently, the following data types are supported:
91+
92+
- Primitive types: `String`, `Number`, `Boolean`
93+
- Complex types: `Array`, `Object`
94+
95+
![Flag Metadata Example](/images/concepts/flags_metadata.png)
96+
8297
## Segments
8398

8499
Segments allow you to split your user base or audience up into predefined

images/concepts/flags_metadata.png

270 KB
Loading

0 commit comments

Comments
 (0)