unleash-server 5.2.7 → 5.3.0

package/dist/lib/openapi/spec/users-search-schema.d.ts

@@ -11,50 +11,88 @@ export declare const usersSearchSchema: {
                 readonly $id: "#/components/schemas/userSchema";
                 readonly type: "object";
                 readonly additionalProperties: false;
+                readonly description: "An Unleash user";
                 readonly required: readonly ["id"];
                 readonly properties: {
                     readonly id: {
-                        readonly type: "number";
+                        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 type: "number";
+                        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 rootRole: {
-                        readonly type: "number";
+                        readonly description: "Which [root role](https://docs.getunleash.io/reference/rbac#standard-roles) this user is assigned";
+                        readonly type: "integer";
+                        readonly example: 1;
+                        readonly minimum: 0;
                     };
                     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: {};

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

@@ -0,0 +1,16 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const validateFeatureSchema: {
+    readonly $id: "#/components/schemas/validateFeatureSchema";
+    readonly type: "object";
+    readonly required: readonly ["name"];
+    readonly description: "Data used to validate a feature toggle's name.";
+    readonly properties: {
+        readonly name: {
+            readonly description: "The feature name to validate.";
+            readonly type: "string";
+            readonly example: "my-feature-3";
+        };
+    };
+    readonly components: {};
+};
+export declare type ValidateFeatureSchema = FromSchema<typeof validateFeatureSchema>;

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

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateFeatureSchema = void 0;
+exports.validateFeatureSchema = {
+    $id: '#/components/schemas/validateFeatureSchema',
+    type: 'object',
+    required: ['name'],
+    description: "Data used to validate a feature toggle's name.",
+    properties: {
+        name: {
+            description: 'The feature name to validate.',
+            type: 'string',
+            example: 'my-feature-3',
+        },
+    },
+    components: {},
+};
+//# sourceMappingURL=validate-feature-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"validate-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/validate-feature-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,qBAAqB,GAAG;IACjC,GAAG,EAAE,4CAA4C;IACjD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,WAAW,EAAE,gDAAgD;IAC7D,UAAU,EAAE;QACR,IAAI,EAAE;YACF,WAAW,EAAE,+BAA+B;YAC5C,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,cAAc;SAC1B;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

package/dist/lib/openapi/spec/validate-password-schema.d.ts

@@ -4,9 +4,12 @@ export declare const validatePasswordSchema: {
     readonly type: "object";
     readonly additionalProperties: false;
     readonly required: readonly ["password"];
+    readonly description: "Used to validate passwords obeying [Unleash password guidelines](https://docs.getunleash.io/reference/deploy/securing-unleash#password-requirements)";
     readonly properties: {
         readonly password: {
+            readonly description: "The password to validate";
             readonly type: "string";
+            readonly example: "hunter2";
         };
     };
     readonly components: {};

package/dist/lib/openapi/spec/validate-password-schema.js

@@ -6,9 +6,12 @@ exports.validatePasswordSchema = {
     type: 'object',
     additionalProperties: false,
     required: ['password'],
+    description: 'Used to validate passwords obeying [Unleash password guidelines](https://docs.getunleash.io/reference/deploy/securing-unleash#password-requirements)',
     properties: {
         password: {
+            description: 'The password to validate',
             type: 'string',
+            example: 'hunter2',
         },
     },
     components: {},

package/dist/lib/openapi/spec/validate-password-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"validate-password-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/validate-password-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,sBAAsB,GAAG;IAClC,GAAG,EAAE,6CAA6C;IAClD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,CAAC;IACtB,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"validate-password-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/validate-password-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,sBAAsB,GAAG;IAClC,GAAG,EAAE,6CAA6C;IAClD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,CAAC;IACtB,WAAW,EACP,sJAAsJ;IAC1J,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,WAAW,EAAE,0BAA0B;YACvC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,SAAS;SACrB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

package/dist/lib/openapi/spec/validate-tag-type-schema.d.ts

@@ -3,9 +3,12 @@ export declare const validateTagTypeSchema: {
     readonly $id: "#/components/schemas/validateTagTypeSchema";
     readonly type: "object";
     readonly required: readonly ["valid", "tagType"];
+    readonly description: "The result of validating a tag type.";
     readonly properties: {
         readonly valid: {
             readonly type: "boolean";
+            readonly description: "Whether or not the tag type is valid.";
+            readonly example: true;
         };
         readonly tagType: {
             readonly $ref: "#/components/schemas/tagTypeSchema";
@@ -17,17 +20,24 @@ export declare const validateTagTypeSchema: {
                 readonly $id: "#/components/schemas/tagTypeSchema";
                 readonly type: "object";
                 readonly additionalProperties: false;
+                readonly description: "A tag type.";
                 readonly required: readonly ["name"];
                 readonly properties: {
                     readonly name: {
                         readonly type: "string";
+                        readonly description: "The name of the tag type.";
+                        readonly example: "color";
                     };
                     readonly description: {
                         readonly type: "string";
+                        readonly description: "The description of the tag type.";
+                        readonly example: "A tag type for describing the color of a tag.";
                     };
                     readonly icon: {
                         readonly type: "string";
                         readonly nullable: true;
+                        readonly description: "The icon of the tag type.";
+                        readonly example: "not-really-used";
                     };
                 };
                 readonly components: {};

package/dist/lib/openapi/spec/validate-tag-type-schema.js

@@ -6,9 +6,12 @@ exports.validateTagTypeSchema = {
     $id: '#/components/schemas/validateTagTypeSchema',
     type: 'object',
     required: ['valid', 'tagType'],
+    description: 'The result of validating a tag type.',
     properties: {
         valid: {
             type: 'boolean',
+            description: 'Whether or not the tag type is valid.',
+            example: true,
         },
         tagType: {
             $ref: '#/components/schemas/tagTypeSchema',

package/dist/lib/openapi/spec/validate-tag-type-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"validate-tag-type-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/validate-tag-type-schema.ts"],"names":[],"mappings":";;;AACA,uDAAkD;AAErC,QAAA,qBAAqB,GAAG;IACjC,GAAG,EAAE,4CAA4C;IACjD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC;IAC9B,UAAU,EAAE;QACR,KAAK,EAAE;YACH,IAAI,EAAE,SAAS;SAClB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,oCAAoC;SAC7C;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,aAAa,EAAb,+BAAa;SAChB;KACJ;CACK,CAAC"}
+{"version":3,"file":"validate-tag-type-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/validate-tag-type-schema.ts"],"names":[],"mappings":";;;AACA,uDAAkD;AAErC,QAAA,qBAAqB,GAAG;IACjC,GAAG,EAAE,4CAA4C;IACjD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,OAAO,EAAE,SAAS,CAAC;IAC9B,WAAW,EAAE,sCAAsC;IACnD,UAAU,EAAE;QACR,KAAK,EAAE;YACH,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,uCAAuC;YACpD,OAAO,EAAE,IAAI;SAChB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,oCAAoC;SAC7C;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,aAAa,EAAb,+BAAa;SAChB;KACJ;CACK,CAAC"}

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

@@ -3,22 +3,33 @@ export declare const variantFlagSchema: {
     readonly $id: "#/components/schemas/variantFlagSchema";
     readonly type: "object";
     readonly additionalProperties: false;
+    readonly description: "A representation of an evaluated Unleash feature variant.";
     readonly properties: {
         readonly name: {
+            readonly description: "The name of the variant. Will always be disabled if `enabled` is false.";
+            readonly example: "blue";
             readonly type: "string";
         };
         readonly enabled: {
             readonly type: "boolean";
+            readonly description: "Whether the variant is enabled or not.";
+            readonly example: true;
         };
         readonly payload: {
             readonly type: "object";
+            readonly description: "Additional data associated with this variant.";
             readonly additionalProperties: false;
             readonly properties: {
                 readonly type: {
+                    readonly description: "The type of data contained.";
                     readonly type: "string";
+                    readonly enum: readonly ["string", "json", "csv"];
+                    readonly example: "json";
                 };
                 readonly value: {
+                    readonly description: "The actual associated data";
                     readonly type: "string";
+                    readonly example: "{ \"starter\": \"squirtle\" }";
                 };
             };
         };

package/dist/lib/openapi/spec/variant-flag-schema.js

@@ -5,22 +5,33 @@ exports.variantFlagSchema = {
     $id: '#/components/schemas/variantFlagSchema',
     type: 'object',
     additionalProperties: false,
+    description: 'A representation of an evaluated Unleash feature variant.',
     properties: {
         name: {
+            description: 'The name of the variant. Will always be disabled if `enabled` is false.',
+            example: 'blue',
             type: 'string',
         },
         enabled: {
             type: 'boolean',
+            description: 'Whether the variant is enabled or not.',
+            example: true,
         },
         payload: {
             type: 'object',
+            description: 'Additional data associated with this variant.',
             additionalProperties: false,
             properties: {
                 type: {
+                    description: 'The type of data contained.',
                     type: 'string',
+                    enum: ['string', 'json', 'csv'],
+                    example: 'json',
                 },
                 value: {
+                    description: 'The actual associated data',
                     type: 'string',
+                    example: '{ "starter": "squirtle" }',
                 },
             },
         },

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

@@ -1 +1 @@
-{"version":3,"file":"variant-flag-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/variant-flag-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAG;IAC7B,GAAG,EAAE,wCAAwC;IAC7C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;SAClB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACR,IAAI,EAAE;oBACF,IAAI,EAAE,QAAQ;iBACjB;gBACD,KAAK,EAAE;oBACH,IAAI,EAAE,QAAQ;iBACjB;aACJ;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"variant-flag-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/variant-flag-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAG;IAC7B,GAAG,EAAE,wCAAwC;IAC7C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,2DAA2D;IACxE,UAAU,EAAE;QACR,IAAI,EAAE;YACF,WAAW,EACP,yEAAyE;YAC7E,OAAO,EAAE,MAAM;YACf,IAAI,EAAE,QAAQ;SACjB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,wCAAwC;YACrD,OAAO,EAAE,IAAI;SAChB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,+CAA+C;YAC5D,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACR,IAAI,EAAE;oBACF,WAAW,EAAE,6BAA6B;oBAC1C,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC;oBAC/B,OAAO,EAAE,MAAM;iBAClB;gBACD,KAAK,EAAE;oBACH,WAAW,EAAE,4BAA4B;oBACzC,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,2BAA2B;iBACvC;aACJ;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -20,7 +20,8 @@ export declare const variantSchema: {
         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";
@@ -31,17 +32,21 @@ export declare const variantSchema: {
             readonly type: "object";
             readonly required: readonly ["type", "value"];
             readonly description: "Extra data configured for this variant";
+            readonly additionalProperties: false;
             readonly properties: {
                 readonly type: {
+                    readonly description: "The type of the value. Commonly used types are string, json and csv.";
                     readonly type: "string";
+                    readonly enum: readonly ["json", "csv", "string"];
                 };
                 readonly value: {
+                    readonly description: "The actual value of payload";
                     readonly type: "string";
                 };
             };
             readonly example: {
                 readonly type: "json";
-                readonly value: "{color: red}";
+                readonly value: "{\"color\": \"red\"}";
             };
         };
         readonly overrides: {

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

@@ -23,7 +23,8 @@ exports.variantSchema = {
         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',
             type: 'string',
-            example: 'fix',
+            example: 'variable',
+            enum: ['variable', 'fix'],
         },
         stickiness: {
             type: 'string',
@@ -34,15 +35,19 @@ exports.variantSchema = {
             type: 'object',
             required: ['type', 'value'],
             description: 'Extra data configured for this variant',
+            additionalProperties: false,
             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}' },
+            example: { type: 'json', value: '{"color": "red"}' },
         },
         overrides: {
             description: `Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.`,

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

@@ -1 +1 @@
-{"version":3,"file":"variant-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/variant-schema.ts"],"names":[],"mappings":";;;AACA,uDAAmD;AAEtC,QAAA,aAAa,GAAG;IACzB,GAAG,EAAE,oCAAoC;IACzC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,mNAAmN;IACvN,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC5B,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,sDAAsD;YACnE,OAAO,EAAE,YAAY;SACxB;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,8OAA8O;YAClP,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,IAAI;SAChB;QACD,UAAU,EAAE;YACR,WAAW,EACP,mLAAmL;YACvL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,KAAK;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,6KAA6K;YACjL,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,IAAI,EAAE,QAAQ;iBACjB;gBACD,KAAK,EAAE;oBACH,IAAI,EAAE,QAAQ;iBACjB;aACJ;YACD,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,EAAE;SACnD;QACD,SAAS,EAAE;YACP,WAAW,EAAE,4LAA4L;YACzM,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,qCAAqC;aAC9C;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,cAAc,EAAd,gCAAc;SACjB;KACJ;CACK,CAAC"}
+{"version":3,"file":"variant-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/variant-schema.ts"],"names":[],"mappings":";;;AACA,uDAAmD;AAEtC,QAAA,aAAa,GAAG;IACzB,GAAG,EAAE,oCAAoC;IACzC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,mNAAmN;IACvN,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;IAC5B,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,sDAAsD;YACnE,OAAO,EAAE,YAAY;SACxB;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,8OAA8O;YAClP,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,IAAI;SAChB;QACD,UAAU,EAAE;YACR,WAAW,EACP,mLAAmL;YACvL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,UAAU;YACnB,IAAI,EAAE,CAAC,UAAU,EAAE,KAAK,CAAC;SAC5B;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,6KAA6K;YACjL,OAAO,EAAE,sBAAsB;SAClC;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;YAC3B,WAAW,EAAE,wCAAwC;YACrD,oBAAoB,EAAE,KAAK;YAC3B,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;QACD,SAAS,EAAE;YACP,WAAW,EAAE,4LAA4L;YACzM,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,qCAAqC;aAC9C;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,cAAc,EAAd,gCAAc;SACjB;KACJ;CACK,CAAC"}

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

@@ -28,7 +28,8 @@ export declare const variantsSchema: {
                     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";
@@ -39,17 +40,21 @@ export declare const variantsSchema: {
                         readonly type: "object";
                         readonly required: readonly ["type", "value"];
                         readonly description: "Extra data configured for this variant";
+                        readonly additionalProperties: false;
                         readonly properties: {
                             readonly type: {
+                                readonly description: "The type of the value. Commonly used types are string, json and csv.";
                                 readonly type: "string";
+                                readonly enum: readonly ["json", "csv", "string"];
                             };
                             readonly value: {
+                                readonly description: "The actual value of payload";
                                 readonly type: "string";
                             };
                         };
                         readonly example: {
                             readonly type: "json";
-                            readonly value: "{color: red}";
+                            readonly value: "{\"color\": \"red\"}";
                         };
                     };
                     readonly overrides: {

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

@@ -3,16 +3,22 @@ export declare const versionSchema: {
     readonly $id: "#/components/schemas/versionSchema";
     readonly type: "object";
     readonly additionalProperties: false;
-    readonly required: readonly ["current", "latest", "isLatest", "instanceId"];
+    readonly description: "Detailed information about an Unleash version";
+    readonly required: readonly ["current", "latest", "isLatest"];
     readonly properties: {
         readonly current: {
             readonly type: "object";
             readonly additionalProperties: false;
+            readonly description: "The current version of Unleash.";
             readonly properties: {
                 readonly oss: {
+                    readonly description: "The OSS version used when building this Unleash instance, represented as a git revision belonging to the [main Unleash git repo](https://github.com/Unleash/unleash/)";
+                    readonly example: "5.3.0-main";
                     readonly type: "string";
                 };
                 readonly enterprise: {
+                    readonly description: "The Enterpris version of Unleash used to build this instance, represented as a git revision belonging to the [Unleash Enterprise](https://github.com/ivarconr/unleash-enterprise) repository. Will be an empty string if no enterprise version was used,";
+                    readonly example: "5.3.0-main+2105.45ed03c9";
                     readonly type: "string";
                 };
             };
@@ -20,20 +26,29 @@ export declare const versionSchema: {
         readonly latest: {
             readonly type: "object";
             readonly additionalProperties: false;
+            readonly description: "Information about the latest available Unleash releases. Will be an empty object if no data is available.";
             readonly properties: {
                 readonly oss: {
+                    readonly description: "The latest available OSS version of Unleash";
                     readonly type: "string";
+                    readonly example: "5.1.5";
                 };
                 readonly enterprise: {
+                    readonly description: "The latest available Enterprise version of Unleash";
                     readonly type: "string";
+                    readonly example: "5.1.5";
                 };
             };
         };
         readonly isLatest: {
             readonly type: "boolean";
+            readonly description: "Whether the Unleash server is running the latest release (`true`) or if there are updates available (`false`)";
+            readonly example: true;
         };
         readonly instanceId: {
             readonly type: "string";
+            readonly description: "The instance identifier of the Unleash instance";
+            readonly example: "0d652a82-43db-4144-8e02-864b0b030710";
         };
     };
     readonly components: {};

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

@@ -5,16 +5,22 @@ exports.versionSchema = {
     $id: '#/components/schemas/versionSchema',
     type: 'object',
     additionalProperties: false,
-    required: ['current', 'latest', 'isLatest', 'instanceId'],
+    description: 'Detailed information about an Unleash version',
+    required: ['current', 'latest', 'isLatest'],
     properties: {
         current: {
             type: 'object',
             additionalProperties: false,
+            description: 'The current version of Unleash.',
             properties: {
                 oss: {
+                    description: 'The OSS version used when building this Unleash instance, represented as a git revision belonging to the [main Unleash git repo](https://github.com/Unleash/unleash/)',
+                    example: '5.3.0-main',
                     type: 'string',
                 },
                 enterprise: {
+                    description: 'The Enterpris version of Unleash used to build this instance, represented as a git revision belonging to the [Unleash Enterprise](https://github.com/ivarconr/unleash-enterprise) repository. Will be an empty string if no enterprise version was used,',
+                    example: '5.3.0-main+2105.45ed03c9',
                     type: 'string',
                 },
             },
@@ -22,20 +28,29 @@ exports.versionSchema = {
         latest: {
             type: 'object',
             additionalProperties: false,
+            description: 'Information about the latest available Unleash releases. Will be an empty object if no data is available.',
             properties: {
                 oss: {
+                    description: 'The latest available OSS version of Unleash',
                     type: 'string',
+                    example: '5.1.5',
                 },
                 enterprise: {
+                    description: 'The latest available Enterprise version of Unleash',
                     type: 'string',
+                    example: '5.1.5',
                 },
             },
         },
         isLatest: {
             type: 'boolean',
+            description: 'Whether the Unleash server is running the latest release (`true`) or if there are updates available (`false`)',
+            example: true,
         },
         instanceId: {
             type: 'string',
+            description: 'The instance identifier of the Unleash instance',
+            example: '0d652a82-43db-4144-8e02-864b0b030710',
         },
     },
     components: {},

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

@@ -1 +1 @@
-{"version":3,"file":"version-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/version-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,aAAa,GAAG;IACzB,GAAG,EAAE,oCAAoC;IACzC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,CAAC;IACzD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACR,GAAG,EAAE;oBACD,IAAI,EAAE,QAAQ;iBACjB;gBACD,UAAU,EAAE;oBACR,IAAI,EAAE,QAAQ;iBACjB;aACJ;SACJ;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACR,GAAG,EAAE;oBACD,IAAI,EAAE,QAAQ;iBACjB;gBACD,UAAU,EAAE;oBACR,IAAI,EAAE,QAAQ;iBACjB;aACJ;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;SAClB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;SACjB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"version-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/version-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,aAAa,GAAG;IACzB,GAAG,EAAE,oCAAoC;IACzC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,+CAA+C;IAC5D,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC;IAC3C,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,WAAW,EAAE,iCAAiC;YAC9C,UAAU,EAAE;gBACR,GAAG,EAAE;oBACD,WAAW,EACP,uKAAuK;oBAC3K,OAAO,EAAE,YAAY;oBACrB,IAAI,EAAE,QAAQ;iBACjB;gBACD,UAAU,EAAE;oBACR,WAAW,EACP,0PAA0P;oBAC9P,OAAO,EAAE,0BAA0B;oBACnC,IAAI,EAAE,QAAQ;iBACjB;aACJ;SACJ;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,WAAW,EACP,2GAA2G;YAC/G,UAAU,EAAE;gBACR,GAAG,EAAE;oBACD,WAAW,EAAE,6CAA6C;oBAC1D,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,OAAO;iBACnB;gBACD,UAAU,EAAE;oBACR,WAAW,EACP,oDAAoD;oBACxD,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,OAAO;iBACnB;aACJ;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;YACf,WAAW,EACP,+GAA+G;YACnH,OAAO,EAAE,IAAI;SAChB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,iDAAiD;YAC9D,OAAO,EAAE,sCAAsC;SAClD;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

package/dist/lib/openapi/util/openapi-tags.d.ts

@@ -3,7 +3,7 @@ declare const OPENAPI_TAGS: readonly [{
     readonly description: "Create, update, and delete [Unleash addons](https://docs.getunleash.io/addons).";
 }, {
     readonly name: "Admin UI";
-    readonly description: "Configure the Unleash Admin UI. Why did you enable an experimental feature?";
+    readonly description: "Configuration for the Unleash Admin UI. These endpoints should not be relied upon and can change at any point without prior notice.";
 }, {
     readonly name: "API tokens";
     readonly description: "Create, update, and delete [Unleash API tokens](https://docs.getunleash.io/reference/api-tokens-and-client-keys).";
@@ -82,13 +82,19 @@ declare const OPENAPI_TAGS: readonly [{
 }, {
     readonly name: "Change Requests";
     readonly description: "API for managing [change requests](https://docs.getunleash.io/reference/change-requests).";
+}, {
+    readonly name: "Telemetry";
+    readonly description: "API for information about telemetry collection";
+}, {
+    readonly name: "Notifications";
+    readonly description: "API for managing [notifications](https://docs.getunleash.io/reference/notifications).";
 }];
 export declare const openApiTags: ({
     readonly name: "Addons";
     readonly description: "Create, update, and delete [Unleash addons](https://docs.getunleash.io/addons).";
 } | {
     readonly name: "Admin UI";
-    readonly description: "Configure the Unleash Admin UI. Why did you enable an experimental feature?";
+    readonly description: "Configuration for the Unleash Admin UI. These endpoints should not be relied upon and can change at any point without prior notice.";
 } | {
     readonly name: "API tokens";
     readonly description: "Create, update, and delete [Unleash API tokens](https://docs.getunleash.io/reference/api-tokens-and-client-keys).";
@@ -167,6 +173,12 @@ export declare const openApiTags: ({
 } | {
     readonly name: "Change Requests";
     readonly description: "API for managing [change requests](https://docs.getunleash.io/reference/change-requests).";
+} | {
+    readonly name: "Telemetry";
+    readonly description: "API for information about telemetry collection";
+} | {
+    readonly name: "Notifications";
+    readonly description: "API for managing [notifications](https://docs.getunleash.io/reference/notifications).";
 })[];
 export declare type OpenApiTag = typeof OPENAPI_TAGS[number]['name'];
 export {};

package/dist/lib/openapi/util/openapi-tags.js

@@ -11,7 +11,7 @@ const OPENAPI_TAGS = [
     },
     {
         name: 'Admin UI',
-        description: 'Configure the Unleash Admin UI. Why did you enable an experimental feature?',
+        description: 'Configuration for the Unleash Admin UI. These endpoints should not be relied upon and can change at any point without prior notice.',
     },
     {
         name: 'API tokens',
@@ -105,6 +105,14 @@ const OPENAPI_TAGS = [
         name: 'Change Requests',
         description: 'API for managing [change requests](https://docs.getunleash.io/reference/change-requests).',
     },
+    {
+        name: 'Telemetry',
+        description: 'API for information about telemetry collection',
+    },
+    {
+        name: 'Notifications',
+        description: 'API for managing [notifications](https://docs.getunleash.io/reference/notifications).',
+    },
 ];
 // make the export mutable, so it can be used in a schema
 exports.openApiTags = [...OPENAPI_TAGS].sort((a, b) => a.name.localeCompare(b.name));

package/dist/lib/openapi/util/openapi-tags.js.map

@@ -1 +1 @@
-{"version":3,"file":"openapi-tags.js","sourceRoot":"","sources":["../../../../src/lib/openapi/util/openapi-tags.ts"],"names":[],"mappings":";;;AAAA,+EAA+E;AAC/E,8EAA8E;AAC9E,2BAA2B;AAC3B,MAAM,YAAY,GAAG;IACjB;QACI,IAAI,EAAE,QAAQ;QACd,WAAW,EACP,iFAAiF;KACxF;IACD;QACI,IAAI,EAAE,UAAU;QAChB,WAAW,EACP,6EAA6E;KACpF;IACD;QACI,IAAI,EAAE,YAAY;QAClB,WAAW,EACP,mHAAmH;KAC1H;IACD;QACI,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EACP,8IAA8I;KACrJ;IACD;QACI,IAAI,EAAE,kBAAkB;QACxB,WAAW,EACP,wJAAwJ;KAC/J;IACD;QACI,IAAI,EAAE,SAAS;QACf,WAAW,EACP,gHAAgH;KACvH;IACD,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,gCAAgC,EAAE;IAC/D;QACI,IAAI,EAAE,QAAQ;QACd,WAAW,EACP,yFAAyF;KAChG;IACD;QACI,IAAI,EAAE,SAAS;QACf,WAAW,EACP,6HAA6H;KACpI;IACD;QACI,IAAI,EAAE,cAAc;QACpB,WAAW,EACP,wIAAwI;KAC/I;IACD,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,yCAAyC,EAAE;IAC1E;QACI,IAAI,EAAE,UAAU;QAChB,WAAW,EACP,sGAAsG;KAC7G;IACD;QACI,IAAI,EAAE,eAAe;QACrB,WAAW,EACP,0GAA0G;KACjH;IACD;QACI,IAAI,EAAE,gBAAgB;QACtB,WAAW,EACP,sEAAsE;KAC7E;IACD;QACI,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,wDAAwD;KACxE;IACD;QACI,IAAI,EAAE,aAAa;QACnB,WAAW,EACP,uEAAuE;KAC9E;IACD;QACI,IAAI,EAAE,YAAY;QAClB,WAAW,EACP,2DAA2D;KAClE;IACD;QACI,IAAI,EAAE,UAAU;QAChB,WAAW,EACP,+FAA+F;KACtG;IACD;QACI,IAAI,EAAE,sBAAsB;QAC5B,WAAW,EACP,uHAAuH;KAC9H;IACD;QACI,IAAI,EAAE,UAAU;QAChB,WAAW,EACP,+FAA+F;KACtG;IACD;QACI,IAAI,EAAE,YAAY;QAClB,WAAW,EACP,wHAAwH;KAC/H;IACD;QACI,IAAI,EAAE,MAAM;QACZ,WAAW,EACP,6FAA6F;KACpG;IACD,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,6BAA6B,EAAE;IAC7D;QACI,IAAI,EAAE,UAAU;QAChB,WAAW,EACP,kEAAkE;KACzE;IACD,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,2CAA2C,EAAE;IAC1E;QACI,IAAI,EAAE,cAAc;QACpB,WAAW,EACP,oEAAoE;KAC3E;IACD;QACI,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,iDAAiD;KACjE;IACD;QACI,IAAI,EAAE,iBAAiB;QACvB,WAAW,EACP,2FAA2F;KAClG;CACK,CAAC;AAEX,yDAAyD;AAC5C,QAAA,WAAW,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACvD,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAC/B,CAAC"}
+{"version":3,"file":"openapi-tags.js","sourceRoot":"","sources":["../../../../src/lib/openapi/util/openapi-tags.ts"],"names":[],"mappings":";;;AAAA,+EAA+E;AAC/E,8EAA8E;AAC9E,2BAA2B;AAC3B,MAAM,YAAY,GAAG;IACjB;QACI,IAAI,EAAE,QAAQ;QACd,WAAW,EACP,iFAAiF;KACxF;IACD;QACI,IAAI,EAAE,UAAU;QAChB,WAAW,EACP,qIAAqI;KAC5I;IACD;QACI,IAAI,EAAE,YAAY;QAClB,WAAW,EACP,mHAAmH;KAC1H;IACD;QACI,IAAI,EAAE,wBAAwB;QAC9B,WAAW,EACP,8IAA8I;KACrJ;IACD;QACI,IAAI,EAAE,kBAAkB;QACxB,WAAW,EACP,wJAAwJ;KAC/J;IACD;QACI,IAAI,EAAE,SAAS;QACf,WAAW,EACP,gHAAgH;KACvH;IACD,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,gCAAgC,EAAE;IAC/D;QACI,IAAI,EAAE,QAAQ;QACd,WAAW,EACP,yFAAyF;KAChG;IACD;QACI,IAAI,EAAE,SAAS;QACf,WAAW,EACP,6HAA6H;KACpI;IACD;QACI,IAAI,EAAE,cAAc;QACpB,WAAW,EACP,wIAAwI;KAC/I;IACD,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,yCAAyC,EAAE;IAC1E;QACI,IAAI,EAAE,UAAU;QAChB,WAAW,EACP,sGAAsG;KAC7G;IACD;QACI,IAAI,EAAE,eAAe;QACrB,WAAW,EACP,0GAA0G;KACjH;IACD;QACI,IAAI,EAAE,gBAAgB;QACtB,WAAW,EACP,sEAAsE;KAC7E;IACD;QACI,IAAI,EAAE,SAAS;QACf,WAAW,EAAE,wDAAwD;KACxE;IACD;QACI,IAAI,EAAE,aAAa;QACnB,WAAW,EACP,uEAAuE;KAC9E;IACD;QACI,IAAI,EAAE,YAAY;QAClB,WAAW,EACP,2DAA2D;KAClE;IACD;QACI,IAAI,EAAE,UAAU;QAChB,WAAW,EACP,+FAA+F;KACtG;IACD;QACI,IAAI,EAAE,sBAAsB;QAC5B,WAAW,EACP,uHAAuH;KAC9H;IACD;QACI,IAAI,EAAE,UAAU;QAChB,WAAW,EACP,+FAA+F;KACtG;IACD;QACI,IAAI,EAAE,YAAY;QAClB,WAAW,EACP,wHAAwH;KAC/H;IACD;QACI,IAAI,EAAE,MAAM;QACZ,WAAW,EACP,6FAA6F;KACpG;IACD,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,6BAA6B,EAAE;IAC7D;QACI,IAAI,EAAE,UAAU;QAChB,WAAW,EACP,kEAAkE;KACzE;IACD,EAAE,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,2CAA2C,EAAE;IAC1E;QACI,IAAI,EAAE,cAAc;QACpB,WAAW,EACP,oEAAoE;KAC3E;IACD;QACI,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,iDAAiD;KACjE;IACD;QACI,IAAI,EAAE,iBAAiB;QACvB,WAAW,EACP,2FAA2F;KAClG;IACD;QACI,IAAI,EAAE,WAAW;QACjB,WAAW,EAAE,gDAAgD;KAChE;IACD;QACI,IAAI,EAAE,eAAe;QACrB,WAAW,EACP,uFAAuF;KAC9F;CACK,CAAC;AAEX,yDAAyD;AAC5C,QAAA,WAAW,GAAG,CAAC,GAAG,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACvD,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAC/B,CAAC"}

package/dist/lib/openapi/util/standard-responses.d.ts

@@ -57,7 +57,7 @@ declare const standardResponses: {
         };
     };
     readonly 403: {
-        readonly description: "User credentials are valid but does not have enough privileges to execute this operation";
+        readonly description: "The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation";
         readonly content: {
             readonly 'application/json': {
                 readonly schema: {

package/dist/lib/openapi/util/standard-responses.js

@@ -32,7 +32,7 @@ const unauthorizedResponse = {
     },
 };
 const forbiddenResponse = {
-    description: 'User credentials are valid but does not have enough privileges to execute this operation',
+    description: 'The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation',
     content: {
         'application/json': {
             schema: {