unleash-server 5.2.7 → 5.3.0

package/dist/lib/openapi/spec/create-user-response-schema.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createUserResponseSchema = void 0;
+const user_schema_1 = require("./user-schema");
+exports.createUserResponseSchema = {
+    $id: '#/components/schemas/createUserResponseSchema',
+    type: 'object',
+    additionalProperties: false,
+    description: 'An Unleash user after creation',
+    required: ['id'],
+    properties: {
+        ...user_schema_1.userSchema.properties,
+        rootRole: {
+            description: 'Which [root role](https://docs.getunleash.io/reference/rbac#standard-roles) this user is assigned. Usually a numeric role ID, but can be a string when returning newly created user with an explicit string role.',
+            oneOf: [
+                {
+                    type: 'integer',
+                    example: 1,
+                    minimum: 0,
+                },
+                {
+                    type: 'string',
+                    example: 'Admin',
+                    enum: ['Admin', 'Editor', 'Viewer', 'Owner', 'Member'],
+                },
+            ],
+        },
+    },
+    components: {},
+};
+//# sourceMappingURL=create-user-response-schema.js.map

package/dist/lib/openapi/spec/create-user-response-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-user-response-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/create-user-response-schema.ts"],"names":[],"mappings":";;;AACA,+CAA2C;AAE9B,QAAA,wBAAwB,GAAG;IACpC,GAAG,EAAE,+CAA+C;IACpD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,gCAAgC;IAC7C,QAAQ,EAAE,CAAC,IAAI,CAAC;IAChB,UAAU,EAAE;QACR,GAAG,wBAAU,CAAC,UAAU;QACxB,QAAQ,EAAE;YACN,WAAW,EACP,mNAAmN;YACvN,KAAK,EAAE;gBACH;oBACI,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,CAAC;oBACV,OAAO,EAAE,CAAC;iBACb;gBACD;oBACI,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,OAAO;oBAChB,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC;iBACzD;aACJ;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

package/dist/lib/openapi/spec/create-user-schema.d.ts

