unleash-server 5.1.8 → 5.2.0

package/dist/lib/openapi/spec/push-variants-schema.d.ts

@@ -22,23 +22,34 @@ export declare const pushVariantsSchema: {
                 readonly $id: "#/components/schemas/variantSchema";
                 readonly type: "object";
                 readonly additionalProperties: false;
+                readonly description: "A variant allows for further separation of users into segments. See [our excellent documentation](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) for a more detailed description";
                 readonly required: readonly ["name", "weight"];
                 readonly properties: {
                     readonly name: {
                         readonly type: "string";
+                        readonly description: "The variants name. Is unique for this feature toggle";
+                        readonly example: "blue_group";
                     };
                     readonly weight: {
                         readonly type: "number";
+                        readonly description: "The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
+                        readonly minimum: 0;
+                        readonly maximum: 1000;
                     };
                     readonly weightType: {
+                        readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
                         readonly type: "string";
+                        readonly example: "fix";
                     };
                     readonly stickiness: {
                         readonly type: "string";
+                        readonly description: "[Stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) is how Unleash guarantees that the same user gets the same variant every time";
+                        readonly example: "custom.context.field";
                     };
                     readonly payload: {
                         readonly type: "object";
                         readonly required: readonly ["type", "value"];
+                        readonly description: "Extra data configured for this variant";
                         readonly properties: {
                             readonly type: {
                                 readonly type: "string";
@@ -47,8 +58,13 @@ export declare const pushVariantsSchema: {
                                 readonly type: "string";
                             };
                         };
+                        readonly example: {
+                            readonly type: "json";
+                            readonly value: "{color: red}";
+                        };
                     };
                     readonly overrides: {
+                        readonly description: "Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.";
                         readonly type: "array";
                         readonly items: {
                             readonly $ref: "#/components/schemas/overrideSchema";
@@ -62,15 +78,20 @@ export declare const pushVariantsSchema: {
                             readonly type: "object";
                             readonly additionalProperties: false;
                             readonly required: readonly ["contextName", "values"];
+                            readonly description: "An override for deciding which variant should be assigned to a user based on the context name";
                             readonly properties: {
                                 readonly contextName: {
+                                    readonly description: "The name of the context field used to determine overrides";
                                     readonly type: "string";
+                                    readonly example: "userId";
                                 };
                                 readonly values: {
+                                    readonly description: "Which values that should be overriden";
                                     readonly type: "array";
                                     readonly items: {
                                         readonly type: "string";
                                     };
+                                    readonly example: readonly ["red", "blue"];
                                 };
                             };
                             readonly components: {};
@@ -83,15 +104,20 @@ export declare const pushVariantsSchema: {
                 readonly type: "object";
                 readonly additionalProperties: false;
                 readonly required: readonly ["contextName", "values"];
+                readonly description: "An override for deciding which variant should be assigned to a user based on the context name";
                 readonly properties: {
                     readonly contextName: {
+                        readonly description: "The name of the context field used to determine overrides";
                         readonly type: "string";
+                        readonly example: "userId";
                     };
                     readonly values: {
+                        readonly description: "Which values that should be overriden";
                         readonly type: "array";
                         readonly items: {
                             readonly type: "string";
                         };
+                        readonly example: readonly ["red", "blue"];
                     };
                 };
                 readonly components: {};

package/dist/lib/openapi/spec/sdk-context-schema.d.ts

@@ -10,15 +10,18 @@ export declare const sdkContextSchema: {
             readonly type: "string";
             readonly minLength: 1;
             readonly example: "My cool application.";
+            readonly description: "The name of the application.";
         };
         readonly currentTime: {
             readonly type: "string";
             readonly format: "date-time";
             readonly example: "2022-07-05T12:56:41+02:00";
+            readonly description: "A DateTime (or similar) data class instance or a string in an RFC3339-compatible format. Defaults to the current time if not set by the user.";
         };
         readonly environment: {
             readonly type: "string";
             readonly deprecated: true;
+            readonly description: "The environment the app is running in.";
         };
         readonly properties: {
             readonly type: "object";
@@ -33,14 +36,17 @@ export declare const sdkContextSchema: {
         readonly remoteAddress: {
             readonly type: "string";
             readonly example: "192.168.1.1";
+            readonly description: "The app's IP address";
         };
         readonly sessionId: {
             readonly type: "string";
             readonly example: "b65e7b23-fec0-4814-a129-0e9861ef18fc";
+            readonly description: "An identifier for the current session";
         };
         readonly userId: {
             readonly type: "string";
             readonly example: "username@provider.com";
+            readonly description: "An identifier for the current user";
         };
     };
     readonly components: {};

package/dist/lib/openapi/spec/sdk-context-schema.js

@@ -12,13 +12,19 @@ exports.sdkContextSchema = {
             type: 'string',
             minLength: 1,
             example: 'My cool application.',
+            description: 'The name of the application.',
         },
         currentTime: {
             type: 'string',
             format: 'date-time',
             example: '2022-07-05T12:56:41+02:00',
+            description: 'A DateTime (or similar) data class instance or a string in an RFC3339-compatible format. Defaults to the current time if not set by the user.',
+        },
+        environment: {
+            type: 'string',
+            deprecated: true,
+            description: 'The environment the app is running in.',
         },
-        environment: { type: 'string', deprecated: true },
         properties: {
             type: 'object',
             additionalProperties: { type: 'string' },
@@ -30,12 +36,18 @@ exports.sdkContextSchema = {
         remoteAddress: {
             type: 'string',
             example: '192.168.1.1',
+            description: "The app's IP address",
         },
         sessionId: {
             type: 'string',
             example: 'b65e7b23-fec0-4814-a129-0e9861ef18fc',
+            description: 'An identifier for the current session',
+        },
+        userId: {
+            type: 'string',
+            example: 'username@provider.com',
+            description: 'An identifier for the current user',
         },
-        userId: { type: 'string', example: 'username@provider.com' },
     },
     components: {},
 };

package/dist/lib/openapi/spec/sdk-context-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"sdk-context-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/sdk-context-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,gBAAgB,GAAG;IAC5B,GAAG,EAAE,uCAAuC;IAC5C,WAAW,EAAE,+CAA+C;IAC5D,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,QAAQ,EAAE,CAAC,SAAS,CAAC;IACrB,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,sBAAsB;SAClC;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,OAAO,EAAE,2BAA2B;SACvC;QACD,WAAW,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,EAAE,IAAI,EAAE;QACjD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACxC,OAAO,EAAE;gBACL,kBAAkB,EAAE,cAAc;gBAClC,gBAAgB,EAAE,GAAG;aACxB;SACJ;QACD,aAAa,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;SACzB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,sCAAsC;SAClD;QACD,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,uBAAuB,EAAE;KAC/D;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"sdk-context-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/sdk-context-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,gBAAgB,GAAG;IAC5B,GAAG,EAAE,uCAAuC;IAC5C,WAAW,EAAE,+CAA+C;IAC5D,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,QAAQ,EAAE,CAAC,SAAS,CAAC;IACrB,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,CAAC;YACZ,OAAO,EAAE,sBAAsB;YAC/B,WAAW,EAAE,8BAA8B;SAC9C;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,OAAO,EAAE,2BAA2B;YACpC,WAAW,EACP,+IAA+I;SACtJ;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,wCAAwC;SACxD;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;YACxC,OAAO,EAAE;gBACL,kBAAkB,EAAE,cAAc;gBAClC,gBAAgB,EAAE,GAAG;aACxB;SACJ;QACD,aAAa,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,sBAAsB;SACtC;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,sCAAsC;YAC/C,WAAW,EAAE,uCAAuC;SACvD;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,uBAAuB;YAChC,WAAW,EAAE,oCAAoC;SACpD;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

package/dist/lib/openapi/spec/state-schema.d.ts

@@ -334,7 +334,7 @@ export declare const stateSchema: {
                                     };
                                     readonly featureStrategySchema: {
                                         readonly $id: "#/components/schemas/featureStrategySchema";
-                                        readonly description: "A singles activation strategy configuration schema for a feature";
+                                        readonly description: "A single activation strategy configuration schema for a feature";
                                         readonly type: "object";
                                         readonly additionalProperties: false;
                                         readonly required: readonly ["name"];
@@ -451,23 +451,34 @@ export declare const stateSchema: {
                                         readonly $id: "#/components/schemas/variantSchema";
                                         readonly type: "object";
                                         readonly additionalProperties: false;
+                                        readonly description: "A variant allows for further separation of users into segments. See [our excellent documentation](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) for a more detailed description";
                                         readonly required: readonly ["name", "weight"];
                                         readonly properties: {
                                             readonly name: {
                                                 readonly type: "string";
+                                                readonly description: "The variants name. Is unique for this feature toggle";
+                                                readonly example: "blue_group";
                                             };
                                             readonly weight: {
                                                 readonly type: "number";
+                                                readonly description: "The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
+                                                readonly minimum: 0;
+                                                readonly maximum: 1000;
                                             };
                                             readonly weightType: {
+                                                readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
                                                 readonly type: "string";
+                                                readonly example: "fix";
                                             };
                                             readonly stickiness: {
                                                 readonly type: "string";
+                                                readonly description: "[Stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) is how Unleash guarantees that the same user gets the same variant every time";
+                                                readonly example: "custom.context.field";
                                             };
                                             readonly payload: {
                                                 readonly type: "object";
                                                 readonly required: readonly ["type", "value"];
+                                                readonly description: "Extra data configured for this variant";
                                                 readonly properties: {
                                                     readonly type: {
                                                         readonly type: "string";
@@ -476,8 +487,13 @@ export declare const stateSchema: {
                                                         readonly type: "string";
                                                     };
                                                 };
+                                                readonly example: {
+                                                    readonly type: "json";
+                                                    readonly value: "{color: red}";
+                                                };
                                             };
                                             readonly overrides: {
+                                                readonly description: "Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.";
                                                 readonly type: "array";
                                                 readonly items: {
                                                     readonly $ref: "#/components/schemas/overrideSchema";
@@ -491,15 +507,20 @@ export declare const stateSchema: {
                                                     readonly type: "object";
                                                     readonly additionalProperties: false;
                                                     readonly required: readonly ["contextName", "values"];
+                                                    readonly description: "An override for deciding which variant should be assigned to a user based on the context name";
                                                     readonly properties: {
                                                         readonly contextName: {
+                                                            readonly description: "The name of the context field used to determine overrides";
                                                             readonly type: "string";
+                                                            readonly example: "userId";
                                                         };
                                                         readonly values: {
+                                                            readonly description: "Which values that should be overriden";
                                                             readonly type: "array";
                                                             readonly items: {
                                                                 readonly type: "string";
                                                             };
+                                                            readonly example: readonly ["red", "blue"];
                                                         };
                                                     };
                                                     readonly components: {};
@@ -512,7 +533,7 @@ export declare const stateSchema: {
                         };
                         readonly featureStrategySchema: {
                             readonly $id: "#/components/schemas/featureStrategySchema";
-                            readonly description: "A singles activation strategy configuration schema for a feature";
+                            readonly description: "A single activation strategy configuration schema for a feature";
                             readonly type: "object";
                             readonly additionalProperties: false;
                             readonly required: readonly ["name"];
@@ -630,15 +651,20 @@ export declare const stateSchema: {
                             readonly type: "object";
                             readonly additionalProperties: false;
                             readonly required: readonly ["contextName", "values"];
+                            readonly description: "An override for deciding which variant should be assigned to a user based on the context name";
                             readonly properties: {
                                 readonly contextName: {
+                                    readonly description: "The name of the context field used to determine overrides";
                                     readonly type: "string";
+                                    readonly example: "userId";
                                 };
                                 readonly values: {
+                                    readonly description: "Which values that should be overriden";
                                     readonly type: "array";
                                     readonly items: {
                                         readonly type: "string";
                                     };
+                                    readonly example: readonly ["red", "blue"];
                                 };
                             };
                             readonly components: {};
@@ -655,23 +681,34 @@ export declare const stateSchema: {
                             readonly $id: "#/components/schemas/variantSchema";
                             readonly type: "object";
                             readonly additionalProperties: false;
+                            readonly description: "A variant allows for further separation of users into segments. See [our excellent documentation](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) for a more detailed description";
                             readonly required: readonly ["name", "weight"];
                             readonly properties: {
                                 readonly name: {
                                     readonly type: "string";
+                                    readonly description: "The variants name. Is unique for this feature toggle";
+                                    readonly example: "blue_group";
                                 };
                                 readonly weight: {
                                     readonly type: "number";
+                                    readonly description: "The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
+                                    readonly minimum: 0;
+                                    readonly maximum: 1000;
                                 };
                                 readonly weightType: {
+                                    readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
                                     readonly type: "string";
+                                    readonly example: "fix";
                                 };
                                 readonly stickiness: {
                                     readonly type: "string";
+                                    readonly description: "[Stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) is how Unleash guarantees that the same user gets the same variant every time";
+                                    readonly example: "custom.context.field";
                                 };
                                 readonly payload: {
                                     readonly type: "object";
                                     readonly required: readonly ["type", "value"];
+                                    readonly description: "Extra data configured for this variant";
                                     readonly properties: {
                                         readonly type: {
                                             readonly type: "string";
@@ -680,8 +717,13 @@ export declare const stateSchema: {
                                             readonly type: "string";
                                         };
                                     };
+                                    readonly example: {
+                                        readonly type: "json";
+                                        readonly value: "{color: red}";
+                                    };
                                 };
                                 readonly overrides: {
+                                    readonly description: "Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.";
                                     readonly type: "array";
                                     readonly items: {
                                         readonly $ref: "#/components/schemas/overrideSchema";
@@ -695,15 +737,20 @@ export declare const stateSchema: {
                                         readonly type: "object";
                                         readonly additionalProperties: false;
                                         readonly required: readonly ["contextName", "values"];
+                                        readonly description: "An override for deciding which variant should be assigned to a user based on the context name";
                                         readonly properties: {
                                             readonly contextName: {
+                                                readonly description: "The name of the context field used to determine overrides";
                                                 readonly type: "string";
+                                                readonly example: "userId";
                                             };
                                             readonly values: {
+                                                readonly description: "Which values that should be overriden";
                                                 readonly type: "array";
                                                 readonly items: {
                                                     readonly type: "string";
                                                 };
+                                                readonly example: readonly ["red", "blue"];
                                             };
                                         };
                                         readonly components: {};
@@ -886,7 +933,7 @@ export declare const stateSchema: {
             };
             readonly featureStrategySchema: {
                 readonly $id: "#/components/schemas/featureStrategySchema";
-                readonly description: "A singles activation strategy configuration schema for a feature";
+                readonly description: "A single activation strategy configuration schema for a feature";
                 readonly type: "object";
                 readonly additionalProperties: false;
                 readonly required: readonly ["name"];
@@ -1107,7 +1154,7 @@ export declare const stateSchema: {
                         };
                         readonly featureStrategySchema: {
                             readonly $id: "#/components/schemas/featureStrategySchema";
-                            readonly description: "A singles activation strategy configuration schema for a feature";
+                            readonly description: "A single activation strategy configuration schema for a feature";
                             readonly type: "object";
                             readonly additionalProperties: false;
                             readonly required: readonly ["name"];
@@ -1224,23 +1271,34 @@ export declare const stateSchema: {
                             readonly $id: "#/components/schemas/variantSchema";
                             readonly type: "object";
                             readonly additionalProperties: false;
+                            readonly description: "A variant allows for further separation of users into segments. See [our excellent documentation](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) for a more detailed description";
                             readonly required: readonly ["name", "weight"];
                             readonly properties: {
                                 readonly name: {
                                     readonly type: "string";
+                                    readonly description: "The variants name. Is unique for this feature toggle";
+                                    readonly example: "blue_group";
                                 };
                                 readonly weight: {
                                     readonly type: "number";
+                                    readonly description: "The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
+                                    readonly minimum: 0;
+                                    readonly maximum: 1000;
                                 };
                                 readonly weightType: {
+                                    readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
                                     readonly type: "string";
+                                    readonly example: "fix";
                                 };
                                 readonly stickiness: {
                                     readonly type: "string";
+                                    readonly description: "[Stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) is how Unleash guarantees that the same user gets the same variant every time";
+                                    readonly example: "custom.context.field";
                                 };
                                 readonly payload: {
                                     readonly type: "object";
                                     readonly required: readonly ["type", "value"];
+                                    readonly description: "Extra data configured for this variant";
                                     readonly properties: {
                                         readonly type: {
                                             readonly type: "string";
@@ -1249,8 +1307,13 @@ export declare const stateSchema: {
                                             readonly type: "string";
                                         };
                                     };
+                                    readonly example: {
+                                        readonly type: "json";
+                                        readonly value: "{color: red}";
+                                    };
                                 };
                                 readonly overrides: {
+                                    readonly description: "Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.";
                                     readonly type: "array";
                                     readonly items: {
                                         readonly $ref: "#/components/schemas/overrideSchema";
@@ -1264,15 +1327,20 @@ export declare const stateSchema: {
                                         readonly type: "object";
                                         readonly additionalProperties: false;
                                         readonly required: readonly ["contextName", "values"];
+                                        readonly description: "An override for deciding which variant should be assigned to a user based on the context name";
                                         readonly properties: {
                                             readonly contextName: {
+                                                readonly description: "The name of the context field used to determine overrides";
                                                 readonly type: "string";
+                                                readonly example: "userId";
                                             };
                                             readonly values: {
+                                                readonly description: "Which values that should be overriden";
                                                 readonly type: "array";
                                                 readonly items: {
                                                     readonly type: "string";
                                                 };
+                                                readonly example: readonly ["red", "blue"];
                                             };
                                         };
                                         readonly components: {};

package/dist/lib/openapi/spec/variant-schema.d.ts

@@ -3,23 +3,34 @@ export declare const variantSchema: {
     readonly $id: "#/components/schemas/variantSchema";
     readonly type: "object";
     readonly additionalProperties: false;
+    readonly description: "A variant allows for further separation of users into segments. See [our excellent documentation](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) for a more detailed description";
     readonly required: readonly ["name", "weight"];
     readonly properties: {
         readonly name: {
             readonly type: "string";
+            readonly description: "The variants name. Is unique for this feature toggle";
+            readonly example: "blue_group";
         };
         readonly weight: {
             readonly type: "number";
+            readonly description: "The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
+            readonly minimum: 0;
+            readonly maximum: 1000;
         };
         readonly weightType: {
+            readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
             readonly type: "string";
+            readonly example: "fix";
         };
         readonly stickiness: {
             readonly type: "string";
+            readonly description: "[Stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) is how Unleash guarantees that the same user gets the same variant every time";
+            readonly example: "custom.context.field";
         };
         readonly payload: {
             readonly type: "object";
             readonly required: readonly ["type", "value"];
+            readonly description: "Extra data configured for this variant";
             readonly properties: {
                 readonly type: {
                     readonly type: "string";
@@ -28,8 +39,13 @@ export declare const variantSchema: {
                     readonly type: "string";
                 };
             };
+            readonly example: {
+                readonly type: "json";
+                readonly value: "{color: red}";
+            };
         };
         readonly overrides: {
+            readonly description: "Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.";
             readonly type: "array";
             readonly items: {
                 readonly $ref: "#/components/schemas/overrideSchema";
@@ -43,15 +59,20 @@ export declare const variantSchema: {
                 readonly type: "object";
                 readonly additionalProperties: false;
                 readonly required: readonly ["contextName", "values"];
+                readonly description: "An override for deciding which variant should be assigned to a user based on the context name";
                 readonly properties: {
                     readonly contextName: {
+                        readonly description: "The name of the context field used to determine overrides";
                         readonly type: "string";
+                        readonly example: "userId";
                     };
                     readonly values: {
+                        readonly description: "Which values that should be overriden";
                         readonly type: "array";
                         readonly items: {
                             readonly type: "string";
                         };
+                        readonly example: readonly ["red", "blue"];
                     };
                 };
                 readonly components: {};

package/dist/lib/openapi/spec/variant-schema.js

@@ -6,23 +6,34 @@ exports.variantSchema = {
     $id: '#/components/schemas/variantSchema',
     type: 'object',
     additionalProperties: false,
+    description: 'A variant allows for further separation of users into segments. See [our excellent documentation](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) for a more detailed description',
     required: ['name', 'weight'],
     properties: {
         name: {
             type: 'string',
+            description: 'The variants name. Is unique for this feature toggle',
+            example: 'blue_group',
         },
         weight: {
             type: 'number',
+            description: 'The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information',
+            minimum: 0,
+            maximum: 1000,
         },
         weightType: {
+            description: 'Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000',
             type: 'string',
+            example: 'fix',
         },
         stickiness: {
             type: 'string',
+            description: '[Stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) is how Unleash guarantees that the same user gets the same variant every time',
+            example: 'custom.context.field',
         },
         payload: {
             type: 'object',
             required: ['type', 'value'],
+            description: 'Extra data configured for this variant',
             properties: {
                 type: {
                     type: 'string',
@@ -31,8 +42,10 @@ exports.variantSchema = {
                     type: 'string',
                 },
             },
+            example: { type: 'json', value: '{color: red}' },
         },
         overrides: {
+            description: `Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.`,
             type: 'array',
             items: {
                 $ref: '#/components/schemas/overrideSchema',

package/dist/lib/openapi/spec/variant-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"variant-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/variant-schema.ts"],"names":[],"mappings":";;;AACA,uDAAmD;AAEtC,QAAA,aAAa,GAAG;IACzB,GAAG,EAAE,oCAAoC;IACzC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC5B,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;SACjB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;YAC3B,UAAU,EAAE;gBACR,IAAI,EAAE;oBACF,IAAI,EAAE,QAAQ;iBACjB;gBACD,KAAK,EAAE;oBACH,IAAI,EAAE,QAAQ;iBACjB;aACJ;SACJ;QACD,SAAS,EAAE;YACP,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,qCAAqC;aAC9C;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,cAAc,EAAd,gCAAc;SACjB;KACJ;CACK,CAAC"}
+{"version":3,"file":"variant-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/variant-schema.ts"],"names":[],"mappings":";;;AACA,uDAAmD;AAEtC,QAAA,aAAa,GAAG;IACzB,GAAG,EAAE,oCAAoC;IACzC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,mNAAmN;IACvN,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC5B,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,sDAAsD;YACnE,OAAO,EAAE,YAAY;SACxB;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,8OAA8O;YAClP,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,IAAI;SAChB;QACD,UAAU,EAAE;YACR,WAAW,EACP,mLAAmL;YACvL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,KAAK;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,6KAA6K;YACjL,OAAO,EAAE,sBAAsB;SAClC;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;YAC3B,WAAW,EAAE,wCAAwC;YACrD,UAAU,EAAE;gBACR,IAAI,EAAE;oBACF,IAAI,EAAE,QAAQ;iBACjB;gBACD,KAAK,EAAE;oBACH,IAAI,EAAE,QAAQ;iBACjB;aACJ;YACD,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE;SACnD;QACD,SAAS,EAAE;YACP,WAAW,EAAE,4LAA4L;YACzM,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,qCAAqC;aAC9C;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,cAAc,EAAd,gCAAc;SACjB;KACJ;CACK,CAAC"}