unleash-server 5.2.7 → 5.3.0

package/dist/lib/openapi/spec/feature-events-schema.js

@@ -8,18 +8,30 @@ exports.featureEventsSchema = {
     type: 'object',
     additionalProperties: false,
     required: ['events'],
+    description: 'One or more events happening to a specific feature toggle',
     properties: {
-        version: { type: 'number' },
+        version: {
+            type: 'integer',
+            description: 'An API versioning number',
+            minimum: 1,
+            enum: [1],
+            example: 1,
+        },
         toggleName: {
+            description: 'The name of the feature toggle these events relate to',
             type: 'string',
+            example: 'my.first.feature.toggle',
         },
         events: {
+            description: 'The list of events',
             type: 'array',
             items: { $ref: event_schema_1.eventSchema.$id },
         },
         totalEvents: {
+            description: 'How many events are there for this feature toggle',
             type: 'integer',
             minimum: 0,
+            example: 13,
         },
     },
     components: {

package/dist/lib/openapi/spec/feature-events-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"feature-events-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/feature-events-schema.ts"],"names":[],"mappings":";;;AACA,iDAA6C;AAC7C,6CAAyC;AAE5B,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,QAAQ,CAAC;IACpB,UAAU,EAAE;QACR,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC3B,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;SACjB;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,0BAAW,CAAC,GAAG,EAAE;SACnC;QACD,WAAW,EAAE;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;SACb;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,WAAW,EAAX,0BAAW;YACX,SAAS,EAAT,sBAAS;SACZ;KACJ;CACK,CAAC"}
+{"version":3,"file":"feature-events-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/feature-events-schema.ts"],"names":[],"mappings":";;;AACA,iDAA6C;AAC7C,6CAAyC;AAE5B,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,QAAQ,CAAC;IACpB,WAAW,EAAE,2DAA2D;IACxE,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,0BAA0B;YACvC,OAAO,EAAE,CAAC;YACV,IAAI,EAAE,CAAC,CAAC,CAAC;YACT,OAAO,EAAE,CAAC;SACb;QACD,UAAU,EAAE;YACR,WAAW,EACP,uDAAuD;YAC3D,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,yBAAyB;SACrC;QACD,MAAM,EAAE;YACJ,WAAW,EAAE,oBAAoB;YACjC,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,0BAAW,CAAC,GAAG,EAAE;SACnC;QACD,WAAW,EAAE;YACT,WAAW,EAAE,mDAAmD;YAChE,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,EAAE;SACd;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,WAAW,EAAX,0BAAW;YACX,SAAS,EAAT,sBAAS;SACZ;KACJ;CACK,CAAC"}

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

