Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
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>
This commit is contained in:
Thomas Heartman 2023-06-15 09:14:17 +02:00 committed by GitHub
parent bb026c0ba1
commit 2be143a64e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/lib/openapi/spec/client-metrics-schema.ts
View File

@ -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',

2
src/test/e2e/api/openapi/__snapshots__/openapi.e2e.test.ts.snap
View File

@ -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,