unleash-server 5.2.7 → 5.3.0

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

@@ -3,22 +3,27 @@ export declare const profileSchema: {
     readonly $id: "#/components/schemas/profileSchema";
     readonly type: "object";
     readonly additionalProperties: false;
+    readonly description: "User profile overview";
     readonly required: readonly ["rootRole", "projects", "features"];
     readonly properties: {
         readonly rootRole: {
             readonly $ref: "#/components/schemas/roleSchema";
         };
         readonly projects: {
+            readonly description: "Which projects this user is a member of";
             readonly type: "array";
             readonly items: {
                 readonly type: "string";
             };
+            readonly example: readonly ["my-projectA", "my-projectB"];
         };
         readonly features: {
+            readonly description: "Deprecated, always returns empty array";
             readonly type: "array";
             readonly items: {
                 readonly $ref: "#/components/schemas/featureSchema";
             };
+            readonly example: readonly [];
         };
     };
     readonly components: {
@@ -28,6 +33,7 @@ export declare const profileSchema: {
                 readonly type: "object";
                 readonly additionalProperties: false;
                 readonly required: readonly ["name"];
+                readonly description: "A feature toggle definition";
                 readonly properties: {
                     readonly name: {
                         readonly type: "string";
@@ -58,6 +64,7 @@ export declare const profileSchema: {
                     readonly enabled: {
                         readonly type: "boolean";
                         readonly example: true;
+                        readonly description: "`true` if the feature is enabled, otherwise `false`.";
                     };
                     readonly stale: {
                         readonly type: "boolean";
@@ -79,18 +86,21 @@ export declare const profileSchema: {
                         readonly format: "date-time";
                         readonly nullable: true;
                         readonly example: "2023-01-28T15:21:39.975Z";
+                        readonly description: "The date the feature was created";
                     };
                     readonly archivedAt: {
                         readonly type: "string";
                         readonly format: "date-time";
                         readonly nullable: true;
                         readonly example: "2023-01-29T15:21:39.975Z";
+                        readonly description: "The date the feature was archived";
                     };
                     readonly lastSeenAt: {
                         readonly type: "string";
                         readonly format: "date-time";
                         readonly nullable: true;
                         readonly example: "2023-01-28T16:21:39.975Z";
+                        readonly description: "The date when metrics where last collected for the feature";
                     };
                     readonly environments: {
                         readonly type: "array";
@@ -185,9 +195,12 @@ export declare const profileSchema: {
                                 readonly featureName: {
                                     readonly type: "string";
                                     readonly example: "disable-comments";
+                                    readonly description: "The name of the feature";
                                 };
                                 readonly environment: {
                                     readonly type: "string";
+                                    readonly example: "development";
+                                    readonly description: "The name of the environment";
                                 };
                                 readonly type: {
                                     readonly type: "string";
@@ -206,6 +219,7 @@ export declare const profileSchema: {
                                 };
                                 readonly variantCount: {
                                     readonly type: "number";
+                                    readonly description: "The number of defined variants";
                                 };
                                 readonly strategies: {
                                     readonly type: "array";
@@ -271,6 +285,7 @@ export declare const profileSchema: {
                                     readonly parametersSchema: {
                                         readonly $id: "#/components/schemas/parametersSchema";
                                         readonly type: "object";
+                                        readonly description: "A list of parameters for a strategy";
                                         readonly additionalProperties: {
                                             readonly type: "string";
                                         };
@@ -325,11 +340,18 @@ export declare const profileSchema: {
                                             };
                                             readonly constraints: {
                                                 readonly type: "array";
-                                                readonly description: "A list of the constraints attached to the strategy";
+                                                readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
                                                 readonly items: {
                                                     readonly $ref: "#/components/schemas/constraintSchema";
                                                 };
                                             };
+                                            readonly variants: {
+                                                readonly type: "array";
+                                                readonly description: "Strategy level variants";
+                                                readonly items: {
+                                                    readonly $ref: "#/components/schemas/strategyVariantSchema";
+                                                };
+                                            };
                                             readonly parameters: {
                                                 readonly $ref: "#/components/schemas/parametersSchema";
                                             };
@@ -383,13 +405,118 @@ export declare const profileSchema: {
                                                 readonly parametersSchema: {
                                                     readonly $id: "#/components/schemas/parametersSchema";
                                                     readonly type: "object";
+                                                    readonly description: "A list of parameters for a strategy";
                                                     readonly additionalProperties: {
                                                         readonly type: "string";
                                                     };
                                                     readonly components: {};
                                                 };
+                                                readonly strategyVariantSchema: {
+                                                    readonly $id: "#/components/schemas/strategyVariantSchema";
+                                                    readonly type: "object";
+                                                    readonly additionalProperties: false;
+                                                    readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
+                                                    readonly required: readonly ["name", "weight", "weightType", "stickiness"];
+                                                    readonly properties: {
+                                                        readonly name: {
+                                                            readonly type: "string";
+                                                            readonly description: "The variant name. Must be unique for this feature toggle";
+                                                            readonly example: "blue_group";
+                                                        };
+                                                        readonly weight: {
+                                                            readonly type: "integer";
+                                                            readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
+                                                            readonly minimum: 0;
+                                                            readonly maximum: 1000;
+                                                        };
+                                                        readonly weightType: {
+                                                            readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
+                                                            readonly type: "string";
+                                                            readonly example: "fix";
+                                                            readonly enum: readonly ["variable", "fix"];
+                                                        };
+                                                        readonly stickiness: {
+                                                            readonly type: "string";
+                                                            readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
+                                                            readonly example: "custom.context.field";
+                                                        };
+                                                        readonly payload: {
+                                                            readonly type: "object";
+                                                            readonly required: readonly ["type", "value"];
+                                                            readonly description: "Extra data configured for this variant";
+                                                            readonly properties: {
+                                                                readonly type: {
+                                                                    readonly description: "The type of the value. Commonly used types are string, json and csv.";
+                                                                    readonly type: "string";
+                                                                    readonly enum: readonly ["json", "csv", "string"];
+                                                                };
+                                                                readonly value: {
+                                                                    readonly description: "The actual value of payload";
+                                                                    readonly type: "string";
+                                                                };
+                                                            };
+                                                            readonly example: {
+                                                                readonly type: "json";
+                                                                readonly value: "{\"color\": \"red\"}";
+                                                            };
+                                                        };
+                                                    };
+                                                    readonly components: {};
+                                                };
+                                            };
+                                        };
+                                    };
+                                    readonly strategyVariantSchema: {
+                                        readonly $id: "#/components/schemas/strategyVariantSchema";
+                                        readonly type: "object";
+                                        readonly additionalProperties: false;
+                                        readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
+                                        readonly required: readonly ["name", "weight", "weightType", "stickiness"];
+                                        readonly properties: {
+                                            readonly name: {
+                                                readonly type: "string";
+                                                readonly description: "The variant name. Must be unique for this feature toggle";
+                                                readonly example: "blue_group";
+                                            };
+                                            readonly weight: {
+                                                readonly type: "integer";
+                                                readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
+                                                readonly minimum: 0;
+                                                readonly maximum: 1000;
+                                            };
+                                            readonly weightType: {
+                                                readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
+                                                readonly type: "string";
+                                                readonly example: "fix";
+                                                readonly enum: readonly ["variable", "fix"];
+                                            };
+                                            readonly stickiness: {
+                                                readonly type: "string";
+                                                readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
+                                                readonly example: "custom.context.field";
+                                            };
+                                            readonly payload: {
+                                                readonly type: "object";
+                                                readonly required: readonly ["type", "value"];
+                                                readonly description: "Extra data configured for this variant";
+                                                readonly properties: {
+                                                    readonly type: {
+                                                        readonly description: "The type of the value. Commonly used types are string, json and csv.";
+                                                        readonly type: "string";
+                                                        readonly enum: readonly ["json", "csv", "string"];
+                                                    };
+                                                    readonly value: {
+                                                        readonly description: "The actual value of payload";
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                                readonly example: {
+                                                    readonly type: "json";
+                                                    readonly value: "{\"color\": \"red\"}";
+                                                };
                                             };
                                         };
+                                        readonly components: {};
                                     };
                                     readonly variantSchema: {
                                         readonly $id: "#/components/schemas/variantSchema";
@@ -412,7 +539,8 @@ export declare const profileSchema: {
                                             readonly weightType: {
                                                 readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
                                                 readonly type: "string";
-                                                readonly example: "fix";
+                                                readonly example: "variable";
+                                                readonly enum: readonly ["variable", "fix"];
                                             };
                                             readonly stickiness: {
                                                 readonly type: "string";
@@ -423,17 +551,21 @@ export declare const profileSchema: {
                                                 readonly type: "object";
                                                 readonly required: readonly ["type", "value"];
                                                 readonly description: "Extra data configured for this variant";
+                                                readonly additionalProperties: false;
                                                 readonly properties: {
                                                     readonly type: {
+                                                        readonly description: "The type of the value. Commonly used types are string, json and csv.";
                                                         readonly type: "string";
+                                                        readonly enum: readonly ["json", "csv", "string"];
                                                     };
                                                     readonly value: {
+                                                        readonly description: "The actual value of payload";
                                                         readonly type: "string";
                                                     };
                                                 };
                                                 readonly example: {
                                                     readonly type: "json";
-                                                    readonly value: "{color: red}";
+                                                    readonly value: "{\"color\": \"red\"}";
                                                 };
                                             };
                                             readonly overrides: {
@@ -524,11 +656,18 @@ export declare const profileSchema: {
                                 };
                                 readonly constraints: {
                                     readonly type: "array";
-                                    readonly description: "A list of the constraints attached to the strategy";
+                                    readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
                                     readonly items: {
                                         readonly $ref: "#/components/schemas/constraintSchema";
                                     };
                                 };
+                                readonly variants: {
+                                    readonly type: "array";
+                                    readonly description: "Strategy level variants";
+                                    readonly items: {
+                                        readonly $ref: "#/components/schemas/strategyVariantSchema";
+                                    };
+                                };
                                 readonly parameters: {
                                     readonly $ref: "#/components/schemas/parametersSchema";
                                 };
@@ -582,14 +721,119 @@ export declare const profileSchema: {
                                     readonly parametersSchema: {
                                         readonly $id: "#/components/schemas/parametersSchema";
                                         readonly type: "object";
+                                        readonly description: "A list of parameters for a strategy";
                                         readonly additionalProperties: {
                                             readonly type: "string";
                                         };
                                         readonly components: {};
                                     };
+                                    readonly strategyVariantSchema: {
+                                        readonly $id: "#/components/schemas/strategyVariantSchema";
+                                        readonly type: "object";
+                                        readonly additionalProperties: false;
+                                        readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
+                                        readonly required: readonly ["name", "weight", "weightType", "stickiness"];
+                                        readonly properties: {
+                                            readonly name: {
+                                                readonly type: "string";
+                                                readonly description: "The variant name. Must be unique for this feature toggle";
+                                                readonly example: "blue_group";
+                                            };
+                                            readonly weight: {
+                                                readonly type: "integer";
+                                                readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
+                                                readonly minimum: 0;
+                                                readonly maximum: 1000;
+                                            };
+                                            readonly weightType: {
+                                                readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
+                                                readonly type: "string";
+                                                readonly example: "fix";
+                                                readonly enum: readonly ["variable", "fix"];
+                                            };
+                                            readonly stickiness: {
+                                                readonly type: "string";
+                                                readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
+                                                readonly example: "custom.context.field";
+                                            };
+                                            readonly payload: {
+                                                readonly type: "object";
+                                                readonly required: readonly ["type", "value"];
+                                                readonly description: "Extra data configured for this variant";
+                                                readonly properties: {
+                                                    readonly type: {
+                                                        readonly description: "The type of the value. Commonly used types are string, json and csv.";
+                                                        readonly type: "string";
+                                                        readonly enum: readonly ["json", "csv", "string"];
+                                                    };
+                                                    readonly value: {
+                                                        readonly description: "The actual value of payload";
+                                                        readonly type: "string";
+                                                    };
+                                                };
+                                                readonly example: {
+                                                    readonly type: "json";
+                                                    readonly value: "{\"color\": \"red\"}";
+                                                };
+                                            };
+                                        };
+                                        readonly components: {};
+                                    };
                                 };
                             };
                         };
+                        readonly strategyVariantSchema: {
+                            readonly $id: "#/components/schemas/strategyVariantSchema";
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
+                            readonly required: readonly ["name", "weight", "weightType", "stickiness"];
+                            readonly properties: {
+                                readonly name: {
+                                    readonly type: "string";
+                                    readonly description: "The variant name. Must be unique for this feature toggle";
+                                    readonly example: "blue_group";
+                                };
+                                readonly weight: {
+                                    readonly type: "integer";
+                                    readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
+                                    readonly minimum: 0;
+                                    readonly maximum: 1000;
+                                };
+                                readonly weightType: {
+                                    readonly description: "Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
+                                    readonly type: "string";
+                                    readonly example: "fix";
+                                    readonly enum: readonly ["variable", "fix"];
+                                };
+                                readonly stickiness: {
+                                    readonly type: "string";
+                                    readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time";
+                                    readonly example: "custom.context.field";
+                                };
+                                readonly payload: {
+                                    readonly type: "object";
+                                    readonly required: readonly ["type", "value"];
+                                    readonly description: "Extra data configured for this variant";
+                                    readonly properties: {
+                                        readonly type: {
+                                            readonly description: "The type of the value. Commonly used types are string, json and csv.";
+                                            readonly type: "string";
+                                            readonly enum: readonly ["json", "csv", "string"];
+                                        };
+                                        readonly value: {
+                                            readonly description: "The actual value of payload";
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly example: {
+                                        readonly type: "json";
+                                        readonly value: "{\"color\": \"red\"}";
+                                    };
+                                };
+                            };
+                            readonly components: {};
+                        };
                         readonly overrideSchema: {
                             readonly $id: "#/components/schemas/overrideSchema";
                             readonly type: "object";
@@ -616,6 +860,7 @@ export declare const profileSchema: {
                         readonly parametersSchema: {
                             readonly $id: "#/components/schemas/parametersSchema";
                             readonly type: "object";
+                            readonly description: "A list of parameters for a strategy";
                             readonly additionalProperties: {
                                 readonly type: "string";
                             };
@@ -642,7 +887,8 @@ export declare const profileSchema: {
                                 readonly weightType: {
                                     readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
                                     readonly type: "string";
-                                    readonly example: "fix";
+                                    readonly example: "variable";
+                                    readonly enum: readonly ["variable", "fix"];
                                 };
                                 readonly stickiness: {
                                     readonly type: "string";
@@ -653,17 +899,21 @@ export declare const profileSchema: {
                                     readonly type: "object";
                                     readonly required: readonly ["type", "value"];
                                     readonly description: "Extra data configured for this variant";
+                                    readonly additionalProperties: false;
                                     readonly properties: {
                                         readonly type: {
+                                            readonly description: "The type of the value. Commonly used types are string, json and csv.";
                                             readonly type: "string";
+                                            readonly enum: readonly ["json", "csv", "string"];
                                         };
                                         readonly value: {
+                                            readonly description: "The actual value of payload";
                                             readonly type: "string";
                                         };
                                     };
                                     readonly example: {
                                         readonly type: "json";
-                                        readonly value: "{color: red}";
+                                        readonly value: "{\"color\": \"red\"}";
                                     };
                                 };
                                 readonly overrides: {
@@ -733,20 +983,30 @@ export declare const profileSchema: {
             readonly roleSchema: {
                 readonly $id: "#/components/schemas/roleSchema";
                 readonly type: "object";
+                readonly description: "A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform";
                 readonly additionalProperties: false;
                 readonly required: readonly ["id", "type", "name"];
                 readonly properties: {
                     readonly id: {
-                        readonly type: "number";
+                        readonly type: "integer";
+                        readonly description: "The role id";
+                        readonly example: 9;
+                        readonly minimum: 0;
                     };
                     readonly type: {
+                        readonly description: "A role can either be a global root role (applies to all projects) or a project role";
                         readonly type: "string";
+                        readonly example: "root";
                     };
                     readonly name: {
+                        readonly description: "The name of the role";
                         readonly type: "string";
+                        readonly example: "Editor";
                     };
                     readonly description: {
+                        readonly description: "A more detailed description of the role and what use it's intended for";
                         readonly type: "string";
+                        readonly example: "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.";
                     };
                 };
                 readonly components: {};

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

@@ -7,22 +7,27 @@ exports.profileSchema = {
     $id: '#/components/schemas/profileSchema',
     type: 'object',
     additionalProperties: false,
+    description: 'User profile overview',
     required: ['rootRole', 'projects', 'features'],
     properties: {
         rootRole: {
             $ref: '#/components/schemas/roleSchema',
         },
         projects: {
+            description: 'Which projects this user is a member of',
             type: 'array',
             items: {
                 type: 'string',
             },
+            example: ['my-projectA', 'my-projectB'],
         },
         features: {
+            description: 'Deprecated, always returns empty array',
             type: 'array',
             items: {
                 $ref: '#/components/schemas/featureSchema',
             },
+            example: [],
         },
     },
     components: {

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

@@ -1 +1 @@
-{"version":3,"file":"profile-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/profile-schema.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AACjD,+CAA2C;AAE9B,QAAA,aAAa,GAAG;IACzB,GAAG,EAAE,oCAAoC;IACzC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC;IAC9C,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,IAAI,EAAE,iCAAiC;SAC1C;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,aAAa,EAAb,8BAAa;YACb,UAAU,EAAV,wBAAU;SACb;KACJ;CACK,CAAC"}
+{"version":3,"file":"profile-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/profile-schema.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AACjD,+CAA2C;AAE9B,QAAA,aAAa,GAAG;IACzB,GAAG,EAAE,oCAAoC;IACzC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,uBAAuB;IACpC,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,UAAU,CAAC;IAC9C,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,IAAI,EAAE,iCAAiC;SAC1C;QACD,QAAQ,EAAE;YACN,WAAW,EAAE,yCAAyC;YACtD,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;YACD,OAAO,EAAE,CAAC,aAAa,EAAE,aAAa,CAAC;SAC1C;QACD,QAAQ,EAAE;YACN,WAAW,EAAE,wCAAwC;YACrD,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;YACD,OAAO,EAAE,EAAE;SACd;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,aAAa,EAAb,8BAAa;YACb,UAAU,EAAV,wBAAU;SACb;KACJ;CACK,CAAC"}