@@ -4,6 +4,7 @@ export declare const featureSchema: {
     readonly type: "object";
     readonly additionalProperties: false;
     readonly required: readonly ["name"];
+    readonly description: "A feature toggle definition";
     readonly properties: {
         readonly name: {
             readonly type: "string";
@@ -34,6 +35,7 @@ export declare const featureSchema: {
         readonly enabled: {
             readonly type: "boolean";
             readonly example: true;
+            readonly description: "`true` if the feature is enabled, otherwise `false`.";
         };
         readonly stale: {
             readonly type: "boolean";
@@ -55,18 +57,21 @@ export declare const featureSchema: {
             readonly format: "date-time";
             readonly nullable: true;
             readonly example: "2023-01-28T15:21:39.975Z";
+            readonly description: "The date the feature was created";
         };
         readonly archivedAt: {
             readonly type: "string";
             readonly format: "date-time";
             readonly nullable: true;
             readonly example: "2023-01-29T15:21:39.975Z";
+            readonly description: "The date the feature was archived";
         };
         readonly lastSeenAt: {
             readonly type: "string";
             readonly format: "date-time";
             readonly nullable: true;
             readonly example: "2023-01-28T16:21:39.975Z";
+            readonly description: "The date when metrics where last collected for the feature";
         };
         readonly environments: {
             readonly type: "array";
@@ -161,9 +166,12 @@ export declare const featureSchema: {
                     readonly featureName: {
                         readonly type: "string";
                         readonly example: "disable-comments";
+                        readonly description: "The name of the feature";
                     };
                     readonly environment: {
                         readonly type: "string";
+                        readonly example: "development";
+                        readonly description: "The name of the environment";
                     };
                     readonly type: {
                         readonly type: "string";
@@ -182,6 +190,7 @@ export declare const featureSchema: {
                     };
                     readonly variantCount: {
                         readonly type: "number";
+                        readonly description: "The number of defined variants";
                     };
                     readonly strategies: {
                         readonly type: "array";
@@ -247,6 +256,7 @@ export declare const featureSchema: {
                         readonly parametersSchema: {
                             readonly $id: "#/components/schemas/parametersSchema";
                             readonly type: "object";
+                            readonly description: "A list of parameters for a strategy";
                             readonly additionalProperties: {
                                 readonly type: "string";
                             };
@@ -301,11 +311,18 @@ export declare const featureSchema: {
                                 };
                                 readonly constraints: {
                                     readonly type: "array";
-                                    readonly description: "A list of the constraints attached to the strategy";
+                                    readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
                                     readonly items: {
                                         readonly $ref: "#/components/schemas/constraintSchema";
                                     };
                                 };
+                                readonly variants: {
+                                    readonly type: "array";
+                                    readonly description: "Strategy level variants";
+                                    readonly items: {
+                                        readonly $ref: "#/components/schemas/strategyVariantSchema";
+                                    };
+                                };
                                 readonly parameters: {
                                     readonly $ref: "#/components/schemas/parametersSchema";
                                 };
@@ -359,13 +376,118 @@ export declare const featureSchema: {
                                     readonly parametersSchema: {
                                         readonly $id: "#/components/schemas/parametersSchema";
                                         readonly type: "object";
+                                        readonly description: "A list of parameters for a strategy";
                                         readonly additionalProperties: {
                                             readonly type: "string";
                                         };
                                         readonly components: {};
                                     };
+                                    readonly strategyVariantSchema: {
+                                        readonly $id: "#/components/schemas/strategyVariantSchema";
+                                        readonly type: "object";
+                                        readonly additionalProperties: false;
+                                        readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
+                                        readonly required: readonly ["name", "weight", "weightType", "stickiness"];
+                                        readonly properties: {
+                                            readonly name: {
+                                                readonly type: "string";
+                                                readonly description: "The variant name. Must be unique for this feature toggle";
+                                                readonly example: "blue_group";
+                                            };
+                                            readonly weight: {
+                                                readonly type: "integer";
+                                                readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer 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. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
+                                                readonly type: "string";
+                                                readonly example: "fix";
+                                                readonly enum: readonly ["variable", "fix"];
+                                            };
+                                            readonly stickiness: {
+                                                readonly type: "string";
+                                                readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this 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 description: "The type of the value. Commonly used types are string, json and csv.";
+                                                        readonly type: "string";
+                                                        readonly enum: readonly ["json", "csv", "string"];
+                                                    };
+                                                    readonly value: {
+                                                        readonly description: "The actual value of payload";
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                                readonly example: {
+                                                    readonly type: "json";
+                                                    readonly value: "{\"color\": \"red\"}";
+                                                };
+                                            };
+                                        };
+                                        readonly components: {};
+                                    };
+                                };
+                            };
+                        };
+                        readonly strategyVariantSchema: {
+                            readonly $id: "#/components/schemas/strategyVariantSchema";
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
+                            readonly required: readonly ["name", "weight", "weightType", "stickiness"];
+                            readonly properties: {
+                                readonly name: {
+                                    readonly type: "string";
+                                    readonly description: "The variant name. Must be unique for this feature toggle";
+                                    readonly example: "blue_group";
+                                };
+                                readonly weight: {
+                                    readonly type: "integer";
+                                    readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer 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. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
+                                    readonly type: "string";
+                                    readonly example: "fix";
+                                    readonly enum: readonly ["variable", "fix"];
+                                };
+                                readonly stickiness: {
+                                    readonly type: "string";
+                                    readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this 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 description: "The type of the value. Commonly used types are string, json and csv.";
+                                            readonly type: "string";
+                                            readonly enum: readonly ["json", "csv", "string"];
+                                        };
+                                        readonly value: {
+                                            readonly description: "The actual value of payload";
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly example: {
+                                        readonly type: "json";
+                                        readonly value: "{\"color\": \"red\"}";
+                                    };
                                 };
                             };
+                            readonly components: {};
                         };
                         readonly variantSchema: {
                             readonly $id: "#/components/schemas/variantSchema";
@@ -388,7 +510,8 @@ export declare const featureSchema: {
                                 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 example: "variable";
+                                    readonly enum: readonly ["variable", "fix"];
                                 };
                                 readonly stickiness: {
                                     readonly type: "string";
@@ -399,17 +522,21 @@ export declare const featureSchema: {
                                     readonly type: "object";
                                     readonly required: readonly ["type", "value"];
                                     readonly description: "Extra data configured for this variant";
+                                    readonly additionalProperties: false;
                                     readonly properties: {
                                         readonly type: {
+                                            readonly description: "The type of the value. Commonly used types are string, json and csv.";
                                             readonly type: "string";
+                                            readonly enum: readonly ["json", "csv", "string"];
                                         };
                                         readonly value: {
+                                            readonly description: "The actual value of payload";
                                             readonly type: "string";
                                         };
                                     };
                                     readonly example: {
                                         readonly type: "json";
-                                        readonly value: "{color: red}";
+                                        readonly value: "{\"color\": \"red\"}";
                                     };
                                 };
                                 readonly overrides: {
@@ -500,11 +627,18 @@ export declare const featureSchema: {
                     };
                     readonly constraints: {
                         readonly type: "array";
-                        readonly description: "A list of the constraints attached to the strategy";
+                        readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
                         readonly items: {
                             readonly $ref: "#/components/schemas/constraintSchema";
                         };
                     };
+                    readonly variants: {
+                        readonly type: "array";
+                        readonly description: "Strategy level variants";
+                        readonly items: {
+                            readonly $ref: "#/components/schemas/strategyVariantSchema";
+                        };
+                    };
                     readonly parameters: {
                         readonly $ref: "#/components/schemas/parametersSchema";
                     };
@@ -558,14 +692,119 @@ export declare const featureSchema: {
                         readonly parametersSchema: {
                             readonly $id: "#/components/schemas/parametersSchema";
                             readonly type: "object";
+                            readonly description: "A list of parameters for a strategy";
                             readonly additionalProperties: {
                                 readonly type: "string";
                             };
                             readonly components: {};
                         };
+                        readonly strategyVariantSchema: {
+                            readonly $id: "#/components/schemas/strategyVariantSchema";
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
+                            readonly required: readonly ["name", "weight", "weightType", "stickiness"];
+                            readonly properties: {
+                                readonly name: {
+                                    readonly type: "string";
+                                    readonly description: "The variant name. Must be unique for this feature toggle";
+                                    readonly example: "blue_group";
+                                };
+                                readonly weight: {
+                                    readonly type: "integer";
+                                    readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer 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. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
+                                    readonly type: "string";
+                                    readonly example: "fix";
+                                    readonly enum: readonly ["variable", "fix"];
+                                };
+                                readonly stickiness: {
+                                    readonly type: "string";
+                                    readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this 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 description: "The type of the value. Commonly used types are string, json and csv.";
+                                            readonly type: "string";
+                                            readonly enum: readonly ["json", "csv", "string"];
+                                        };
+                                        readonly value: {
+                                            readonly description: "The actual value of payload";
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly example: {
+                                        readonly type: "json";
+                                        readonly value: "{\"color\": \"red\"}";
+                                    };
+                                };
+                            };
+                            readonly components: {};
+                        };
                     };
                 };
             };
+            readonly strategyVariantSchema: {
+                readonly $id: "#/components/schemas/strategyVariantSchema";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
+                readonly required: readonly ["name", "weight", "weightType", "stickiness"];
+                readonly properties: {
+                    readonly name: {
+                        readonly type: "string";
+                        readonly description: "The variant name. Must be unique for this feature toggle";
+                        readonly example: "blue_group";
+                    };
+                    readonly weight: {
+                        readonly type: "integer";
+                        readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer 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. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
+                        readonly type: "string";
+                        readonly example: "fix";
+                        readonly enum: readonly ["variable", "fix"];
+                    };
+                    readonly stickiness: {
+                        readonly type: "string";
+                        readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this 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 description: "The type of the value. Commonly used types are string, json and csv.";
+                                readonly type: "string";
+                                readonly enum: readonly ["json", "csv", "string"];
+                            };
+                            readonly value: {
+                                readonly description: "The actual value of payload";
+                                readonly type: "string";
+                            };
+                        };
+                        readonly example: {
+                            readonly type: "json";
+                            readonly value: "{\"color\": \"red\"}";
+                        };
+                    };
+                };
+                readonly components: {};
+            };
             readonly overrideSchema: {
                 readonly $id: "#/components/schemas/overrideSchema";
                 readonly type: "object";
@@ -592,6 +831,7 @@ export declare const featureSchema: {
             readonly parametersSchema: {
                 readonly $id: "#/components/schemas/parametersSchema";
                 readonly type: "object";
+                readonly description: "A list of parameters for a strategy";
                 readonly additionalProperties: {
                     readonly type: "string";
                 };
@@ -618,7 +858,8 @@ export declare const featureSchema: {
                     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 example: "variable";
+                        readonly enum: readonly ["variable", "fix"];
                     };
                     readonly stickiness: {
                         readonly type: "string";
@@ -629,17 +870,21 @@ export declare const featureSchema: {
                         readonly type: "object";
                         readonly required: readonly ["type", "value"];
                         readonly description: "Extra data configured for this variant";
+                        readonly additionalProperties: false;
                         readonly properties: {
                             readonly type: {
+                                readonly description: "The type of the value. Commonly used types are string, json and csv.";
                                 readonly type: "string";
+                                readonly enum: readonly ["json", "csv", "string"];
                             };
                             readonly value: {
+                                readonly description: "The actual value of payload";
                                 readonly type: "string";
                             };
                         };
                         readonly example: {
                             readonly type: "json";
-                            readonly value: "{color: red}";
+                            readonly value: "{\"color\": \"red\"}";
                         };
                     };
                     readonly overrides: {

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

@@ -8,11 +8,13 @@ const parameters_schema_1 = require("./parameters-schema");
 const feature_strategy_schema_1 = require("./feature-strategy-schema");
 const tag_schema_1 = require("./tag-schema");
 const feature_environment_schema_1 = require("./feature-environment-schema");
+const strategy_variant_schema_1 = require("./strategy-variant-schema");
 exports.featureSchema = {
     $id: '#/components/schemas/featureSchema',
     type: 'object',
     additionalProperties: false,
     required: ['name'],
+    description: 'A feature toggle definition',
     properties: {
         name: {
             type: 'string',
@@ -43,6 +45,7 @@ exports.featureSchema = {
         enabled: {
             type: 'boolean',
             example: true,
+            description: '`true` if the feature is enabled, otherwise `false`.',
         },
         stale: {
             type: 'boolean',
@@ -64,18 +67,21 @@ exports.featureSchema = {
             format: 'date-time',
             nullable: true,
             example: '2023-01-28T15:21:39.975Z',
+            description: 'The date the feature was created',
         },
         archivedAt: {
             type: 'string',
             format: 'date-time',
             nullable: true,
             example: '2023-01-29T15:21:39.975Z',
+            description: 'The date the feature was archived',
         },
         lastSeenAt: {
             type: 'string',
             format: 'date-time',
             nullable: true,
             example: '2023-01-28T16:21:39.975Z',
+            description: 'The date when metrics where last collected for the feature',
         },
         environments: {
             type: 'array',
@@ -114,6 +120,7 @@ exports.featureSchema = {
             constraintSchema: constraint_schema_1.constraintSchema,
             featureEnvironmentSchema: feature_environment_schema_1.featureEnvironmentSchema,
             featureStrategySchema: feature_strategy_schema_1.featureStrategySchema,
+            strategyVariantSchema: strategy_variant_schema_1.strategyVariantSchema,
             overrideSchema: override_schema_1.overrideSchema,
             parametersSchema: parameters_schema_1.parametersSchema,
             variantSchema: variant_schema_1.variantSchema,

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

@@ -1 +1 @@
-{"version":3,"file":"feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/feature-schema.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AACjD,2DAAuD;AACvD,uDAAmD;AACnD,2DAAuD;AACvD,uEAAkE;AAClE,6CAAyC;AACzC,6EAAwE;AAE3D,QAAA,aAAa,GAAG;IACzB,GAAG,EAAE,oCAAoC;IACzC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,kBAAkB;YAC3B,WAAW,EAAE,qBAAqB;SACrC;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EACP,mFAAmF;SAC1F;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EACH,mEAAmE;YACvE,WAAW,EAAE,qCAAqC;SACrD;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,mCAAmC;SACnD;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,UAAU;YACnB,WAAW,EAAE,4CAA4C;SAC5D;QACD,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;SAChB;QACD,KAAK,EAAE;YACH,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EACP,sFAAsF;SAC7F;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EACP,yDAAyD;SAChE;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EACP,yFAAyF;SAChG;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;SACtC;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;SACtC;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;SACtC;QACD,YAAY,EAAE;YACV,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,+CAA+C;aACxD;YACD,WAAW,EACP,wDAAwD;SAC/D;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;YACD,WAAW,EAAE,8BAA8B;YAC3C,UAAU,EAAE,IAAI;SACnB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;YACD,WAAW,EAAE,gDAAgD;YAC7D,UAAU,EAAE,IAAI;SACnB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,gCAAgC;aACzC;YACD,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,0BAA0B;SAC1C;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,wBAAwB,EAAxB,qDAAwB;YACxB,qBAAqB,EAArB,+CAAqB;YACrB,cAAc,EAAd,gCAAc;YACd,gBAAgB,EAAhB,oCAAgB;YAChB,aAAa,EAAb,8BAAa;YACb,SAAS,EAAT,sBAAS;SACZ;KACJ;CACK,CAAC"}
+{"version":3,"file":"feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/feature-schema.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AACjD,2DAAuD;AACvD,uDAAmD;AACnD,2DAAuD;AACvD,uEAAkE;AAClE,6CAAyC;AACzC,6EAAwE;AACxE,uEAAkE;AAErD,QAAA,aAAa,GAAG;IACzB,GAAG,EAAE,oCAAoC;IACzC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,WAAW,EAAE,6BAA6B;IAC1C,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,kBAAkB;YAC3B,WAAW,EAAE,qBAAqB;SACrC;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EACP,mFAAmF;SAC1F;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EACH,mEAAmE;YACvE,WAAW,EAAE,qCAAqC;SACrD;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,mCAAmC;SACnD;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,UAAU;YACnB,WAAW,EAAE,4CAA4C;SAC5D;QACD,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,sDAAsD;SACtE;QACD,KAAK,EAAE;YACH,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EACP,sFAAsF;SAC7F;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EACP,yDAAyD;SAChE;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EACP,yFAAyF;SAChG;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;YACnC,WAAW,EAAE,kCAAkC;SAClD;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;YACnC,WAAW,EAAE,mCAAmC;SACnD;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;YACnC,WAAW,EACP,4DAA4D;SACnE;QACD,YAAY,EAAE;YACV,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,+CAA+C;aACxD;YACD,WAAW,EACP,wDAAwD;SAC/D;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;YACD,WAAW,EAAE,8BAA8B;YAC3C,UAAU,EAAE,IAAI;SACnB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;YACD,WAAW,EAAE,gDAAgD;YAC7D,UAAU,EAAE,IAAI;SACnB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,gCAAgC;aACzC;YACD,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,0BAA0B;SAC1C;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,wBAAwB,EAAxB,qDAAwB;YACxB,qBAAqB,EAArB,+CAAqB;YACrB,qBAAqB,EAArB,+CAAqB;YACrB,cAAc,EAAd,gCAAc;YACd,gBAAgB,EAAhB,oCAAgB;YAChB,aAAa,EAAb,8BAAa;YACb,SAAS,EAAT,sBAAS;SACZ;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/feature-schema.test.js

@@ -11,7 +11,7 @@ test('featureSchema', () => {
                 weightType: 'fix',
                 stickiness: 'a',
                 overrides: [{ contextName: 'a', values: ['a'] }],
-                payload: { type: 'a', value: 'b' },
+                payload: { type: 'string', value: 'b' },
             },
         ],
         environments: [
@@ -72,7 +72,7 @@ test('featureSchema variant override values must be an array', () => {
             {
                 name: 'a',
                 weight: 1,
-                weightType: 'a',
+                weightType: 'fix',
                 stickiness: 'a',
                 overrides: [{ contextName: 'a', values: 'b' }],
                 payload: { type: 'a', value: 'b' },

package/dist/lib/openapi/spec/feature-schema.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"feature-schema.test.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/feature-schema.test.ts"],"names":[],"mappings":";;AAAA,0CAA6C;AAG7C,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE;IACvB,MAAM,IAAI,GAAkB;QACxB,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE;YACN;gBACI,IAAI,EAAE,GAAG;gBACT,MAAM,EAAE,CAAC;gBACT,UAAU,EAAE,KAAK;gBACjB,UAAU,EAAE,GAAG;gBACf,SAAS,EAAE,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChD,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE;aACrC;SACJ;QACD,YAAY,EAAE;YACV;gBACI,IAAI,EAAE,GAAG;gBACT,IAAI,EAAE,GAAG;gBACT,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE;oBACR;wBACI,EAAE,EAAE,GAAG;wBACP,IAAI,EAAE,GAAG;wBACT,WAAW,EAAE;4BACT;gCACI,WAAW,EAAE,GAAG;gCAChB,QAAQ,EAAE,IAAI;6BACjB;yBACJ;wBACD,QAAQ,EAAE,CAAC,CAAC,CAAC;qBAChB;iBACJ;aACJ;SACJ;KACJ,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EAAC,oCAAoC,EAAE,IAAI,CAAC,CAC7D,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACnC,MAAM,IAAI,GAAG;QACT,IAAI,EAAE,GAAG;QACT,YAAY,EAAE;YACV;gBACI,IAAI,EAAE,GAAG;gBACT,IAAI,EAAE,GAAG;gBACT,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE;oBACR,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,EAAE;iBACrD;aACJ;SACJ;KACJ,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EAAC,oCAAoC,EAAE,IAAI,CAAC,CAC7D,CAAC,eAAe,EAAE,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;IACvE,MAAM,IAAI,GAAG;QACT,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE;YACN;gBACI,IAAI,EAAE,GAAG;gBACT,MAAM,EAAE,CAAC;aACZ;SACJ;KACJ,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EAAC,oCAAoC,EAAE,IAAI,CAAC,CAC7D,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;IAChE,MAAM,IAAI,GAAG;QACT,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE;YACN;gBACI,IAAI,EAAE,GAAG;gBACT,MAAM,EAAE,CAAC;gBACT,UAAU,EAAE,GAAG;gBACf,UAAU,EAAE,GAAG;gBACf,SAAS,EAAE,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;gBAC9C,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE;aACrC;SACJ;KACJ,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EAAC,oCAAoC,EAAE,IAAI,CAAC,CAC7D,CAAC,eAAe,EAAE,CAAC;AACxB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"feature-schema.test.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/feature-schema.test.ts"],"names":[],"mappings":";;AAAA,0CAA6C;AAG7C,IAAI,CAAC,eAAe,EAAE,GAAG,EAAE;IACvB,MAAM,IAAI,GAAkB;QACxB,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE;YACN;gBACI,IAAI,EAAE,GAAG;gBACT,MAAM,EAAE,CAAC;gBACT,UAAU,EAAE,KAAK;gBACjB,UAAU,EAAE,GAAG;gBACf,SAAS,EAAE,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChD,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE;aAC1C;SACJ;QACD,YAAY,EAAE;YACV;gBACI,IAAI,EAAE,GAAG;gBACT,IAAI,EAAE,GAAG;gBACT,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE;oBACR;wBACI,EAAE,EAAE,GAAG;wBACP,IAAI,EAAE,GAAG;wBACT,WAAW,EAAE;4BACT;gCACI,WAAW,EAAE,GAAG;gCAChB,QAAQ,EAAE,IAAI;6BACjB;yBACJ;wBACD,QAAQ,EAAE,CAAC,CAAC,CAAC;qBAChB;iBACJ;aACJ;SACJ;KACJ,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EAAC,oCAAoC,EAAE,IAAI,CAAC,CAC7D,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACnC,MAAM,IAAI,GAAG;QACT,IAAI,EAAE,GAAG;QACT,YAAY,EAAE;YACV;gBACI,IAAI,EAAE,GAAG;gBACT,IAAI,EAAE,GAAG;gBACT,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE;oBACR,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,CAAC,EAAE;iBACrD;aACJ;SACJ;KACJ,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EAAC,oCAAoC,EAAE,IAAI,CAAC,CAC7D,CAAC,eAAe,EAAE,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,+DAA+D,EAAE,GAAG,EAAE;IACvE,MAAM,IAAI,GAAG;QACT,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE;YACN;gBACI,IAAI,EAAE,GAAG;gBACT,MAAM,EAAE,CAAC;aACZ;SACJ;KACJ,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EAAC,oCAAoC,EAAE,IAAI,CAAC,CAC7D,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,wDAAwD,EAAE,GAAG,EAAE;IAChE,MAAM,IAAI,GAAG;QACT,IAAI,EAAE,GAAG;QACT,QAAQ,EAAE;YACN;gBACI,IAAI,EAAE,GAAG;gBACT,MAAM,EAAE,CAAC;gBACT,UAAU,EAAE,KAAK;gBACjB,UAAU,EAAE,GAAG;gBACf,SAAS,EAAE,CAAC,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC;gBAC9C,OAAO,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE;aACrC;SACJ;KACJ,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EAAC,oCAAoC,EAAE,IAAI,CAAC,CAC7D,CAAC,eAAe,EAAE,CAAC;AACxB,CAAC,CAAC,CAAC"}

package/dist/lib/openapi/spec/feature-strategy-schema.d.ts

@@ -48,11 +48,18 @@ export declare const featureStrategySchema: {
         };
         readonly constraints: {
             readonly type: "array";
-            readonly description: "A list of the constraints attached to the strategy";
+            readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
             readonly items: {
                 readonly $ref: "#/components/schemas/constraintSchema";
             };
         };
+        readonly variants: {
+            readonly type: "array";
+            readonly description: "Strategy level variants";
+            readonly items: {
+                readonly $ref: "#/components/schemas/strategyVariantSchema";
+            };
+        };
         readonly parameters: {
             readonly $ref: "#/components/schemas/parametersSchema";
         };
@@ -106,11 +113,64 @@ export declare const featureStrategySchema: {
             readonly parametersSchema: {
                 readonly $id: "#/components/schemas/parametersSchema";
                 readonly type: "object";
+                readonly description: "A list of parameters for a strategy";
                 readonly additionalProperties: {
                     readonly type: "string";
                 };
                 readonly components: {};
             };
+            readonly strategyVariantSchema: {
+                readonly $id: "#/components/schemas/strategyVariantSchema";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
+                readonly required: readonly ["name", "weight", "weightType", "stickiness"];
+                readonly properties: {
+                    readonly name: {
+                        readonly type: "string";
+                        readonly description: "The variant name. Must be unique for this feature toggle";
+                        readonly example: "blue_group";
+                    };
+                    readonly weight: {
+                        readonly type: "integer";
+                        readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer 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. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
+                        readonly type: "string";
+                        readonly example: "fix";
+                        readonly enum: readonly ["variable", "fix"];
+                    };
+                    readonly stickiness: {
+                        readonly type: "string";
+                        readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this 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 description: "The type of the value. Commonly used types are string, json and csv.";
+                                readonly type: "string";
+                                readonly enum: readonly ["json", "csv", "string"];
+                            };
+                            readonly value: {
+                                readonly description: "The actual value of payload";
+                                readonly type: "string";
+                            };
+                        };
+                        readonly example: {
+                            readonly type: "json";
+                            readonly value: "{\"color\": \"red\"}";
+                        };
+                    };
+                };
+                readonly components: {};
+            };
         };
     };
 };