@@ -4,24 +4,44 @@ export declare const createUserSchema: {
     readonly type: "object";
     readonly additionalProperties: false;
     readonly required: readonly ["rootRole"];
+    readonly description: "The payload must contain at least one of the name and email properties, though which one is up to you. For the user to be able to log in to the system, the user must have an email.";
     readonly properties: {
         readonly username: {
+            readonly description: "The user's username. Must be provided if email is not provided.";
             readonly type: "string";
+            readonly example: "hunter";
         };
         readonly email: {
+            readonly description: "The user's email address. Must be provided if username is not provided.";
             readonly type: "string";
+            readonly example: "user@example.com";
         };
         readonly name: {
+            readonly description: "The user's name (not the user's username).";
             readonly type: "string";
+            readonly example: "Sam Seawright";
         };
         readonly password: {
             readonly type: "string";
+            readonly example: "k!5As3HquUrQ";
+            readonly description: "Password for the user";
         };
         readonly rootRole: {
-            readonly type: "number";
+            readonly description: "The role to assign to the user. Can be either the role's ID or its unique name.";
+            readonly oneOf: readonly [{
+                readonly type: "integer";
+                readonly example: 1;
+                readonly minimum: 0;
+            }, {
+                readonly type: "string";
+                readonly example: "Admin";
+                readonly enum: readonly ["Admin", "Editor", "Viewer", "Owner", "Member"];
+            }];
         };
         readonly sendEmail: {
             readonly type: "boolean";
+            readonly example: false;
+            readonly description: "Whether to send a welcome email with a login link to the user or not. Defaults to `true`.";
         };
     };
     readonly components: {};

package/dist/lib/openapi/spec/create-user-schema.js

@@ -6,24 +6,47 @@ exports.createUserSchema = {
     type: 'object',
     additionalProperties: false,
     required: ['rootRole'],
+    description: 'The payload must contain at least one of the name and email properties, though which one is up to you. For the user to be able to log in to the system, the user must have an email.',
     properties: {
         username: {
+            description: "The user's username. Must be provided if email is not provided.",
             type: 'string',
+            example: 'hunter',
         },
         email: {
+            description: "The user's email address. Must be provided if username is not provided.",
             type: 'string',
+            example: 'user@example.com',
         },
         name: {
+            description: "The user's name (not the user's username).",
             type: 'string',
+            example: 'Sam Seawright',
         },
         password: {
             type: 'string',
+            example: 'k!5As3HquUrQ',
+            description: 'Password for the user',
         },
         rootRole: {
-            type: 'number',
+            description: "The role to assign to the user. Can be either the role's ID or its unique name.",
+            oneOf: [
+                {
+                    type: 'integer',
+                    example: 1,
+                    minimum: 0,
+                },
+                {
+                    type: 'string',
+                    example: 'Admin',
+                    enum: ['Admin', 'Editor', 'Viewer', 'Owner', 'Member'],
+                },
+            ],
         },
         sendEmail: {
             type: 'boolean',
+            example: false,
+            description: 'Whether to send a welcome email with a login link to the user or not. Defaults to `true`.',
         },
     },
     components: {},

package/dist/lib/openapi/spec/create-user-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"create-user-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/create-user-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,gBAAgB,GAAG;IAC5B,GAAG,EAAE,uCAAuC;IAC5C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,CAAC;IACtB,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,SAAS;SAClB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"create-user-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/create-user-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,gBAAgB,GAAG;IAC5B,GAAG,EAAE,uCAAuC;IAC5C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,CAAC;IACtB,WAAW,EACP,sLAAsL;IAC1L,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,WAAW,EACP,iEAAiE;YACrE,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;SACpB;QACD,KAAK,EAAE;YACH,WAAW,EACP,yEAAyE;YAC7E,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,kBAAkB;SAC9B;QACD,IAAI,EAAE;YACF,WAAW,EAAE,4CAA4C;YACzD,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;SAC3B;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,cAAc;YACvB,WAAW,EAAE,uBAAuB;SACvC;QACD,QAAQ,EAAE;YACN,WAAW,EACP,iFAAiF;YACrF,KAAK,EAAE;gBACH;oBACI,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,CAAC;oBACV,OAAO,EAAE,CAAC;iBACb;gBACD;oBACI,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,OAAO;oBAChB,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC;iBACzD;aACJ;SACJ;QACD,SAAS,EAAE;YACP,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EACP,2FAA2F;SAClG;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -4,9 +4,12 @@ export declare const emailSchema: {
     readonly type: "object";
     readonly additionalProperties: false;
     readonly required: readonly ["email"];
+    readonly description: "Represents the email of a user. Used to send email communication (reset password, welcome mail etc)";
     readonly properties: {
         readonly email: {
+            readonly description: "The email address";
             readonly type: "string";
+            readonly example: "test@example.com";
         };
     };
     readonly components: {};

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

@@ -6,9 +6,12 @@ exports.emailSchema = {
     type: 'object',
     additionalProperties: false,
     required: ['email'],
+    description: 'Represents the email of a user. Used to send email communication (reset password, welcome mail etc)',
     properties: {
         email: {
+            description: 'The email address',
             type: 'string',
+            example: 'test@example.com',
         },
     },
     components: {},

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

@@ -1 +1 @@
-{"version":3,"file":"email-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/email-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,WAAW,GAAG;IACvB,GAAG,EAAE,kCAAkC;IACvC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,OAAO,CAAC;IACnB,UAAU,EAAE;QACR,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;SACjB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"email-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/email-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,WAAW,GAAG;IACvB,GAAG,EAAE,kCAAkC;IACvC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,OAAO,CAAC;IACnB,WAAW,EACP,qGAAqG;IACzG,UAAU,EAAE;QACR,KAAK,EAAE;YACH,WAAW,EAAE,mBAAmB;YAChC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,kBAAkB;SAC9B;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -54,10 +54,11 @@ export declare const environmentProjectSchema: {
                 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: {
@@ -79,7 +80,7 @@ export declare const environmentProjectSchema: {
                     };
                     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;
@@ -91,6 +92,13 @@ export declare const environmentProjectSchema: {
                             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: {
@@ -158,13 +166,118 @@ export declare const environmentProjectSchema: {
                         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/environment-project-schema.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.environmentProjectSchema = 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.environmentProjectSchema = {
     $id: '#/components/schemas/environmentProjectSchema',
     type: 'object',
@@ -54,6 +55,7 @@ exports.environmentProjectSchema = {
     components: {
         schemas: {
             createFeatureStrategySchema: create_feature_strategy_schema_1.createFeatureStrategySchema,
+            createStrategyVariantSchema: create_strategy_variant_schema_1.createStrategyVariantSchema,
         },
     },
 };

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

@@ -1 +1 @@
-{"version":3,"file":"environment-project-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/environment-project-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,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,CAAC;IAC/D,WAAW,EAAE,6DAA6D;IAC1E,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,6BAA6B;SAC7C;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,YAAY;YACrB,WAAW,EACP,iGAAiG;SACxG;QACD,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EACP,yEAAyE;SAChF;QACD,SAAS,EAAE;YACP,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EACP,0GAA0G;SACjH;QACD,SAAS,EAAE;YACP,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,WAAW,EACP,mIAAmI;SAC1I;QACD,oBAAoB,EAAE;YAClB,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;YACV,WAAW,EACP,gFAAgF;SACvF;QACD,yBAAyB,EAAE;YACvB,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;YACV,WAAW,EACP,qEAAqE;SAC5E;QACD,eAAe,EAAE;YACb,WAAW,EACP,kFAAkF;YACtF,IAAI,EAAE,kDAAkD;SAC3D;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,2BAA2B,EAA3B,4DAA2B;SAC9B;KACJ;CACK,CAAC"}
+{"version":3,"file":"environment-project-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/environment-project-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,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,WAAW,EAAE,WAAW,CAAC;IAC/D,WAAW,EAAE,6DAA6D;IAC1E,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,6BAA6B;SAC7C;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,YAAY;YACrB,WAAW,EACP,iGAAiG;SACxG;QACD,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EACP,yEAAyE;SAChF;QACD,SAAS,EAAE;YACP,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EACP,0GAA0G;SACjH;QACD,SAAS,EAAE;YACP,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,WAAW,EACP,mIAAmI;SAC1I;QACD,oBAAoB,EAAE;YAClB,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;YACV,WAAW,EACP,gFAAgF;SACvF;QACD,yBAAyB,EAAE;YACvB,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;YACV,WAAW,EACP,qEAAqE;SAC5E;QACD,eAAe,EAAE;YACb,WAAW,EACP,kFAAkF;YACtF,IAAI,EAAE,kDAAkD;SAC3D;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,2BAA2B,EAA3B,4DAA2B;YAC3B,2BAA2B,EAA3B,4DAA2B;SAC9B;KACJ;CACK,CAAC"}

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

@@ -8,12 +8,15 @@ export declare const environmentsProjectSchema: {
     readonly properties: {
         readonly version: {
             readonly type: "integer";
+            readonly example: 1;
+            readonly description: "Version of the environments schema";
         };
         readonly environments: {
             readonly type: "array";
             readonly items: {
                 readonly $ref: "#/components/schemas/environmentProjectSchema";
             };
+            readonly description: "List of environments";
         };
     };
     readonly components: {
@@ -73,10 +76,11 @@ export declare const environmentsProjectSchema: {
                             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: {
@@ -98,7 +102,7 @@ export declare const environmentsProjectSchema: {
                                 };
                                 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;
@@ -110,6 +114,13 @@ export declare const environmentsProjectSchema: {
                                         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: {
@@ -177,13 +188,118 @@ export declare const environmentsProjectSchema: {
                                     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/environments-project-schema.js

@@ -11,12 +11,15 @@ exports.environmentsProjectSchema = {
     properties: {
         version: {
             type: 'integer',
+            example: 1,
+            description: 'Version of the environments schema',
         },
         environments: {
             type: 'array',
             items: {
                 $ref: '#/components/schemas/environmentProjectSchema',
             },
+            description: 'List of environments',
         },
     },
     components: {

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

@@ -1 +1 @@
-{"version":3,"file":"environments-project-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/environments-project-schema.ts"],"names":[],"mappings":";;;AACA,6EAAwE;AAE3D,QAAA,yBAAyB,GAAG;IACrC,GAAG,EAAE,gDAAgD;IACrD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC;IACrC,WAAW,EAAE,0CAA0C;IACvD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;SAClB;QACD,YAAY,EAAE;YACV,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,+CAA+C;aACxD;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,wBAAwB,EAAxB,qDAAwB;SAC3B;KACJ;CACK,CAAC"}
+{"version":3,"file":"environments-project-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/environments-project-schema.ts"],"names":[],"mappings":";;;AACA,6EAAwE;AAE3D,QAAA,yBAAyB,GAAG;IACrC,GAAG,EAAE,gDAAgD;IACrD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC;IACrC,WAAW,EAAE,0CAA0C;IACvD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,WAAW,EAAE,oCAAoC;SACpD;QACD,YAAY,EAAE;YACV,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,+CAA+C;aACxD;YACD,WAAW,EAAE,sBAAsB;SACtC;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,wBAAwB,EAAxB,qDAAwB;SAC3B;KACJ;CACK,CAAC"}

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

@@ -4,15 +4,19 @@ export declare const environmentsSchema: {
     readonly type: "object";
     readonly additionalProperties: false;
     readonly required: readonly ["version", "environments"];
+    readonly description: "A versioned list of environments";
     readonly properties: {
         readonly version: {
             readonly type: "integer";
+            readonly example: 1;
+            readonly description: "Version of the environments schema";
         };
         readonly environments: {
             readonly type: "array";
             readonly items: {
                 readonly $ref: "#/components/schemas/environmentSchema";
             };
+            readonly description: "List of environments";
         };
     };
     readonly components: {

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

@@ -7,15 +7,19 @@ exports.environmentsSchema = {
     type: 'object',
     additionalProperties: false,
     required: ['version', 'environments'],
+    description: 'A versioned list of environments',
     properties: {
         version: {
             type: 'integer',
+            example: 1,
+            description: 'Version of the environments schema',
         },
         environments: {
             type: 'array',
             items: {
                 $ref: '#/components/schemas/environmentSchema',
             },
+            description: 'List of environments',
         },
     },
     components: {

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

@@ -1 +1 @@
-{"version":3,"file":"environments-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/environments-schema.ts"],"names":[],"mappings":";;;AACA,6DAAyD;AAE5C,QAAA,kBAAkB,GAAG;IAC9B,GAAG,EAAE,yCAAyC;IAC9C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC;IACrC,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;SAClB;QACD,YAAY,EAAE;YACV,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,wCAAwC;aACjD;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,iBAAiB,EAAjB,sCAAiB;SACpB;KACJ;CACK,CAAC"}
+{"version":3,"file":"environments-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/environments-schema.ts"],"names":[],"mappings":";;;AACA,6DAAyD;AAE5C,QAAA,kBAAkB,GAAG;IAC9B,GAAG,EAAE,yCAAyC;IAC9C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,cAAc,CAAC;IACrC,WAAW,EAAE,kCAAkC;IAC/C,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,WAAW,EAAE,oCAAoC;SACpD;QACD,YAAY,EAAE;YACV,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,wCAAwC;aACjD;YACD,WAAW,EAAE,sBAAsB;SACtC;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,iBAAiB,EAAjB,sCAAiB;SACpB;KACJ;CACK,CAAC"}