Update ff version to be clear a hash is not a specific recommendation

open-telemetry · Oct 14, 2024 · 1b2d939 · 1b2d939
1 parent 5353b33
commit 1b2d939
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 11 deletions.
diff --git a/docs/attributes-registry/feature-flag.md b/docs/attributes-registry/feature-flag.md
@@ -13,15 +13,15 @@
 
 This document defines attributes for Feature Flags.
 
-| Attribute                     | Type   | Description                                                                                                             | Examples                               | Stability                                                        |
-| ----------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ---------------------------------------------------------------- |
-| `feature_flag.context.id`     | string | The unique identifier for the flag evaluation context. For example, the targeting key.                                  | `5157782b-2203-4c80-a857-dbbd5e7761db` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `feature_flag.environment.id` | string | The identifier of the environment which the feature flag belongs to in a flag management system.                        | `proj-1`; `ab98sgs`                    | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `feature_flag.key`            | string | The unique identifier of the feature flag.                                                                              | `logo-color`                           | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `feature_flag.provider.id`    | string | The name of the service provider that performs the flag evaluation.                                                     | `Flag Manager`                         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `feature_flag.value`          | string | The evaluated value of the feature flag.                                                                                | `#ff0000`; `1`; `true`                 | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `feature_flag.variant`        | string | SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used. [1] | `red`; `true`; `on`                    | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `feature_flag.version`        | string | The version of the ruleset used during the evaluation. Could use a hash if a version is not available.                  | `1`; `01ABCDEF`                        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| Attribute                     | Type   | Description                                                                                                                | Examples                               | Stability                                                        |
+| ----------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------- | ---------------------------------------------------------------- |
+| `feature_flag.context.id`     | string | The unique identifier for the flag evaluation context. For example, the targeting key.                                     | `5157782b-2203-4c80-a857-dbbd5e7761db` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `feature_flag.environment.id` | string | The identifier of the environment which the feature flag belongs to in a flag management system.                           | `proj-1`; `ab98sgs`                    | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `feature_flag.key`            | string | The unique identifier of the feature flag.                                                                                 | `logo-color`                           | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `feature_flag.provider.id`    | string | The name of the service provider that performs the flag evaluation.                                                        | `Flag Manager`                         | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `feature_flag.value`          | string | The evaluated value of the feature flag.                                                                                   | `#ff0000`; `1`; `true`                 | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `feature_flag.variant`        | string | SHOULD be a semantic identifier for a value. If one is unavailable, a stringified version of the value can be used. [1]    | `red`; `true`; `on`                    | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `feature_flag.version`        | string | The version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset. | `1`; `01ABCDEF`                        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 **[1]:** A semantic identifier, commonly referred to as a variant, provides a means
 for referring to a value without including the value itself. This can

diff --git a/docs/feature-flags/feature-flags-logs.md b/docs/feature-flags/feature-flags-logs.md
@@ -53,7 +53,7 @@ The event name MUST be `feature_flag.evaluation`.
 | [`feature_flag.context.id`](/docs/attributes-registry/feature-flag.md) | string | The unique identifier for the flag evaluation context. For example, the targeting key. | `5157782b-2203-4c80-a857-dbbd5e7761db` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | [`feature_flag.environment.id`](/docs/attributes-registry/feature-flag.md) | string | The identifier of the environment which the feature flag belongs to in a flag management system. | `proj-1`; `ab98sgs` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | [`feature_flag.provider.id`](/docs/attributes-registry/feature-flag.md) | string | The name of the service provider that performs the flag evaluation. | `Flag Manager` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| [`feature_flag.version`](/docs/attributes-registry/feature-flag.md) | string | The version of the ruleset used during the evaluation. Could use a hash if a version is not available. | `1`; `01ABCDEF` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| [`feature_flag.version`](/docs/attributes-registry/feature-flag.md) | string | The version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset. | `1`; `01ABCDEF` | `Recommended` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | [`feature_flag.value`](/docs/attributes-registry/feature-flag.md) | string | The evaluated value of the feature flag. | `#ff0000`; `1`; `true` | `Opt-In` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 **[1]:** A semantic identifier, commonly referred to as a variant, provides a means

diff --git a/model/feature-flag/registry.yaml b/model/feature-flag/registry.yaml
@@ -48,7 +48,7 @@ groups:
         stability: experimental
         examples: ["1", "01ABCDEF"]
         brief: >
-          The version of the ruleset used during the evaluation. Could use a hash if a version is not available.
+          The version of the ruleset used during the evaluation. This may be any stable value which uniquely identifies the ruleset.
       - id: feature_flag.environment.id
         type: string
         stability: experimental