diff --git a/changelog/overview.mdx b/changelog/overview.mdx index e513dfc..4f24a25 100644 --- a/changelog/overview.mdx +++ b/changelog/overview.mdx @@ -4,6 +4,16 @@ description: Recent updates to Flipt, including new SDKs and other improvements. mode: "wide" --- + + +## Flag Metadata + +Added support for metadata on flags in the Flipt UI. + +![Flag Metadata Example](/images/concepts/flags_metadata.png) + + + ## Prometheus Analytics Storage diff --git a/concepts.mdx b/concepts.mdx index 688747a..60d4e68 100644 --- a/concepts.mdx +++ b/concepts.mdx @@ -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. + +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. + +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. + +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 diff --git a/images/concepts/flags_metadata.png b/images/concepts/flags_metadata.png new file mode 100644 index 0000000..b4ce921 Binary files /dev/null and b/images/concepts/flags_metadata.png differ