unleash-server 5.2.7 → 5.3.0

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

@@ -9,20 +9,25 @@ const constraint_schema_1 = require("./constraint-schema");
 const feature_strategy_schema_1 = require("./feature-strategy-schema");
 const environment_schema_1 = require("./environment-schema");
 const feature_environment_schema_1 = require("./feature-environment-schema");
+const strategy_variant_schema_1 = require("./strategy-variant-schema");
 exports.featuresSchema = {
     $id: '#/components/schemas/featuresSchema',
     type: 'object',
     additionalProperties: false,
     required: ['version', 'features'],
+    description: 'A list of features',
+    deprecated: true,
     properties: {
         version: {
             type: 'integer',
+            description: "The version of the feature's schema",
         },
         features: {
             type: 'array',
             items: {
                 $ref: '#/components/schemas/featureSchema',
             },
+            description: 'A list of features',
         },
     },
     components: {
@@ -33,6 +38,7 @@ exports.featuresSchema = {
             overrideSchema: override_schema_1.overrideSchema,
             featureEnvironmentSchema: feature_environment_schema_1.featureEnvironmentSchema,
             featureStrategySchema: feature_strategy_schema_1.featureStrategySchema,
+            strategyVariantSchema: strategy_variant_schema_1.strategyVariantSchema,
             parametersSchema: parameters_schema_1.parametersSchema,
             variantSchema: variant_schema_1.variantSchema,
         },

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

@@ -1 +1 @@
-{"version":3,"file":"features-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/features-schema.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AACjD,2DAAuD;AACvD,qDAAiD;AACjD,uDAAmD;AACnD,2DAAuD;AACvD,uEAAkE;AAClE,6DAAyD;AACzD,6EAAwE;AAE3D,QAAA,cAAc,GAAG;IAC1B,GAAG,EAAE,qCAAqC;IAC1C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC;IACjC,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;SAClB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,iBAAiB,EAAjB,sCAAiB;YACjB,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;YACd,wBAAwB,EAAxB,qDAAwB;YACxB,qBAAqB,EAArB,+CAAqB;YACrB,gBAAgB,EAAhB,oCAAgB;YAChB,aAAa,EAAb,8BAAa;SAChB;KACJ;CACK,CAAC"}
+{"version":3,"file":"features-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/features-schema.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AACjD,2DAAuD;AACvD,qDAAiD;AACjD,uDAAmD;AACnD,2DAAuD;AACvD,uEAAkE;AAClE,6DAAyD;AACzD,6EAAwE;AACxE,uEAAkE;AAErD,QAAA,cAAc,GAAG;IAC1B,GAAG,EAAE,qCAAqC;IAC1C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC;IACjC,WAAW,EAAE,oBAAoB;IACjC,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,qCAAqC;SACrD;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;YACD,WAAW,EAAE,oBAAoB;SACpC;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,iBAAiB,EAAjB,sCAAiB;YACjB,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;YACd,wBAAwB,EAAxB,qDAAwB;YACxB,qBAAqB,EAArB,+CAAqB;YACrB,qBAAqB,EAArB,+CAAqB;YACrB,gBAAgB,EAAhB,oCAAgB;YAChB,aAAa,EAAb,8BAAa;SAChB;KACJ;CACK,CAAC"}

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

@@ -0,0 +1,21 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const feedbackCreateSchema: {
+    readonly $id: "#/components/schemas/feedbackCreateSchema";
+    readonly required: readonly ["feedbackId"];
+    readonly type: "object";
+    readonly description: "User feedback information to be created.";
+    readonly properties: {
+        readonly neverShow: {
+            readonly description: "`true` if the user has asked never to see this feedback questionnaire again. Defaults to `false`.";
+            readonly type: "boolean";
+            readonly example: false;
+        };
+        readonly feedbackId: {
+            readonly description: "The name of the feedback session";
+            readonly type: "string";
+            readonly example: "pnps";
+        };
+    };
+    readonly components: {};
+};
+export declare type FeedbackCreateSchema = FromSchema<typeof feedbackCreateSchema>;

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

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.feedbackCreateSchema = void 0;
+exports.feedbackCreateSchema = {
+    $id: '#/components/schemas/feedbackCreateSchema',
+    required: ['feedbackId'],
+    type: 'object',
+    description: 'User feedback information to be created.',
+    properties: {
+        neverShow: {
+            description: '`true` if the user has asked never to see this feedback questionnaire again. Defaults to `false`.',
+            type: 'boolean',
+            example: false,
+        },
+        feedbackId: {
+            description: 'The name of the feedback session',
+            type: 'string',
+            example: 'pnps',
+        },
+    },
+    components: {},
+};
+//# sourceMappingURL=feedback-create-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"feedback-create-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/feedback-create-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAG;IAChC,GAAG,EAAE,2CAA2C;IAChD,QAAQ,EAAE,CAAC,YAAY,CAAC;IACxB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,0CAA0C;IACvD,UAAU,EAAE;QACR,SAAS,EAAE;YACP,WAAW,EACP,mGAAmG;YACvG,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;SACjB;QACD,UAAU,EAAE;YACR,WAAW,EAAE,kCAAkC;YAC/C,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,MAAM;SAClB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -0,0 +1,33 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const feedbackResponseSchema: {
+    readonly $id: "#/components/schemas/feedbackResponseSchema";
+    readonly additionalProperties: false;
+    readonly type: "object";
+    readonly description: "User feedback information about a particular feedback item.";
+    readonly properties: {
+        readonly userId: {
+            readonly description: "The ID of the user that gave the feedback.";
+            readonly type: "integer";
+            readonly example: 2;
+        };
+        readonly neverShow: {
+            readonly description: "`true` if the user has asked never to see this feedback questionnaire again.";
+            readonly type: "boolean";
+            readonly example: false;
+        };
+        readonly given: {
+            readonly description: "When this feedback was given";
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly nullable: true;
+            readonly example: "2023-07-06T08:29:21.282Z";
+        };
+        readonly feedbackId: {
+            readonly description: "The name of the feedback session";
+            readonly type: "string";
+            readonly example: "pnps";
+        };
+    };
+    readonly components: {};
+};
+export declare type FeedbackResponseSchema = FromSchema<typeof feedbackResponseSchema>;

package/dist/lib/openapi/spec/feedback-response-schema.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.feedbackResponseSchema = void 0;
+exports.feedbackResponseSchema = {
+    $id: '#/components/schemas/feedbackResponseSchema',
+    additionalProperties: false,
+    type: 'object',
+    description: 'User feedback information about a particular feedback item.',
+    properties: {
+        userId: {
+            description: 'The ID of the user that gave the feedback.',
+            type: 'integer',
+            example: 2,
+        },
+        neverShow: {
+            description: '`true` if the user has asked never to see this feedback questionnaire again.',
+            type: 'boolean',
+            example: false,
+        },
+        given: {
+            description: 'When this feedback was given',
+            type: 'string',
+            format: 'date-time',
+            nullable: true,
+            example: '2023-07-06T08:29:21.282Z',
+        },
+        feedbackId: {
+            description: 'The name of the feedback session',
+            type: 'string',
+            example: 'pnps',
+        },
+    },
+    components: {},
+};
+//# sourceMappingURL=feedback-response-schema.js.map

package/dist/lib/openapi/spec/feedback-response-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feedback-response-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/feedback-response-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,sBAAsB,GAAG;IAClC,GAAG,EAAE,6CAA6C;IAClD,oBAAoB,EAAE,KAAK;IAC3B,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,6DAA6D;IAC1E,UAAU,EAAE;QACR,MAAM,EAAE;YACJ,WAAW,EAAE,4CAA4C;YACzD,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;SACb;QACD,SAAS,EAAE;YACP,WAAW,EACP,8EAA8E;YAClF,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;SACjB;QACD,KAAK,EAAE;YACH,WAAW,EAAE,8BAA8B;YAC3C,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;SACtC;QACD,UAAU,EAAE;YACR,WAAW,EAAE,kCAAkC;YAC/C,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,MAAM;SAClB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -0,0 +1,27 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const feedbackUpdateSchema: {
+    readonly $id: "#/components/schemas/feedbackUpdateSchema";
+    readonly type: "object";
+    readonly description: "User feedback information to be updated.";
+    readonly properties: {
+        readonly userId: {
+            readonly description: "The ID of the user that gave the feedback.";
+            readonly type: "integer";
+            readonly example: 2;
+        };
+        readonly neverShow: {
+            readonly description: "`true` if the user has asked never to see this feedback questionnaire again.";
+            readonly type: "boolean";
+            readonly example: false;
+        };
+        readonly given: {
+            readonly description: "When this feedback was given";
+            readonly type: "string";
+            readonly format: "date-time";
+            readonly nullable: true;
+            readonly example: "2023-07-06T08:29:21.282Z";
+        };
+    };
+    readonly components: {};
+};
+export declare type FeedbackUpdateSchema = FromSchema<typeof feedbackUpdateSchema>;

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.feedbackUpdateSchema = void 0;
+exports.feedbackUpdateSchema = {
+    $id: '#/components/schemas/feedbackUpdateSchema',
+    type: 'object',
+    description: 'User feedback information to be updated.',
+    properties: {
+        userId: {
+            description: 'The ID of the user that gave the feedback.',
+            type: 'integer',
+            example: 2,
+        },
+        neverShow: {
+            description: '`true` if the user has asked never to see this feedback questionnaire again.',
+            type: 'boolean',
+            example: false,
+        },
+        given: {
+            description: 'When this feedback was given',
+            type: 'string',
+            format: 'date-time',
+            nullable: true,
+            example: '2023-07-06T08:29:21.282Z',
+        },
+    },
+    components: {},
+};
+//# sourceMappingURL=feedback-update-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"feedback-update-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/feedback-update-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAG;IAChC,GAAG,EAAE,2CAA2C;IAChD,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,0CAA0C;IACvD,UAAU,EAAE;QACR,MAAM,EAAE;YACJ,WAAW,EAAE,4CAA4C;YACzD,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;SACb;QACD,SAAS,EAAE;YACP,WAAW,EACP,8EAA8E;YAClF,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;SACjB;QACD,KAAK,EAAE;YACH,WAAW,EAAE,8BAA8B;YAC3C,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;SACtC;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -2,50 +2,67 @@ import { FromSchema } from 'json-schema-to-ts';
 export declare const groupSchema: {
     readonly $id: "#/components/schemas/groupSchema";
     readonly type: "object";
-    readonly additionalProperties: true;
+    readonly additionalProperties: false;
     readonly required: readonly ["name"];
+    readonly description: "A detailed information about a user group";
     readonly properties: {
         readonly id: {
-            readonly type: "number";
+            readonly description: "The group id";
+            readonly type: "integer";
+            readonly example: 1;
         };
         readonly name: {
+            readonly description: "The name of the group";
             readonly type: "string";
+            readonly example: "DX team";
         };
         readonly description: {
+            readonly description: "A custom description of the group";
             readonly type: "string";
             readonly nullable: true;
+            readonly example: "Current members of the DX squad";
         };
         readonly mappingsSSO: {
+            readonly description: "A list of SSO groups that should map to this Unleash group";
             readonly type: "array";
             readonly items: {
                 readonly type: "string";
             };
+            readonly example: readonly ["SSOGroup1", "SSOGroup2"];
         };
         readonly rootRole: {
             readonly type: "number";
             readonly nullable: true;
-            readonly description: "A role id that is used as the root role for all users in this group. This can be either the id of the Editor or Admin role.";
+            readonly description: "A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.";
+            readonly example: 1;
         };
         readonly createdBy: {
+            readonly description: "A user who created this group";
             readonly type: "string";
             readonly nullable: true;
+            readonly example: "admin";
         };
         readonly createdAt: {
+            readonly description: "When was this group created";
             readonly type: "string";
             readonly format: "date-time";
             readonly nullable: true;
+            readonly example: "2023-06-30T11:41:00.123Z";
         };
         readonly users: {
             readonly type: "array";
+            readonly description: "A list of users belonging to this group";
             readonly items: {
                 readonly $ref: "#/components/schemas/groupUserModelSchema";
             };
         };
         readonly projects: {
+            readonly description: "A list of projects where this group is used";
             readonly type: "array";
             readonly items: {
                 readonly type: "string";
             };
+            readonly example: readonly ["default", "my-project"];
         };
     };
     readonly components: {
@@ -55,14 +72,19 @@ export declare const groupSchema: {
                 readonly type: "object";
                 readonly additionalProperties: false;
                 readonly required: readonly ["user"];
+                readonly description: "Details for a single user belonging to a group";
                 readonly properties: {
                     readonly joinedAt: {
+                        readonly description: "The date when the user joined the group";
                         readonly type: "string";
                         readonly format: "date-time";
+                        readonly example: "2023-06-30T11:41:00.123Z";
                     };
                     readonly createdBy: {
+                        readonly description: "The username of the user who added this user to this group";
                         readonly type: "string";
                         readonly nullable: true;
+                        readonly example: "admin";
                     };
                     readonly user: {
                         readonly $ref: "#/components/schemas/userSchema";
@@ -74,50 +96,88 @@ export declare const groupSchema: {
                             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: {};
@@ -129,50 +189,88 @@ export declare const groupSchema: {
                 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/group-schema.js

@@ -6,50 +6,67 @@ const user_schema_1 = require("./user-schema");
 exports.groupSchema = {
     $id: '#/components/schemas/groupSchema',
     type: 'object',
-    additionalProperties: true,
+    additionalProperties: false,
     required: ['name'],
+    description: 'A detailed information about a user group',
     properties: {
         id: {
-            type: 'number',
+            description: 'The group id',
+            type: 'integer',
+            example: 1,
         },
         name: {
+            description: 'The name of the group',
             type: 'string',
+            example: 'DX team',
         },
         description: {
+            description: 'A custom description of the group',
             type: 'string',
             nullable: true,
+            example: 'Current members of the DX squad',
         },
         mappingsSSO: {
+            description: 'A list of SSO groups that should map to this Unleash group',
             type: 'array',
             items: {
                 type: 'string',
             },
+            example: ['SSOGroup1', 'SSOGroup2'],
         },
         rootRole: {
             type: 'number',
             nullable: true,
-            description: 'A role id that is used as the root role for all users in this group. This can be either the id of the Editor or Admin role.',
+            description: 'A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role.',
+            example: 1,
         },
         createdBy: {
+            description: 'A user who created this group',
             type: 'string',
             nullable: true,
+            example: 'admin',
         },
         createdAt: {
+            description: 'When was this group created',
             type: 'string',
             format: 'date-time',
             nullable: true,
+            example: '2023-06-30T11:41:00.123Z',
         },
         users: {
             type: 'array',
+            description: 'A list of users belonging to this group',
             items: {
                 $ref: '#/components/schemas/groupUserModelSchema',
             },
         },
         projects: {
+            description: 'A list of projects where this group is used',
             type: 'array',
             items: {
                 type: 'string',
             },
+            example: ['default', 'my-project'],
         },
     },
     components: {

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

@@ -1 +1 @@
-{"version":3,"file":"group-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/group-schema.ts"],"names":[],"mappings":";;;AACA,uEAAiE;AACjE,+CAA2C;AAE9B,QAAA,WAAW,GAAG;IACvB,GAAG,EAAE,kCAAkC;IACvC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACR,EAAE,EAAE;YACA,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EACP,6HAA6H;SACpI;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACjB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;SACjB;QACD,KAAK,EAAE;YACH,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,2CAA2C;aACpD;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,oBAAoB,EAApB,8CAAoB;YACpB,UAAU,EAAV,wBAAU;SACb;KACJ;CACK,CAAC"}
+{"version":3,"file":"group-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/group-schema.ts"],"names":[],"mappings":";;;AACA,uEAAiE;AACjE,+CAA2C;AAE9B,QAAA,WAAW,GAAG;IACvB,GAAG,EAAE,kCAAkC;IACvC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,WAAW,EAAE,2CAA2C;IACxD,UAAU,EAAE;QACR,EAAE,EAAE;YACA,WAAW,EAAE,cAAc;YAC3B,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;SACb;QACD,IAAI,EAAE;YACF,WAAW,EAAE,uBAAuB;YACpC,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,SAAS;SACrB;QACD,WAAW,EAAE;YACT,WAAW,EAAE,mCAAmC;YAChD,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,iCAAiC;SAC7C;QACD,WAAW,EAAE;YACT,WAAW,EACP,4DAA4D;YAChE,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;YACD,OAAO,EAAE,CAAC,WAAW,EAAE,WAAW,CAAC;SACtC;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EACP,qIAAqI;YACzI,OAAO,EAAE,CAAC;SACb;QACD,SAAS,EAAE;YACP,WAAW,EAAE,+BAA+B;YAC5C,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,OAAO;SACnB;QACD,SAAS,EAAE;YACP,WAAW,EAAE,6BAA6B;YAC1C,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;SACtC;QACD,KAAK,EAAE;YACH,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,yCAAyC;YACtD,KAAK,EAAE;gBACH,IAAI,EAAE,2CAA2C;aACpD;SACJ;QACD,QAAQ,EAAE;YACN,WAAW,EAAE,6CAA6C;YAC1D,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;YACD,OAAO,EAAE,CAAC,SAAS,EAAE,YAAY,CAAC;SACrC;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,oBAAoB,EAApB,8CAAoB;YACpB,UAAU,EAAV,wBAAU;SACb;KACJ;CACK,CAAC"}