Skip to content

Commit

Permalink
chore: document flag metadata / ui
Browse files Browse the repository at this point in the history 
Signed-off-by: Mark Phelps <[email protected]>
  • Loading branch information
@markphelps
markphelps committed Jan 1, 2025
1 parent 6b02900 commit aa79c2d
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 0 deletions.
10 changes: 10 additions & 0 deletions changelog/overview.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ description: Recent updates to Flipt, including new SDKs and other improvements.
mode: "wide"
---

<Update label="January 2025">

## Flag Metadata

Added support for metadata on flags in the Flipt UI.

![Flag Metadata Example](/images/concepts/flags_metadata.png)

</Update>

<Update label="November 2024">

## Prometheus Analytics Storage
Expand Down
15 changes: 15 additions & 0 deletions concepts.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,21 @@ Boolean flags can be configured with [rollout](#rollouts) rules to determine whi

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

### Metadata

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.

Check warning on line 84 in concepts.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.

Raw Output:
{"message": "[Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.", "location": {"path": "concepts.mdx", "range": {"start": {"line": 84, "column": 88}}}, "severity": "WARNING"}

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.

Check warning on line 86 in concepts.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.

Raw Output:
{"message": "[Microsoft.Contractions] Use 'isn't' instead of 'is not'.", "location": {"path": "concepts.mdx", "range": {"start": {"line": 86, "column": 41}}}, "severity": "WARNING"}

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.

Check warning on line 88 in concepts.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.SentenceLength] Write short sentences (less than 25 words).

Raw Output:
{"message": "[Openly.SentenceLength] Write short sentences (less than 25 words).", "location": {"path": "concepts.mdx", "range": {"start": {"line": 88, "column": 69}}}, "severity": "WARNING"}

Currently, the following data types are supported:

- Primitive types: `String`, `Number`, `Boolean`
- Complex types: `Array`, `Object`

![Flag Metadata Example](/images/concepts/flags_metadata.png)

## Segments

Segments allow you to split your user base or audience up into predefined
Expand Down
Binary file added images/concepts/flags_metadata.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit aa79c2d

Please sign in to comment.