unleash-server 5.2.7 → 5.3.0

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

@@ -8,15 +8,24 @@ exports.createFeatureSchema = {
     properties: {
         name: {
             type: 'string',
+            example: 'disable-comments',
+            description: 'Unique feature name',
         },
         type: {
             type: 'string',
+            example: 'release',
+            description: "The feature toggle's [type](https://docs.getunleash.io/reference/feature-toggle-types). One of experiment, kill-switch, release, operational, or permission",
         },
         description: {
             type: 'string',
+            nullable: true,
+            example: 'Controls disabling of the comments section in case of an incident',
+            description: 'Detailed description of the feature',
         },
         impressionData: {
             type: 'boolean',
+            example: false,
+            description: '`true` if the impression data collection is enabled for the feature, otherwise `false`.',
         },
     },
     components: {},

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

@@ -1 +1 @@
-{"version":3,"file":"create-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/create-feature-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,SAAS;SAClB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"create-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/create-feature-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,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,SAAS;YAClB,WAAW,EACP,6JAA6J;SACpK;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EACH,mEAAmE;YACvE,WAAW,EAAE,qCAAqC;SACrD;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EACP,yFAAyF;SAChG;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -3,10 +3,11 @@ export declare const createFeatureStrategySchema: {
     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: {
@@ -28,7 +29,7 @@ export declare const createFeatureStrategySchema: {
         };
         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;
@@ -40,6 +41,13 @@ export declare const createFeatureStrategySchema: {
                 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: {
@@ -107,11 +115,64 @@ export declare const createFeatureStrategySchema: {
             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: {};
+            };
         };
     };
 };

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

@@ -3,14 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createFeatureStrategySchema = void 0;
 const parameters_schema_1 = require("./parameters-schema");
 const constraint_schema_1 = require("./constraint-schema");
+const create_strategy_variant_schema_1 = require("./create-strategy-variant-schema");
 exports.createFeatureStrategySchema = {
     $id: '#/components/schemas/createFeatureStrategySchema',
     type: 'object',
     required: ['name'],
+    description: 'Create a strategy configuration in a feature',
     properties: {
         name: {
             type: 'string',
-            description: 'The name or type of strategy',
+            description: 'The name of the strategy type',
             example: 'flexibleRollout',
         },
         title: {
@@ -32,7 +34,7 @@ exports.createFeatureStrategySchema = {
         },
         constraints: {
             type: 'array',
-            description: 'A list of the constraints attached to the strategy',
+            description: 'A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints',
             example: [
                 {
                     values: ['1', '2'],
@@ -46,6 +48,13 @@ exports.createFeatureStrategySchema = {
                 $ref: '#/components/schemas/constraintSchema',
             },
         },
+        variants: {
+            type: 'array',
+            description: 'Strategy level variants',
+            items: {
+                $ref: '#/components/schemas/createStrategyVariantSchema',
+            },
+        },
         parameters: {
             description: 'An object containing the parameters for the strategy',
             example: {
@@ -68,6 +77,7 @@ exports.createFeatureStrategySchema = {
         schemas: {
             constraintSchema: constraint_schema_1.constraintSchema,
             parametersSchema: parameters_schema_1.parametersSchema,
+            createStrategyVariantSchema: create_strategy_variant_schema_1.createStrategyVariantSchema,
         },
     },
 };

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

@@ -1 +1 @@
-{"version":3,"file":"create-feature-strategy-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/create-feature-strategy-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,2DAAuD;AAE1C,QAAA,2BAA2B,GAAG;IACvC,GAAG,EAAE,kDAAkD;IACvD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,8BAA8B;YAC3C,OAAO,EAAE,iBAAiB;SAC7B;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,sCAAsC;YACnD,OAAO,EAAE,yBAAyB;SACrC;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;YACf,WAAW,EACP,oHAAoH;YACxH,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,IAAI;SACjB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,uCAAuC;YACpD,OAAO,EAAE,IAAI;SAChB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,oDAAoD;YACjE,OAAO,EAAE;gBACL;oBACI,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;oBAClB,QAAQ,EAAE,KAAK;oBACf,QAAQ,EAAE,IAAI;oBACd,WAAW,EAAE,SAAS;oBACtB,eAAe,EAAE,KAAK;iBACzB;aACJ;YACD,KAAK,EAAE;gBACH,IAAI,EAAE,uCAAuC;aAChD;SACJ;QACD,UAAU,EAAE;YACR,WAAW,EAAE,sDAAsD;YACnE,OAAO,EAAE;gBACL,OAAO,EAAE,UAAU;gBACnB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,WAAW;aAC1B;YACD,IAAI,EAAE,uCAAuC;SAChD;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,0CAA0C;YACvD,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;SACnB;KACJ;CACK,CAAC"}
+{"version":3,"file":"create-feature-strategy-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/create-feature-strategy-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,2DAAuD;AACvD,qFAA+E;AAElE,QAAA,2BAA2B,GAAG;IACvC,GAAG,EAAE,kDAAkD;IACvD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,WAAW,EAAE,8CAA8C;IAC3D,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,+BAA+B;YAC5C,OAAO,EAAE,iBAAiB;SAC7B;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,sCAAsC;YACnD,OAAO,EAAE,yBAAyB;SACrC;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;YACf,WAAW,EACP,oHAAoH;YACxH,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,IAAI;SACjB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,uCAAuC;YACpD,OAAO,EAAE,IAAI;SAChB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,WAAW,EACP,mHAAmH;YACvH,OAAO,EAAE;gBACL;oBACI,MAAM,EAAE,CAAC,GAAG,EAAE,GAAG,CAAC;oBAClB,QAAQ,EAAE,KAAK;oBACf,QAAQ,EAAE,IAAI;oBACd,WAAW,EAAE,SAAS;oBACtB,eAAe,EAAE,KAAK;iBACzB;aACJ;YACD,KAAK,EAAE;gBACH,IAAI,EAAE,uCAAuC;aAChD;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,yBAAyB;YACtC,KAAK,EAAE;gBACH,IAAI,EAAE,kDAAkD;aAC3D;SACJ;QACD,UAAU,EAAE;YACR,WAAW,EAAE,sDAAsD;YACnE,OAAO,EAAE;gBACL,OAAO,EAAE,UAAU;gBACnB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,WAAW;aAC1B;YACD,IAAI,EAAE,uCAAuC;SAChD;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,0CAA0C;YACvD,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;YAChB,2BAA2B,EAA3B,4DAA2B;SAC9B;KACJ;CACK,CAAC"}

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

@@ -0,0 +1,61 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const createGroupSchema: {
+    readonly $id: "#/components/schemas/createGroupSchema";
+    readonly type: "object";
+    readonly additionalProperties: true;
+    readonly required: readonly ["name"];
+    readonly description: "A detailed information about a user group";
+    readonly properties: {
+        readonly name: {
+            readonly description: "The name of the group";
+            readonly type: "string";
+            readonly example: "DX team";
+        };
+        readonly description: {
+            readonly description: "A custom description of the group";
+            readonly type: "string";
+            readonly nullable: true;
+            readonly example: "Current members of the DX squad";
+        };
+        readonly mappingsSSO: {
+            readonly description: "A list of SSO groups that should map to this Unleash group";
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+            readonly example: readonly ["SSOGroup1", "SSOGroup2"];
+        };
+        readonly rootRole: {
+            readonly type: "number";
+            readonly nullable: true;
+            readonly description: "A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.";
+            readonly example: 1;
+        };
+        readonly users: {
+            readonly type: "array";
+            readonly description: "A list of users belonging to this group";
+            readonly items: {
+                readonly type: "object";
+                readonly description: "A minimal user object";
+                readonly required: readonly ["user"];
+                readonly properties: {
+                    readonly user: {
+                        readonly type: "object";
+                        readonly description: "A minimal user object";
+                        readonly required: readonly ["id"];
+                        readonly properties: {
+                            readonly id: {
+                                readonly description: "The user id";
+                                readonly type: "integer";
+                                readonly minimum: 0;
+                                readonly example: 123;
+                            };
+                        };
+                    };
+                };
+            };
+        };
+    };
+    readonly components: {};
+};
+export declare type CreateGroupSchema = FromSchema<typeof createGroupSchema>;

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createGroupSchema = void 0;
+const group_schema_1 = require("./group-schema");
+exports.createGroupSchema = {
+    $id: '#/components/schemas/createGroupSchema',
+    type: 'object',
+    additionalProperties: true,
+    required: ['name'],
+    description: 'A detailed information about a user group',
+    properties: {
+        name: group_schema_1.groupSchema.properties.name,
+        description: group_schema_1.groupSchema.properties.description,
+        mappingsSSO: group_schema_1.groupSchema.properties.mappingsSSO,
+        rootRole: group_schema_1.groupSchema.properties.rootRole,
+        users: {
+            type: 'array',
+            description: 'A list of users belonging to this group',
+            items: {
+                type: 'object',
+                description: 'A minimal user object',
+                required: ['user'],
+                properties: {
+                    user: {
+                        type: 'object',
+                        description: 'A minimal user object',
+                        required: ['id'],
+                        properties: {
+                            id: {
+                                description: 'The user id',
+                                type: 'integer',
+                                minimum: 0,
+                                example: 123,
+                            },
+                        },
+                    },
+                },
+            },
+        },
+    },
+    components: {},
+};
+//# sourceMappingURL=create-group-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-group-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/create-group-schema.ts"],"names":[],"mappings":";;;AACA,iDAA6C;AAEhC,QAAA,iBAAiB,GAAG;IAC7B,GAAG,EAAE,wCAAwC;IAC7C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,WAAW,EAAE,2CAA2C;IACxD,UAAU,EAAE;QACR,IAAI,EAAE,0BAAW,CAAC,UAAU,CAAC,IAAI;QACjC,WAAW,EAAE,0BAAW,CAAC,UAAU,CAAC,WAAW;QAC/C,WAAW,EAAE,0BAAW,CAAC,UAAU,CAAC,WAAW;QAC/C,QAAQ,EAAE,0BAAW,CAAC,UAAU,CAAC,QAAQ;QACzC,KAAK,EAAE;YACH,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,yCAAyC;YACtD,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,WAAW,EAAE,uBAAuB;gBACpC,QAAQ,EAAE,CAAC,MAAM,CAAC;gBAClB,UAAU,EAAE;oBACR,IAAI,EAAE;wBACF,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,uBAAuB;wBACpC,QAAQ,EAAE,CAAC,IAAI,CAAC;wBAChB,UAAU,EAAE;4BACR,EAAE,EAAE;gCACA,WAAW,EAAE,aAAa;gCAC1B,IAAI,EAAE,SAAS;gCACf,OAAO,EAAE,CAAC;gCACV,OAAO,EAAE,GAAG;6BACf;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -0,0 +1,52 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const createStrategySchema: {
+    readonly $id: "#/components/schemas/createStrategySchema";
+    readonly type: "object";
+    readonly description: "The data required to create a strategy type. Refer to the docs on [custom strategy types](https://docs.getunleash.io/reference/custom-activation-strategies) for more information.";
+    readonly required: readonly ["name", "parameters"];
+    readonly properties: {
+        readonly name: {
+            readonly type: "string";
+            readonly description: "The name of the strategy type. Must be unique.";
+            readonly example: "my-custom-strategy";
+        };
+        readonly description: {
+            readonly type: "string";
+            readonly description: "A description of the strategy type.";
+            readonly example: "Enable the feature for users who have not logged in before.";
+        };
+        readonly parameters: {
+            readonly type: "array";
+            readonly description: "The parameter list lets you pass arguments to your custom activation strategy. These will be made available to your custom strategy implementation.";
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["name", "type"];
+                readonly properties: {
+                    readonly name: {
+                        readonly type: "string";
+                        readonly description: "The name of the parameter";
+                        readonly example: "Rollout percentage";
+                    };
+                    readonly type: {
+                        readonly type: "string";
+                        readonly description: "The [type of the parameter](https://docs.getunleash.io/reference/custom-activation-strategies#parameter-types)";
+                        readonly enum: readonly ["string", "percentage", "list", "number", "boolean"];
+                        readonly example: "percentage";
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly description: "A description of this strategy parameter. Use this to indicate to the users what the parameter does.";
+                        readonly example: "How many percent of users should see this feature?";
+                    };
+                    readonly required: {
+                        readonly type: "boolean";
+                        readonly description: "Whether this parameter must be configured when using the strategy. Defaults to `false`";
+                        readonly example: false;
+                    };
+                };
+            };
+        };
+    };
+    readonly components: {};
+};
+export declare type CreateStrategySchema = FromSchema<typeof createStrategySchema>;

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

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStrategySchema = void 0;
+exports.createStrategySchema = {
+    $id: '#/components/schemas/createStrategySchema',
+    type: 'object',
+    description: 'The data required to create a strategy type. Refer to the docs on [custom strategy types](https://docs.getunleash.io/reference/custom-activation-strategies) for more information.',
+    required: ['name', 'parameters'],
+    properties: {
+        name: {
+            type: 'string',
+            description: 'The name of the strategy type. Must be unique.',
+            example: 'my-custom-strategy',
+        },
+        description: {
+            type: 'string',
+            description: 'A description of the strategy type.',
+            example: 'Enable the feature for users who have not logged in before.',
+        },
+        parameters: {
+            type: 'array',
+            description: 'The parameter list lets you pass arguments to your custom activation strategy. These will be made available to your custom strategy implementation.',
+            items: {
+                type: 'object',
+                required: ['name', 'type'],
+                properties: {
+                    name: {
+                        type: 'string',
+                        description: 'The name of the parameter',
+                        example: 'Rollout percentage',
+                    },
+                    type: {
+                        type: 'string',
+                        description: 'The [type of the parameter](https://docs.getunleash.io/reference/custom-activation-strategies#parameter-types)',
+                        enum: [
+                            'string',
+                            'percentage',
+                            'list',
+                            'number',
+                            'boolean',
+                        ],
+                        example: 'percentage',
+                    },
+                    description: {
+                        type: 'string',
+                        description: 'A description of this strategy parameter. Use this to indicate to the users what the parameter does.',
+                        example: 'How many percent of users should see this feature?',
+                    },
+                    required: {
+                        type: 'boolean',
+                        description: 'Whether this parameter must be configured when using the strategy. Defaults to `false`',
+                        example: false,
+                    },
+                },
+            },
+        },
+    },
+    components: {},
+};
+//# sourceMappingURL=create-strategy-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-strategy-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/create-strategy-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAG;IAChC,GAAG,EAAE,2CAA2C;IAChD,IAAI,EAAE,QAAQ;IACd,WAAW,EACP,oLAAoL;IACxL,QAAQ,EAAE,CAAC,MAAM,EAAE,YAAY,CAAC;IAChC,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,gDAAgD;YAC7D,OAAO,EAAE,oBAAoB;SAChC;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qCAAqC;YAClD,OAAO,EACH,6DAA6D;SACpE;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,WAAW,EACP,qJAAqJ;YACzJ,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;gBAC1B,UAAU,EAAE;oBACR,IAAI,EAAE;wBACF,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,2BAA2B;wBACxC,OAAO,EAAE,oBAAoB;qBAChC;oBACD,IAAI,EAAE;wBACF,IAAI,EAAE,QAAQ;wBACd,WAAW,EACP,gHAAgH;wBACpH,IAAI,EAAE;4BACF,QAAQ;4BACR,YAAY;4BACZ,MAAM;4BACN,QAAQ;4BACR,SAAS;yBACZ;wBACD,OAAO,EAAE,YAAY;qBACxB;oBACD,WAAW,EAAE;wBACT,IAAI,EAAE,QAAQ;wBACd,WAAW,EACP,sGAAsG;wBAC1G,OAAO,EACH,oDAAoD;qBAC3D;oBACD,QAAQ,EAAE;wBACN,IAAI,EAAE,SAAS;wBACf,WAAW,EACP,wFAAwF;wBAC5F,OAAO,EAAE,KAAK;qBACjB;iBACJ;aACJ;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -0,0 +1,54 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const 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: {};
+};
+export declare type CreateStrategyVariantSchema = FromSchema<typeof createStrategyVariantSchema>;

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

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createStrategyVariantSchema = void 0;
+exports.createStrategyVariantSchema = {
+    $id: '#/components/schemas/createStrategyVariantSchema',
+    type: 'object',
+    additionalProperties: true,
+    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.",
+    required: ['name', 'weight', 'weightType', 'stickiness'],
+    properties: {
+        name: {
+            type: 'string',
+            description: 'The variant name. Must be unique for this feature toggle',
+            example: 'blue_group',
+        },
+        weight: {
+            type: 'integer',
+            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',
+            minimum: 0,
+            maximum: 1000,
+        },
+        weightType: {
+            description: 'Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).',
+            type: 'string',
+            example: 'fix',
+            enum: ['variable', 'fix'],
+        },
+        stickiness: {
+            type: 'string',
+            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',
+            example: 'custom.context.field',
+        },
+        payload: {
+            type: 'object',
+            required: ['type', 'value'],
+            description: 'Extra data configured for this variant',
+            properties: {
+                type: {
+                    description: 'The type of the value. Commonly used types are string, json and csv.',
+                    type: 'string',
+                    enum: ['json', 'csv', 'string'],
+                },
+                value: {
+                    description: 'The actual value of payload',
+                    type: 'string',
+                },
+            },
+            example: { type: 'json', value: '{"color": "red"}' },
+        },
+    },
+    components: {},
+};
+//# sourceMappingURL=create-strategy-variant-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"create-strategy-variant-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/create-strategy-variant-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,2BAA2B,GAAG;IACvC,GAAG,EAAE,kDAAkD;IACvD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,WAAW,EACP,kRAAkR;IACtR,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,YAAY,CAAC;IACxD,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,0DAA0D;YAC9D,OAAO,EAAE,YAAY;SACxB;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,SAAS;YACf,WAAW,EACP,gPAAgP;YACpP,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,IAAI;SAChB;QACD,UAAU,EAAE;YACR,WAAW,EACP,kTAAkT;YACtT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,CAAC,UAAU,EAAE,KAAK,CAAC;SAC5B;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,qOAAqO;YACzO,OAAO,EAAE,sBAAsB;SAClC;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;YAC3B,WAAW,EAAE,wCAAwC;YACrD,UAAU,EAAE;gBACR,IAAI,EAAE;oBACF,WAAW,EACP,sEAAsE;oBAC1E,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC;iBAClC;gBACD,KAAK,EAAE;oBACH,WAAW,EAAE,6BAA6B;oBAC1C,IAAI,EAAE,QAAQ;iBACjB;aACJ;YACD,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB,EAAE;SACvD;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -0,0 +1,98 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const createUserResponseSchema: {
+    readonly $id: "#/components/schemas/createUserResponseSchema";
+    readonly type: "object";
+    readonly additionalProperties: false;
+    readonly description: "An Unleash user after creation";
+    readonly required: readonly ["id"];
+    readonly properties: {
+        readonly rootRole: {
+            readonly 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.";
+            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 id: {
+            readonly description: "The user id";
+            readonly type: "integer";
+            readonly minimum: 0;
+            readonly example: 123;
+        };
+        readonly isAPI: {
+            readonly description: "(Deprecated): Used internally to know which operations the user should be allowed to perform";
+            readonly type: "boolean";
+            readonly example: true;
+            readonly deprecated: true;
+        };
+        readonly name: {
+            readonly description: "Name of the user";
+            readonly type: "string";
+            readonly example: "User";
+        };
+        readonly email: {
+            readonly description: "Email of the user";
+            readonly type: "string";
+            readonly example: "user@example.com";
+        };
+        readonly username: {
+            readonly description: "A unique username for the user";
+            readonly type: "string";
+            readonly example: "hunter";
+        };
+        readonly imageUrl: {
+            readonly description: "URL used for the userprofile image";
+            readonly type: "string";
+            readonly example: "https://example.com/242x200.png";
+        };
+        readonly inviteLink: {
+            readonly description: "If the user is actively inviting other users, this is the link that can be shared with other users";
+            readonly type: "string";
+            readonly example: "http://localhost:4242/invite-link/some-secret";
+        };
+        readonly loginAttempts: {
+            readonly description: "How many unsuccessful attempts at logging in has the user made";
+            readonly type: "integer";
+            readonly minimum: 0;
+            readonly example: 3;
+        };
+        readonly emailSent: {
+            readonly description: "Is the welcome email sent to the user or not";
+            readonly type: "boolean";
+            readonly example: false;
+        };
+        readonly seenAt: {
+            readonly description: "The last time this user logged in";
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly nullable: true;
+            readonly example: "2023-06-30T11:42:00.345Z";
+        };
+        readonly createdAt: {
+            readonly description: "The user was created at this time";
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly example: "2023-06-30T11:41:00.123Z";
+        };
+        readonly accountType: {
+            readonly description: "A user is either an actual User or a Service Account";
+            readonly type: "string";
+            readonly enum: readonly ["User", "Service Account"];
+            readonly example: "User";
+        };
+        readonly permissions: {
+            readonly description: "Deprecated";
+            readonly type: "array";
+            readonly items: {
+                readonly type: "string";
+            };
+        };
+    };
+    readonly components: {};
+};
+export declare type CreateUserResponseSchema = FromSchema<typeof createUserResponseSchema>;