unleash-server 5.2.7 → 5.3.0

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

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateStrategySchema = void 0;
+exports.updateStrategySchema = {
+    $id: '#/components/schemas/updateStrategySchema',
+    type: 'object',
+    description: 'The data required to update a strategy type.',
+    required: ['parameters'],
+    properties: {
+        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=update-strategy-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"update-strategy-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-strategy-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAG;IAChC,GAAG,EAAE,2CAA2C;IAChD,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,8CAA8C;IAC3D,QAAQ,EAAE,CAAC,YAAY,CAAC;IACxB,UAAU,EAAE;QACR,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/update-tag-type-schema.d.ts

@@ -2,12 +2,17 @@ import { FromSchema } from 'json-schema-to-ts';
 export declare const updateTagTypeSchema: {
     readonly $id: "#/components/schemas/updateTagTypeSchema";
     readonly type: "object";
+    readonly description: "The request body for updating a tag type.";
     readonly properties: {
         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 description: "The icon of the tag type.";
+            readonly example: "not-really-used";
         };
     };
     readonly components: {};

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

@@ -4,12 +4,17 @@ exports.updateTagTypeSchema = void 0;
 exports.updateTagTypeSchema = {
     $id: '#/components/schemas/updateTagTypeSchema',
     type: 'object',
+    description: 'The request body for updating a tag type.',
     properties: {
         description: {
             type: 'string',
+            description: 'The description of the tag type.',
+            example: 'A tag type for describing the color of a tag.',
         },
         icon: {
             type: 'string',
+            description: 'The icon of the tag type.',
+            example: 'not-really-used',
         },
     },
     components: {},

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

@@ -1 +1 @@
-{"version":3,"file":"update-tag-type-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-tag-type-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACR,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"update-tag-type-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-tag-type-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,2CAA2C;IACxD,UAAU,EAAE;QACR,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,kCAAkC;YAC/C,OAAO,EAAE,+CAA+C;SAC3D;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,2BAA2B;YACxC,OAAO,EAAE,iBAAiB;SAC7B;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -3,15 +3,29 @@ export declare const updateUserSchema: {
     readonly $id: "#/components/schemas/updateUserSchema";
     readonly type: "object";
     readonly additionalProperties: true;
+    readonly description: "All fields that can be directly changed for the user";
     readonly properties: {
         readonly email: {
+            readonly description: "The user's email address. Must be provided if username is not provided.";
             readonly type: "string";
+            readonly example: "user@example.com";
         };
         readonly name: {
+            readonly description: "The user's name (not the user's username).";
             readonly type: "string";
+            readonly example: "Sam Seawright";
         };
         readonly rootRole: {
-            readonly type: "number";
+            readonly description: "The role to assign to the user. Can be either the role's ID or its unique name.";
+            readonly oneOf: readonly [{
+                readonly type: "integer";
+                readonly example: 1;
+                readonly minimum: 0;
+            }, {
+                readonly type: "string";
+                readonly example: "Admin";
+                readonly enum: readonly ["Admin", "Editor", "Viewer", "Owner", "Member"];
+            }];
         };
     };
     readonly components: {};

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

@@ -5,15 +5,32 @@ exports.updateUserSchema = {
     $id: '#/components/schemas/updateUserSchema',
     type: 'object',
     additionalProperties: true,
+    description: 'All fields that can be directly changed for the user',
     properties: {
         email: {
+            description: "The user's email address. Must be provided if username is not provided.",
             type: 'string',
+            example: 'user@example.com',
         },
         name: {
+            description: "The user's name (not the user's username).",
             type: 'string',
+            example: 'Sam Seawright',
         },
         rootRole: {
-            type: 'number',
+            description: "The role to assign to the user. Can be either the role's ID or its unique name.",
+            oneOf: [
+                {
+                    type: 'integer',
+                    example: 1,
+                    minimum: 0,
+                },
+                {
+                    type: 'string',
+                    example: 'Admin',
+                    enum: ['Admin', 'Editor', 'Viewer', 'Owner', 'Member'],
+                },
+            ],
         },
     },
     components: {},

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

@@ -1 +1 @@
-{"version":3,"file":"update-user-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-user-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,gBAAgB,GAAG;IAC5B,GAAG,EAAE,uCAAuC;IAC5C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,UAAU,EAAE;QACR,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"update-user-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-user-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,gBAAgB,GAAG;IAC5B,GAAG,EAAE,uCAAuC;IAC5C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,WAAW,EAAE,sDAAsD;IACnE,UAAU,EAAE;QACR,KAAK,EAAE;YACH,WAAW,EACP,yEAAyE;YAC7E,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,kBAAkB;SAC9B;QACD,IAAI,EAAE;YACF,WAAW,EAAE,4CAA4C;YACzD,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;SAC3B;QACD,QAAQ,EAAE;YACN,WAAW,EACP,iFAAiF;YACrF,KAAK,EAAE;gBACH;oBACI,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,CAAC;oBACV,OAAO,EAAE,CAAC;iBACb;gBACD;oBACI,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,OAAO;oBAChB,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,CAAC;iBACzD;aACJ;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

package/dist/lib/openapi/spec/upsert-context-field-schema.d.ts

@@ -29,13 +29,18 @@ export declare const upsertContextFieldSchema: {
                 readonly $id: "#/components/schemas/legalValueSchema";
                 readonly type: "object";
                 readonly additionalProperties: false;
+                readonly description: "Describes a legal value. Typically used to limit possible values for contextFields or strategy properties";
                 readonly required: readonly ["value"];
                 readonly properties: {
                     readonly value: {
+                        readonly description: "The valid value";
                         readonly type: "string";
+                        readonly example: "#c154c1";
                     };
                     readonly description: {
+                        readonly description: "Describes this specific legal value";
                         readonly type: "string";
+                        readonly example: "Deep fuchsia";
                     };
                 };
                 readonly components: {};

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

@@ -3,50 +3,88 @@ export declare const userSchema: {
     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/user-schema.js

@@ -6,50 +6,88 @@ exports.userSchema = {
     $id: '#/components/schemas/userSchema',
     type: 'object',
     additionalProperties: false,
+    description: 'An Unleash user',
     required: ['id'],
     properties: {
         id: {
-            type: 'number',
+            description: 'The user id',
+            type: 'integer',
+            minimum: 0,
+            example: 123,
         },
         isAPI: {
+            description: '(Deprecated): Used internally to know which operations the user should be allowed to perform',
             type: 'boolean',
+            example: true,
+            deprecated: true,
         },
         name: {
+            description: 'Name of the user',
             type: 'string',
+            example: 'User',
         },
         email: {
+            description: 'Email of the user',
             type: 'string',
+            example: 'user@example.com',
         },
         username: {
+            description: 'A unique username for the user',
             type: 'string',
+            example: 'hunter',
         },
         imageUrl: {
+            description: `URL used for the userprofile image`,
             type: 'string',
+            example: 'https://example.com/242x200.png',
         },
         inviteLink: {
+            description: `If the user is actively inviting other users, this is the link that can be shared with other users`,
             type: 'string',
+            example: 'http://localhost:4242/invite-link/some-secret',
         },
         loginAttempts: {
-            type: 'number',
+            description: 'How many unsuccessful attempts at logging in has the user made',
+            type: 'integer',
+            minimum: 0,
+            example: 3,
         },
         emailSent: {
+            description: 'Is the welcome email sent to the user or not',
             type: 'boolean',
+            example: false,
         },
         rootRole: {
-            type: 'number',
+            description: 'Which [root role](https://docs.getunleash.io/reference/rbac#standard-roles) this user is assigned',
+            type: 'integer',
+            example: 1,
+            minimum: 0,
         },
         seenAt: {
+            description: 'The last time this user logged in',
             type: 'string',
             format: 'date-time',
             nullable: true,
+            example: '2023-06-30T11:42:00.345Z',
         },
         createdAt: {
+            description: 'The user was created at this time',
             type: 'string',
             format: 'date-time',
+            example: '2023-06-30T11:41:00.123Z',
         },
         accountType: {
+            description: 'A user is either an actual User or a Service Account',
             type: 'string',
             enum: types_1.AccountTypes,
+            example: 'User',
+        },
+        permissions: {
+            description: 'Deprecated',
+            type: 'array',
+            items: {
+                type: 'string',
+            },
         },
     },
     components: {},

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

@@ -1 +1 @@
-{"version":3,"file":"user-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/user-schema.ts"],"names":[],"mappings":";;;AACA,uCAA2C;AAE9B,QAAA,UAAU,GAAG;IACtB,GAAG,EAAE,iCAAiC;IACtC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,IAAI,CAAC;IAChB,UAAU,EAAE;QACR,EAAE,EAAE;YACA,IAAI,EAAE,QAAQ;SACjB;QACD,KAAK,EAAE;YACH,IAAI,EAAE,SAAS;SAClB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;SACjB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;SACjB;QACD,aAAa,EAAE;YACX,IAAI,EAAE,QAAQ;SACjB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,SAAS;SAClB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;SACjB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;SACtB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,oBAAY;SACrB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"user-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/user-schema.ts"],"names":[],"mappings":";;;AACA,uCAA2C;AAE9B,QAAA,UAAU,GAAG;IACtB,GAAG,EAAE,iCAAiC;IACtC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,iBAAiB;IAC9B,QAAQ,EAAE,CAAC,IAAI,CAAC;IAChB,UAAU,EAAE;QACR,EAAE,EAAE;YACA,WAAW,EAAE,aAAa;YAC1B,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,GAAG;SACf;QACD,KAAK,EAAE;YACH,WAAW,EACP,8FAA8F;YAClG,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,UAAU,EAAE,IAAI;SACnB;QACD,IAAI,EAAE;YACF,WAAW,EAAE,kBAAkB;YAC/B,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,MAAM;SAClB;QACD,KAAK,EAAE;YACH,WAAW,EAAE,mBAAmB;YAChC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,kBAAkB;SAC9B;QACD,QAAQ,EAAE;YACN,WAAW,EAAE,gCAAgC;YAC7C,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;SACpB;QACD,QAAQ,EAAE;YACN,WAAW,EAAE,oCAAoC;YACjD,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,iCAAiC;SAC7C;QACD,UAAU,EAAE;YACR,WAAW,EAAE,oGAAoG;YACjH,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,+CAA+C;SAC3D;QACD,aAAa,EAAE;YACX,WAAW,EACP,gEAAgE;YACpE,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;SACb;QACD,SAAS,EAAE;YACP,WAAW,EAAE,8CAA8C;YAC3D,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;SACjB;QACD,QAAQ,EAAE;YACN,WAAW,EACP,mGAAmG;YACvG,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;SACb;QACD,MAAM,EAAE;YACJ,WAAW,EAAE,mCAAmC;YAChD,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;SACtC;QACD,SAAS,EAAE;YACP,WAAW,EAAE,mCAAmC;YAChD,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,OAAO,EAAE,0BAA0B;SACtC;QACD,WAAW,EAAE;YACT,WAAW,EAAE,sDAAsD;YACnE,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,oBAAY;YAClB,OAAO,EAAE,MAAM;SAClB;QACD,WAAW,EAAE;YACT,WAAW,EAAE,YAAY;YACzB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}