unleash-server 5.2.7 → 5.3.0

package/dist/lib/openapi/spec/public-signup-tokens-schema.d.ts

@@ -95,50 +95,88 @@ export declare const publicSignupTokensSchema: {
                             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: {};
@@ -146,20 +184,30 @@ export declare const publicSignupTokensSchema: {
                         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: {};
@@ -171,50 +219,88 @@ export declare const publicSignupTokensSchema: {
                 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: {};
@@ -222,20 +308,30 @@ export declare const publicSignupTokensSchema: {
             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/push-variants-schema.d.ts

@@ -39,7 +39,8 @@ export declare const pushVariantsSchema: {
                     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";
@@ -50,17 +51,21 @@ export declare const pushVariantsSchema: {
                         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/requests-per-second-schema.d.ts

@@ -2,31 +2,44 @@ import { FromSchema } from 'json-schema-to-ts';
 export declare const requestsPerSecondSchema: {
     readonly $id: "#/components/schemas/requestsPerSecondSchema";
     readonly type: "object";
+    readonly description: "Statistics for usage of Unleash, formatted so it can easily be used in a graph";
     readonly properties: {
         readonly status: {
             readonly type: "string";
+            readonly description: "Whether the query against prometheus succeeded or failed";
+            readonly enum: readonly ["success", "failure"];
+            readonly example: "success";
         };
         readonly data: {
             readonly type: "object";
+            readonly description: "The query result from prometheus";
             readonly properties: {
                 readonly resultType: {
                     readonly type: "string";
+                    readonly description: "Prometheus compatible result type.";
+                    readonly enum: readonly ["matrix", "vector", "scalar", "string"];
+                    readonly example: "vector";
                 };
                 readonly result: {
                     readonly description: "An array of values per metric. Each one represents a line in the graph labeled by its metric name";
                     readonly type: "array";
                     readonly items: {
                         readonly type: "object";
+                        readonly description: "A representation of a single metric to build a line in a graph";
                         readonly properties: {
                             readonly metric: {
                                 readonly description: "A key value set representing the metric";
                                 readonly type: "object";
                                 readonly properties: {
                                     readonly appName: {
+                                        readonly description: "Name of the application this metric relates to";
                                         readonly type: "string";
+                                        readonly example: "mySdk";
                                     };
                                     readonly endpoint: {
+                                        readonly description: "Which endpoint has been accessed";
                                         readonly type: "string";
+                                        readonly example: "/api/frontend";
                                     };
                                 };
                             };
@@ -35,11 +48,14 @@ export declare const requestsPerSecondSchema: {
                                 readonly type: "array";
                                 readonly items: {
                                     readonly type: "array";
+                                    readonly description: "Either the x axis represented as a number or the y axis represented as a string";
                                     readonly items: {
                                         readonly anyOf: readonly [{
                                             readonly type: "string";
+                                            readonly description: "An identifier for the line in the graph";
                                         }, {
                                             readonly type: "number";
+                                            readonly description: "The number of requests at this point in time";
                                         }];
                                     };
                                 };

package/dist/lib/openapi/spec/requests-per-second-schema.js

@@ -4,31 +4,44 @@ exports.requestsPerSecondSchema = void 0;
 exports.requestsPerSecondSchema = {
     $id: '#/components/schemas/requestsPerSecondSchema',
     type: 'object',
+    description: 'Statistics for usage of Unleash, formatted so it can easily be used in a graph',
     properties: {
         status: {
             type: 'string',
+            description: 'Whether the query against prometheus succeeded or failed',
+            enum: ['success', 'failure'],
+            example: 'success',
         },
         data: {
             type: 'object',
+            description: 'The query result from prometheus',
             properties: {
                 resultType: {
                     type: 'string',
+                    description: 'Prometheus compatible result type.',
+                    enum: ['matrix', 'vector', 'scalar', 'string'],
+                    example: 'vector',
                 },
                 result: {
                     description: 'An array of values per metric. Each one represents a line in the graph labeled by its metric name',
                     type: 'array',
                     items: {
                         type: 'object',
+                        description: 'A representation of a single metric to build a line in a graph',
                         properties: {
                             metric: {
                                 description: 'A key value set representing the metric',
                                 type: 'object',
                                 properties: {
                                     appName: {
+                                        description: 'Name of the application this metric relates to',
                                         type: 'string',
+                                        example: 'mySdk',
                                     },
                                     endpoint: {
+                                        description: 'Which endpoint has been accessed',
                                         type: 'string',
+                                        example: '/api/frontend',
                                     },
                                 },
                             },
@@ -37,10 +50,17 @@ exports.requestsPerSecondSchema = {
                                 type: 'array',
                                 items: {
                                     type: 'array',
+                                    description: 'Either the x axis represented as a number or the y axis represented as a string',
                                     items: {
                                         anyOf: [
-                                            { type: 'string' },
-                                            { type: 'number' },
+                                            {
+                                                type: 'string',
+                                                description: 'An identifier for the line in the graph',
+                                            },
+                                            {
+                                                type: 'number',
+                                                description: 'The number of requests at this point in time',
+                                            },
                                         ],
                                     },
                                 },

package/dist/lib/openapi/spec/requests-per-second-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"requests-per-second-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/requests-per-second-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,uBAAuB,GAAG;IACnC,GAAG,EAAE,8CAA8C;IACnD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACR,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACR,UAAU,EAAE;oBACR,IAAI,EAAE,QAAQ;iBACjB;gBACD,MAAM,EAAE;oBACJ,WAAW,EACP,mGAAmG;oBACvG,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACR,MAAM,EAAE;gCACJ,WAAW,EACP,yCAAyC;gCAC7C,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACR,OAAO,EAAE;wCACL,IAAI,EAAE,QAAQ;qCACjB;oCACD,QAAQ,EAAE;wCACN,IAAI,EAAE,QAAQ;qCACjB;iCACJ;6BACJ;4BACD,MAAM,EAAE;gCACJ,WAAW,EACP,mNAAmN;gCACvN,IAAI,EAAE,OAAO;gCACb,KAAK,EAAE;oCACH,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE;wCACH,KAAK,EAAE;4CACH,EAAE,IAAI,EAAE,QAAQ,EAAE;4CAClB,EAAE,IAAI,EAAE,QAAQ,EAAE;yCACrB;qCACJ;iCACJ;6BACJ;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"requests-per-second-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/requests-per-second-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,uBAAuB,GAAG;IACnC,GAAG,EAAE,8CAA8C;IACnD,IAAI,EAAE,QAAQ;IACd,WAAW,EACP,gFAAgF;IACpF,UAAU,EAAE;QACR,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,0DAA0D;YAC9D,IAAI,EAAE,CAAC,SAAS,EAAE,SAAS,CAAC;YAC5B,OAAO,EAAE,SAAS;SACrB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,kCAAkC;YAC/C,UAAU,EAAE;gBACR,UAAU,EAAE;oBACR,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,oCAAoC;oBACjD,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,CAAC;oBAC9C,OAAO,EAAE,QAAQ;iBACpB;gBACD,MAAM,EAAE;oBACJ,WAAW,EACP,mGAAmG;oBACvG,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,QAAQ;wBACd,WAAW,EACP,gEAAgE;wBACpE,UAAU,EAAE;4BACR,MAAM,EAAE;gCACJ,WAAW,EACP,yCAAyC;gCAC7C,IAAI,EAAE,QAAQ;gCACd,UAAU,EAAE;oCACR,OAAO,EAAE;wCACL,WAAW,EACP,gDAAgD;wCACpD,IAAI,EAAE,QAAQ;wCACd,OAAO,EAAE,OAAO;qCACnB;oCACD,QAAQ,EAAE;wCACN,WAAW,EACP,kCAAkC;wCACtC,IAAI,EAAE,QAAQ;wCACd,OAAO,EAAE,eAAe;qCAC3B;iCACJ;6BACJ;4BACD,MAAM,EAAE;gCACJ,WAAW,EACP,mNAAmN;gCACvN,IAAI,EAAE,OAAO;gCACb,KAAK,EAAE;oCACH,IAAI,EAAE,OAAO;oCACb,WAAW,EACP,iFAAiF;oCACrF,KAAK,EAAE;wCACH,KAAK,EAAE;4CACH;gDACI,IAAI,EAAE,QAAQ;gDACd,WAAW,EACP,yCAAyC;6CAChD;4CACD;gDACI,IAAI,EAAE,QAAQ;gDACd,WAAW,EACP,8CAA8C;6CACrD;yCACJ;qCACJ;iCACJ;6BACJ;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

package/dist/lib/openapi/spec/requests-per-second-segmented-schema.d.ts

@@ -2,6 +2,7 @@ import { FromSchema } from 'json-schema-to-ts';
 export declare const requestsPerSecondSegmentedSchema: {
     readonly $id: "#/components/schemas/requestsPerSecondSegmentedSchema";
     readonly type: "object";
+    readonly description: "Get usage metrics separated by client and admin paths";
     readonly properties: {
         readonly clientMetrics: {
             readonly $ref: "#/components/schemas/requestsPerSecondSchema";
@@ -15,31 +16,44 @@ export declare const requestsPerSecondSegmentedSchema: {
             readonly requestsPerSecondSchema: {
                 readonly $id: "#/components/schemas/requestsPerSecondSchema";
                 readonly type: "object";
+                readonly description: "Statistics for usage of Unleash, formatted so it can easily be used in a graph";
                 readonly properties: {
                     readonly status: {
                         readonly type: "string";
+                        readonly description: "Whether the query against prometheus succeeded or failed";
+                        readonly enum: readonly ["success", "failure"];
+                        readonly example: "success";
                     };
                     readonly data: {
                         readonly type: "object";
+                        readonly description: "The query result from prometheus";
                         readonly properties: {
                             readonly resultType: {
                                 readonly type: "string";
+                                readonly description: "Prometheus compatible result type.";
+                                readonly enum: readonly ["matrix", "vector", "scalar", "string"];
+                                readonly example: "vector";
                             };
                             readonly result: {
                                 readonly description: "An array of values per metric. Each one represents a line in the graph labeled by its metric name";
                                 readonly type: "array";
                                 readonly items: {
                                     readonly type: "object";
+                                    readonly description: "A representation of a single metric to build a line in a graph";
                                     readonly properties: {
                                         readonly metric: {
                                             readonly description: "A key value set representing the metric";
                                             readonly type: "object";
                                             readonly properties: {
                                                 readonly appName: {
+                                                    readonly description: "Name of the application this metric relates to";
                                                     readonly type: "string";
+                                                    readonly example: "mySdk";
                                                 };
                                                 readonly endpoint: {
+                                                    readonly description: "Which endpoint has been accessed";
                                                     readonly type: "string";
+                                                    readonly example: "/api/frontend";
                                                 };
                                             };
                                         };
@@ -48,11 +62,14 @@ export declare const requestsPerSecondSegmentedSchema: {
                                             readonly type: "array";
                                             readonly items: {
                                                 readonly type: "array";
+                                                readonly description: "Either the x axis represented as a number or the y axis represented as a string";
                                                 readonly items: {
                                                     readonly anyOf: readonly [{
                                                         readonly type: "string";
+                                                        readonly description: "An identifier for the line in the graph";
                                                     }, {
                                                         readonly type: "number";
+                                                        readonly description: "The number of requests at this point in time";
                                                     }];
                                                 };
                                             };

package/dist/lib/openapi/spec/requests-per-second-segmented-schema.js

@@ -5,6 +5,7 @@ const requests_per_second_schema_1 = require("./requests-per-second-schema");
 exports.requestsPerSecondSegmentedSchema = {
     $id: '#/components/schemas/requestsPerSecondSegmentedSchema',
     type: 'object',
+    description: 'Get usage metrics separated by client and admin paths',
     properties: {
         clientMetrics: {
             $ref: '#/components/schemas/requestsPerSecondSchema',

package/dist/lib/openapi/spec/requests-per-second-segmented-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"requests-per-second-segmented-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/requests-per-second-segmented-schema.ts"],"names":[],"mappings":";;;AACA,6EAAuE;AAC1D,QAAA,gCAAgC,GAAG;IAC5C,GAAG,EAAE,uDAAuD;IAC5D,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACR,aAAa,EAAE;YACX,IAAI,EAAE,8CAA8C;SACvD;QACD,YAAY,EAAE;YACV,IAAI,EAAE,8CAA8C;SACvD;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,uBAAuB,EAAvB,oDAAuB;SAC1B;KACJ;CACK,CAAC"}
+{"version":3,"file":"requests-per-second-segmented-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/requests-per-second-segmented-schema.ts"],"names":[],"mappings":";;;AACA,6EAAuE;AAC1D,QAAA,gCAAgC,GAAG;IAC5C,GAAG,EAAE,uDAAuD;IAC5D,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,uDAAuD;IACpE,UAAU,EAAE;QACR,aAAa,EAAE;YACX,IAAI,EAAE,8CAA8C;SACvD;QACD,YAAY,EAAE;YACV,IAAI,EAAE,8CAA8C;SACvD;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,uBAAuB,EAAvB,oDAAuB;SAC1B;KACJ;CACK,CAAC"}

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

@@ -2,20 +2,30 @@ import { FromSchema } from 'json-schema-to-ts';
 export declare const 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/role-schema.js

@@ -4,20 +4,30 @@ exports.roleSchema = void 0;
 exports.roleSchema = {
     $id: '#/components/schemas/roleSchema',
     type: 'object',
+    description: 'A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform',
     additionalProperties: false,
     required: ['id', 'type', 'name'],
     properties: {
         id: {
-            type: 'number',
+            type: 'integer',
+            description: 'The role id',
+            example: 9,
+            minimum: 0,
         },
         type: {
+            description: 'A role can either be a global root role (applies to all projects) or a project role',
             type: 'string',
+            example: 'root',
         },
         name: {
+            description: `The name of the role`,
             type: 'string',
+            example: 'Editor',
         },
         description: {
+            description: `A more detailed description of the role and what use it's intended for`,
             type: 'string',
+            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.`,
         },
     },
     components: {},

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

@@ -1 +1 @@
-{"version":3,"file":"role-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/role-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,UAAU,GAAG;IACtB,GAAG,EAAE,iCAAiC;IACtC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC;IAChC,UAAU,EAAE;QACR,EAAE,EAAE;YACA,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"role-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/role-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,UAAU,GAAG;IACtB,GAAG,EAAE,iCAAiC;IACtC,IAAI,EAAE,QAAQ;IACd,WAAW,EACP,sGAAsG;IAC1G,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC;IAChC,UAAU,EAAE;QACR,EAAE,EAAE;YACA,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,aAAa;YAC1B,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;SACb;QACD,IAAI,EAAE;YACF,WAAW,EACP,qFAAqF;YACzF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,MAAM;SAClB;QACD,IAAI,EAAE;YACF,WAAW,EAAE,sBAAsB;YACnC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;SACpB;QACD,WAAW,EAAE;YACT,WAAW,EAAE,wEAAwE;YACrF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,iWAAiW;SAC7W;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -7,29 +7,38 @@ export declare const searchEventsSchema: {
         readonly type: {
             readonly type: "string";
             readonly description: "Find events by event type (case-sensitive).";
+            readonly enum: readonly ["application-created", "feature-created", "feature-deleted", "feature-updated", "feature-metadata-updated", "feature-variants-updated", "feature-environment-variants-updated", "feature-project-change", "feature-archived", "feature-revived", "feature-import", "feature-tagged", "feature-tag-import", "feature-strategy-update", "feature-strategy-add", "feature-strategy-remove", "strategy-order-changed", "drop-feature-tags", "feature-untagged", "feature-stale-on", "feature-stale-off", "drop-features", "feature-environment-enabled", "feature-environment-disabled", "strategy-created", "strategy-deleted", "strategy-deprecated", "strategy-reactivated", "strategy-updated", "strategy-import", "drop-strategies", "context-field-created", "context-field-updated", "context-field-deleted", "project-access-added", "project-created", "project-updated", "project-deleted", "project-import", "project-user-added", "project-user-removed", "project-user-role-changed", "project-group-role-changed", "project-group-added", "project-group-removed", "drop-projects", "tag-created", "tag-deleted", "tag-import", "drop-tags", "tag-type-created", "tag-type-deleted", "tag-type-updated", "tag-type-import", "drop-tag-types", "addon-config-created", "addon-config-updated", "addon-config-deleted", "db-pool-update", "user-created", "user-updated", "user-deleted", "drop-environments", "environment-import", "segment-created", "segment-updated", "segment-deleted", "group-created", "group-updated", "setting-created", "setting-updated", "setting-deleted", "client-metrics", "client-register", "pat-created", "pat-deleted", "public-signup-token-created", "public-signup-token-user-added", "public-signup-token-updated", "change-request-created", "change-request-discarded", "change-added", "change-discarded", "change-edited", "change-request-approved", "change-request-approval-added", "change-request-cancelled", "change-request-sent-to-review", "change-request-applied", "api-token-created", "api-token-updated", "api-token-deleted", "feature-favorited", "feature-unfavorited", "project-favorited", "project-unfavorited", "features-exported", "features-imported", "service-account-created", "service-account-deleted", "service-account-updated", "feature-potentially-stale-on"];
+            readonly example: "feature-created";
         };
         readonly project: {
             readonly type: "string";
             readonly description: "Find events by project ID (case-sensitive).";
+            readonly example: "default";
         };
         readonly feature: {
             readonly type: "string";
             readonly description: "Find events by feature toggle name (case-sensitive).";
+            readonly example: "my.first.toggle";
         };
         readonly query: {
             readonly type: "string";
             readonly description: "\n                Find events by a free-text search query.\n                The query will be matched against the event type,\n                the username or email that created the event (if any),\n                and the event data payload (if any).\n            ";
+            readonly example: "admin@example.com";
         };
         readonly limit: {
             readonly type: "integer";
+            readonly description: "The maximum amount of events to return in the search result";
             readonly minimum: 1;
             readonly maximum: 100;
             readonly default: 100;
+            readonly example: 50;
         };
         readonly offset: {
+            readonly description: "Which event id to start listing from";
             readonly type: "integer";
             readonly minimum: 0;
             readonly default: 0;
+            readonly example: 100;
         };
     };
     readonly components: {};