docs: mark 'yes' and no as required, add more details to variants (#…

…3984) This change adds a little more detail to the client metrics schema. The description for variants felt a little unclear. --------- Co-authored-by: Christopher Kolstad <chriswk@getunleash.ai>
Unleash · Jun 15, 2023 · 2be143a · 2be143a
1 parent bb026c0
commit 2be143a
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/src/lib/openapi/spec/client-metrics-schema.ts b/src/lib/openapi/spec/client-metrics-schema.ts
@@ -81,7 +81,7 @@ export const clientMetricsSchema = {
                             },
                             variants: {
                                 description:
-                                    'How many times each variant was returned',
+                                    'An object describing how many times each variant was returned. Variant names are used as properties, and the number of times they were exposed is the corresponding value (i.e. `{ [variantName]: number }`).',
                                 type: 'object',
                                 additionalProperties: {
                                     type: 'integer',

diff --git a/src/test/e2e/api/openapi/__snapshots__/openapi.e2e.test.ts.snap b/src/test/e2e/api/openapi/__snapshots__/openapi.e2e.test.ts.snap
@@ -1540,7 +1540,7 @@ The provider you choose for your addon dictates what properties the \`parameters
                         "minimum": 0,
                         "type": "integer",
                       },
-                      "description": "How many times each variant was returned",
+                      "description": "An object describing how many times each variant was returned. Variant names are used as properties, and the number of times they were exposed is the corresponding value (i.e. \`{ [variantName]: number }\`).",
                       "example": {
                         "variantA": 15,
                         "variantB": 25,