unleash-server 5.2.8 → 5.3.0

package/dist/lib/openapi/spec/project-environment-schema.d.ts

@@ -27,10 +27,11 @@ export declare const projectEnvironmentSchema: {
                 readonly $id: "#/components/schemas/createFeatureStrategySchema";
                 readonly type: "object";
                 readonly required: readonly ["name"];
+                readonly description: "Create a strategy configuration in a feature";
                 readonly properties: {
                     readonly name: {
                         readonly type: "string";
-                        readonly description: "The name or type of strategy";
+                        readonly description: "The name of the strategy type";
                         readonly example: "flexibleRollout";
                     };
                     readonly title: {
@@ -52,7 +53,7 @@ export declare const projectEnvironmentSchema: {
                     };
                     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 example: readonly [{
                             readonly values: readonly ["1", "2"];
                             readonly inverted: false;
@@ -64,6 +65,13 @@ export declare const projectEnvironmentSchema: {
                             readonly $ref: "#/components/schemas/constraintSchema";
                         };
                     };
+                    readonly variants: {
+                        readonly type: "array";
+                        readonly description: "Strategy level variants";
+                        readonly items: {
+                            readonly $ref: "#/components/schemas/createStrategyVariantSchema";
+                        };
+                    };
                     readonly parameters: {
                         readonly description: "An object containing the parameters for the strategy";
                         readonly example: {
@@ -131,13 +139,118 @@ export declare const projectEnvironmentSchema: {
                         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 createStrategyVariantSchema: {
+                            readonly $id: "#/components/schemas/createStrategyVariantSchema";
+                            readonly type: "object";
+                            readonly additionalProperties: true;
+                            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 createStrategyVariantSchema: {
+                readonly $id: "#/components/schemas/createStrategyVariantSchema";
+                readonly type: "object";
+                readonly additionalProperties: true;
+                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: {};
             };
         };
     };

package/dist/lib/openapi/spec/project-environment-schema.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.projectEnvironmentSchema = void 0;
 const create_feature_strategy_schema_1 = require("./create-feature-strategy-schema");
+const create_strategy_variant_schema_1 = require("./create-strategy-variant-schema");
 exports.projectEnvironmentSchema = {
     $id: '#/components/schemas/projectEnvironmentSchema',
     type: 'object',
@@ -27,6 +28,7 @@ exports.projectEnvironmentSchema = {
     components: {
         schemas: {
             createFeatureStrategySchema: create_feature_strategy_schema_1.createFeatureStrategySchema,
+            createStrategyVariantSchema: create_strategy_variant_schema_1.createStrategyVariantSchema,
         },
     },
 };

package/dist/lib/openapi/spec/project-environment-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"project-environment-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/project-environment-schema.ts"],"names":[],"mappings":";;;AACA,qFAA+E;AAElE,QAAA,wBAAwB,GAAG;IACpC,GAAG,EAAE,+CAA+C;IACpD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,0HAA0H;IAC9H,QAAQ,EAAE,CAAC,aAAa,CAAC;IACzB,UAAU,EAAE;QACR,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,uCAAuC;YACpD,OAAO,EAAE,aAAa;SACzB;QACD,qBAAqB,EAAE;YACnB,IAAI,EAAE,SAAS;YACf,WAAW,EACP,yFAAyF;YAC7F,OAAO,EAAE,IAAI;SAChB;QACD,eAAe,EAAE;YACb,IAAI,EAAE,kDAAkD;YACxD,WAAW,EACP,mEAAmE;SAC1E;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,2BAA2B,EAA3B,4DAA2B;SAC9B;KACJ;CACK,CAAC"}
+{"version":3,"file":"project-environment-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/project-environment-schema.ts"],"names":[],"mappings":";;;AACA,qFAA+E;AAC/E,qFAA+E;AAElE,QAAA,wBAAwB,GAAG;IACpC,GAAG,EAAE,+CAA+C;IACpD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,0HAA0H;IAC9H,QAAQ,EAAE,CAAC,aAAa,CAAC;IACzB,UAAU,EAAE;QACR,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,uCAAuC;YACpD,OAAO,EAAE,aAAa;SACzB;QACD,qBAAqB,EAAE;YACnB,IAAI,EAAE,SAAS;YACf,WAAW,EACP,yFAAyF;YAC7F,OAAO,EAAE,IAAI;SAChB;QACD,eAAe,EAAE;YACb,IAAI,EAAE,kDAAkD;YACxD,WAAW,EACP,mEAAmE;SAC1E;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,2BAA2B,EAA3B,4DAA2B;YAC3B,2BAA2B,EAA3B,4DAA2B;SAC9B;KACJ;CACK,CAAC"}