unleash-server 5.2.7 → 5.3.0

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

@@ -4,40 +4,83 @@ export declare const eventSchema: {
     readonly type: "object";
     readonly additionalProperties: false;
     readonly required: readonly ["id", "createdAt", "type", "createdBy"];
+    readonly description: "An event describing something happening in the system";
     readonly properties: {
         readonly id: {
             readonly type: "integer";
             readonly minimum: 1;
+            readonly description: "The ID of the event. An increasing natural number.";
         };
         readonly createdAt: {
             readonly type: "string";
             readonly format: "date-time";
+            readonly description: "The time the event happened as a RFC 3339-conformant timestamp.";
+            readonly example: "2023-07-05T12:56:00.000Z";
         };
         readonly type: {
             readonly type: "string";
+            readonly description: "What [type](https://docs.getunleash.io/reference/api/legacy/unleash/admin/events#event-type-description) of event this is";
+            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 createdBy: {
             readonly type: "string";
+            readonly description: "Which user created this event";
+            readonly example: "johndoe";
         };
         readonly environment: {
             readonly type: "string";
+            readonly description: "The feature toggle environment the event relates to, if applicable.";
             readonly nullable: true;
+            readonly example: "development";
         };
         readonly project: {
             readonly type: "string";
             readonly nullable: true;
+            readonly description: "The project the event relates to, if applicable.";
+            readonly example: "default";
         };
         readonly featureName: {
             readonly type: "string";
             readonly nullable: true;
+            readonly description: "The name of the feature toggle the event relates to, if applicable.";
+            readonly example: "my.first.feature";
         };
         readonly data: {
             readonly type: "object";
             readonly nullable: true;
+            readonly 'x-enforcer-exception-skip-codes': "WSCH006";
+            readonly additionalProperties: true;
+            readonly description: "Extra associated data related to the event, such as feature toggle state, segment configuration, etc., if applicable.";
+            readonly example: {
+                readonly name: "new-feature";
+                readonly description: "Toggle description";
+                readonly type: "release";
+                readonly project: "my-project";
+                readonly stale: false;
+                readonly variants: readonly [];
+                readonly createdAt: "2022-05-31T13:32:20.547Z";
+                readonly lastSeenAt: any;
+                readonly impressionData: true;
+            };
         };
         readonly preData: {
+            readonly description: "Data relating to the previous state of the event's subject.";
             readonly type: "object";
             readonly nullable: true;
+            readonly 'x-enforcer-exception-skip-codes': "WSCH006";
+            readonly additionalProperties: true;
+            readonly example: {
+                readonly name: "new-feature";
+                readonly description: "Toggle description";
+                readonly type: "release";
+                readonly project: "my-project";
+                readonly stale: false;
+                readonly variants: readonly [];
+                readonly createdAt: "2022-05-31T13:32:20.547Z";
+                readonly lastSeenAt: any;
+                readonly impressionData: true;
+            };
         };
         readonly tags: {
             readonly type: "array";
@@ -45,6 +88,7 @@ export declare const eventSchema: {
                 readonly $ref: "#/components/schemas/tagSchema";
             };
             readonly nullable: true;
+            readonly description: "Any tags related to the event, if applicable.";
         };
     };
     readonly components: {
@@ -74,6 +118,92 @@ export declare const eventSchema: {
                 };
                 readonly components: {};
             };
+            readonly variantSchema: {
+                readonly $id: "#/components/schemas/variantSchema";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly description: "A variant allows for further separation of users into segments. See [our excellent documentation](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) for a more detailed description";
+                readonly required: readonly ["name", "weight"];
+                readonly properties: {
+                    readonly name: {
+                        readonly type: "string";
+                        readonly description: "The variants name. Is unique for this feature toggle";
+                        readonly example: "blue_group";
+                    };
+                    readonly weight: {
+                        readonly type: "number";
+                        readonly description: "The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
+                        readonly minimum: 0;
+                        readonly maximum: 1000;
+                    };
+                    readonly weightType: {
+                        readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
+                        readonly type: "string";
+                        readonly example: "variable";
+                        readonly enum: readonly ["variable", "fix"];
+                    };
+                    readonly stickiness: {
+                        readonly type: "string";
+                        readonly description: "[Stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) is how Unleash guarantees that the same user gets the same variant every time";
+                        readonly example: "custom.context.field";
+                    };
+                    readonly payload: {
+                        readonly type: "object";
+                        readonly required: readonly ["type", "value"];
+                        readonly description: "Extra data configured for this variant";
+                        readonly 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 overrides: {
+                        readonly description: "Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.";
+                        readonly type: "array";
+                        readonly items: {
+                            readonly $ref: "#/components/schemas/overrideSchema";
+                        };
+                    };
+                };
+                readonly components: {
+                    readonly schemas: {
+                        readonly overrideSchema: {
+                            readonly $id: "#/components/schemas/overrideSchema";
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly required: readonly ["contextName", "values"];
+                            readonly description: "An override for deciding which variant should be assigned to a user based on the context name";
+                            readonly properties: {
+                                readonly contextName: {
+                                    readonly description: "The name of the context field used to determine overrides";
+                                    readonly type: "string";
+                                    readonly example: "userId";
+                                };
+                                readonly values: {
+                                    readonly description: "Which values that should be overriden";
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "string";
+                                    };
+                                    readonly example: readonly ["red", "blue"];
+                                };
+                            };
+                            readonly components: {};
+                        };
+                    };
+                };
+            };
         };
     };
 };

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

@@ -2,51 +2,91 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.eventSchema = void 0;
 const tag_schema_1 = require("./tag-schema");
+const types_1 = require("../../types");
+const variant_schema_1 = require("./variant-schema");
+const eventDataSchema = {
+    type: 'object',
+    nullable: true,
+    'x-enforcer-exception-skip-codes': 'WSCH006',
+    additionalProperties: true,
+    description: 'Extra associated data related to the event, such as feature toggle state, segment configuration, etc., if applicable.',
+    example: {
+        name: 'new-feature',
+        description: 'Toggle description',
+        type: 'release',
+        project: 'my-project',
+        stale: false,
+        variants: [],
+        createdAt: '2022-05-31T13:32:20.547Z',
+        lastSeenAt: null,
+        impressionData: true,
+    },
+};
 exports.eventSchema = {
     $id: '#/components/schemas/eventSchema',
     type: 'object',
     additionalProperties: false,
     required: ['id', 'createdAt', 'type', 'createdBy'],
+    description: 'An event describing something happening in the system',
     properties: {
         id: {
             type: 'integer',
             minimum: 1,
+            description: 'The ID of the event. An increasing natural number.',
         },
         createdAt: {
             type: 'string',
             format: 'date-time',
+            description: 'The time the event happened as a RFC 3339-conformant timestamp.',
+            example: '2023-07-05T12:56:00.000Z',
         },
         type: {
             type: 'string',
+            description: 'What [type](https://docs.getunleash.io/reference/api/legacy/unleash/admin/events#event-type-description) of event this is',
+            enum: types_1.IEventTypes,
+            example: 'feature-created',
         },
         createdBy: {
             type: 'string',
+            description: 'Which user created this event',
+            example: 'johndoe',
         },
         environment: {
             type: 'string',
+            description: 'The feature toggle environment the event relates to, if applicable.',
             nullable: true,
+            example: 'development',
         },
         project: {
             type: 'string',
             nullable: true,
+            description: 'The project the event relates to, if applicable.',
+            example: 'default',
         },
         featureName: {
             type: 'string',
             nullable: true,
+            description: 'The name of the feature toggle the event relates to, if applicable.',
+            example: 'my.first.feature',
+        },
+        data: eventDataSchema,
+        preData: {
+            ...eventDataSchema,
+            description: "Data relating to the previous state of the event's subject.",
         },
-        data: { type: 'object', nullable: true },
-        preData: { type: 'object', nullable: true },
         tags: {
             type: 'array',
             items: {
                 $ref: tag_schema_1.tagSchema.$id,
             },
             nullable: true,
+            description: 'Any tags related to the event, if applicable.',
         },
     },
     components: {
         schemas: {
             tagSchema: tag_schema_1.tagSchema,
+            variantSchema: variant_schema_1.variantSchema,
         },
     },
 };

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

@@ -1 +1 @@
-{"version":3,"file":"event-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/event-schema.ts"],"names":[],"mappings":";;;AACA,6CAAyC;AAE5B,QAAA,WAAW,GAAG;IACvB,GAAG,EAAE,kCAAkC;IACvC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,CAAC;IAClD,UAAU,EAAE;QACR,EAAE,EAAE;YACA,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;SACb;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;SACtB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACjB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACjB;QACD,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACxC,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QAC3C,IAAI,EAAE;YACF,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,sBAAS,CAAC,GAAG;aACtB;YACD,QAAQ,EAAE,IAAI;SACjB;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,SAAS,EAAT,sBAAS;SACZ;KACJ;CACK,CAAC"}
+{"version":3,"file":"event-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/event-schema.ts"],"names":[],"mappings":";;;AACA,6CAAyC;AACzC,uCAA0C;AAC1C,qDAAiD;AAEjD,MAAM,eAAe,GAAG;IACpB,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,IAAI;IACd,iCAAiC,EAAE,SAAS;IAC5C,oBAAoB,EAAE,IAAI;IAC1B,WAAW,EACP,uHAAuH;IAC3H,OAAO,EAAE;QACL,IAAI,EAAE,aAAa;QACnB,WAAW,EAAE,oBAAoB;QACjC,IAAI,EAAE,SAAS;QACf,OAAO,EAAE,YAAY;QACrB,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,EAAE;QACZ,SAAS,EAAE,0BAA0B;QACrC,UAAU,EAAE,IAAI;QAChB,cAAc,EAAE,IAAI;KACvB;CACK,CAAC;AACE,QAAA,WAAW,GAAG;IACvB,GAAG,EAAE,kCAAkC;IACvC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,CAAC;IAClD,WAAW,EAAE,uDAAuD;IACpE,UAAU,EAAE;QACR,EAAE,EAAE;YACA,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,WAAW,EAAE,oDAAoD;SACpE;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,WAAW,EACP,iEAAiE;YACrE,OAAO,EAAE,0BAA0B;SACtC;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,2HAA2H;YAC/H,IAAI,EAAE,mBAAW;YACjB,OAAO,EAAE,iBAAiB;SAC7B;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,+BAA+B;YAC5C,OAAO,EAAE,SAAS;SACrB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,qEAAqE;YACzE,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,aAAa;SACzB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,kDAAkD;YAC/D,OAAO,EAAE,SAAS;SACrB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EACP,qEAAqE;YACzE,OAAO,EAAE,kBAAkB;SAC9B;QACD,IAAI,EAAE,eAAe;QACrB,OAAO,EAAE;YACL,GAAG,eAAe;YAClB,WAAW,EACP,6DAA6D;SACpE;QACD,IAAI,EAAE;YACF,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,sBAAS,CAAC,GAAG;aACtB;YACD,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,+CAA+C;SAC/D;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,SAAS,EAAT,sBAAS;YACT,aAAa,EAAb,8BAAa;SAChB;KACJ;CACK,CAAC"}

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

@@ -4,12 +4,17 @@ export declare const eventsSchema: {
     readonly type: "object";
     readonly additionalProperties: false;
     readonly required: readonly ["version", "events"];
+    readonly description: "A list of events that has happened in the system";
     readonly properties: {
         readonly version: {
             readonly type: "integer";
             readonly minimum: 1;
+            readonly enum: readonly [1];
+            readonly description: "The api version of this response. A natural increasing number. Only increases if format changes";
+            readonly example: 1;
         };
         readonly events: {
+            readonly description: "The list of events";
             readonly type: "array";
             readonly items: {
                 readonly $ref: "#/components/schemas/eventSchema";
@@ -17,7 +22,9 @@ export declare const eventsSchema: {
         };
         readonly totalEvents: {
             readonly type: "integer";
+            readonly description: "The total count of events";
             readonly minimum: 0;
+            readonly example: 842;
         };
     };
     readonly components: {
@@ -27,40 +34,83 @@ export declare const eventsSchema: {
                 readonly type: "object";
                 readonly additionalProperties: false;
                 readonly required: readonly ["id", "createdAt", "type", "createdBy"];
+                readonly description: "An event describing something happening in the system";
                 readonly properties: {
                     readonly id: {
                         readonly type: "integer";
                         readonly minimum: 1;
+                        readonly description: "The ID of the event. An increasing natural number.";
                     };
                     readonly createdAt: {
                         readonly type: "string";
                         readonly format: "date-time";
+                        readonly description: "The time the event happened as a RFC 3339-conformant timestamp.";
+                        readonly example: "2023-07-05T12:56:00.000Z";
                     };
                     readonly type: {
                         readonly type: "string";
+                        readonly description: "What [type](https://docs.getunleash.io/reference/api/legacy/unleash/admin/events#event-type-description) of event this is";
+                        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 createdBy: {
                         readonly type: "string";
+                        readonly description: "Which user created this event";
+                        readonly example: "johndoe";
                     };
                     readonly environment: {
                         readonly type: "string";
+                        readonly description: "The feature toggle environment the event relates to, if applicable.";
                         readonly nullable: true;
+                        readonly example: "development";
                     };
                     readonly project: {
                         readonly type: "string";
                         readonly nullable: true;
+                        readonly description: "The project the event relates to, if applicable.";
+                        readonly example: "default";
                     };
                     readonly featureName: {
                         readonly type: "string";
                         readonly nullable: true;
+                        readonly description: "The name of the feature toggle the event relates to, if applicable.";
+                        readonly example: "my.first.feature";
                     };
                     readonly data: {
                         readonly type: "object";
                         readonly nullable: true;
+                        readonly 'x-enforcer-exception-skip-codes': "WSCH006";
+                        readonly additionalProperties: true;
+                        readonly description: "Extra associated data related to the event, such as feature toggle state, segment configuration, etc., if applicable.";
+                        readonly example: {
+                            readonly name: "new-feature";
+                            readonly description: "Toggle description";
+                            readonly type: "release";
+                            readonly project: "my-project";
+                            readonly stale: false;
+                            readonly variants: readonly [];
+                            readonly createdAt: "2022-05-31T13:32:20.547Z";
+                            readonly lastSeenAt: any;
+                            readonly impressionData: true;
+                        };
                     };
                     readonly preData: {
+                        readonly description: "Data relating to the previous state of the event's subject.";
                         readonly type: "object";
                         readonly nullable: true;
+                        readonly 'x-enforcer-exception-skip-codes': "WSCH006";
+                        readonly additionalProperties: true;
+                        readonly example: {
+                            readonly name: "new-feature";
+                            readonly description: "Toggle description";
+                            readonly type: "release";
+                            readonly project: "my-project";
+                            readonly stale: false;
+                            readonly variants: readonly [];
+                            readonly createdAt: "2022-05-31T13:32:20.547Z";
+                            readonly lastSeenAt: any;
+                            readonly impressionData: true;
+                        };
                     };
                     readonly tags: {
                         readonly type: "array";
@@ -68,6 +118,7 @@ export declare const eventsSchema: {
                             readonly $ref: "#/components/schemas/tagSchema";
                         };
                         readonly nullable: true;
+                        readonly description: "Any tags related to the event, if applicable.";
                     };
                 };
                 readonly components: {
@@ -97,6 +148,92 @@ export declare const eventsSchema: {
                             };
                             readonly components: {};
                         };
+                        readonly variantSchema: {
+                            readonly $id: "#/components/schemas/variantSchema";
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly description: "A variant allows for further separation of users into segments. See [our excellent documentation](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) for a more detailed description";
+                            readonly required: readonly ["name", "weight"];
+                            readonly properties: {
+                                readonly name: {
+                                    readonly type: "string";
+                                    readonly description: "The variants name. Is unique for this feature toggle";
+                                    readonly example: "blue_group";
+                                };
+                                readonly weight: {
+                                    readonly type: "number";
+                                    readonly description: "The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight) for more information";
+                                    readonly minimum: 0;
+                                    readonly maximum: 1000;
+                                };
+                                readonly weightType: {
+                                    readonly description: "Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000";
+                                    readonly type: "string";
+                                    readonly example: "variable";
+                                    readonly enum: readonly ["variable", "fix"];
+                                };
+                                readonly stickiness: {
+                                    readonly type: "string";
+                                    readonly description: "[Stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) is how Unleash guarantees that the same user gets the same variant every time";
+                                    readonly example: "custom.context.field";
+                                };
+                                readonly payload: {
+                                    readonly type: "object";
+                                    readonly required: readonly ["type", "value"];
+                                    readonly description: "Extra data configured for this variant";
+                                    readonly 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 overrides: {
+                                    readonly description: "Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence.";
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly $ref: "#/components/schemas/overrideSchema";
+                                    };
+                                };
+                            };
+                            readonly components: {
+                                readonly schemas: {
+                                    readonly overrideSchema: {
+                                        readonly $id: "#/components/schemas/overrideSchema";
+                                        readonly type: "object";
+                                        readonly additionalProperties: false;
+                                        readonly required: readonly ["contextName", "values"];
+                                        readonly description: "An override for deciding which variant should be assigned to a user based on the context name";
+                                        readonly properties: {
+                                            readonly contextName: {
+                                                readonly description: "The name of the context field used to determine overrides";
+                                                readonly type: "string";
+                                                readonly example: "userId";
+                                            };
+                                            readonly values: {
+                                                readonly description: "Which values that should be overriden";
+                                                readonly type: "array";
+                                                readonly items: {
+                                                    readonly type: "string";
+                                                };
+                                                readonly example: readonly ["red", "blue"];
+                                            };
+                                        };
+                                        readonly components: {};
+                                    };
+                                };
+                            };
+                        };
                     };
                 };
             };

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

@@ -8,18 +8,25 @@ exports.eventsSchema = {
     type: 'object',
     additionalProperties: false,
     required: ['version', 'events'],
+    description: 'A list of events that has happened in the system',
     properties: {
         version: {
             type: 'integer',
             minimum: 1,
+            enum: [1],
+            description: 'The api version of this response. A natural increasing number. Only increases if format changes',
+            example: 1,
         },
         events: {
+            description: 'The list of events',
             type: 'array',
             items: { $ref: event_schema_1.eventSchema.$id },
         },
         totalEvents: {
             type: 'integer',
+            description: 'The total count of events',
             minimum: 0,
+            example: 842,
         },
     },
     components: {

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

@@ -1 +1 @@
-{"version":3,"file":"events-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/events-schema.ts"],"names":[],"mappings":";;;AACA,iDAA6C;AAC7C,6CAAyC;AAE5B,QAAA,YAAY,GAAG;IACxB,GAAG,EAAE,mCAAmC;IACxC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;IAC/B,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;SACb;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,0BAAW,CAAC,GAAG,EAAE;SACnC;QACD,WAAW,EAAE;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;SACb;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,WAAW,EAAX,0BAAW;YACX,SAAS,EAAT,sBAAS;SACZ;KACJ;CACK,CAAC"}
+{"version":3,"file":"events-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/events-schema.ts"],"names":[],"mappings":";;;AACA,iDAA6C;AAC7C,6CAAyC;AAE5B,QAAA,YAAY,GAAG;IACxB,GAAG,EAAE,mCAAmC;IACxC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;IAC/B,WAAW,EAAE,kDAAkD;IAC/D,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,CAAC;YACV,IAAI,EAAE,CAAC,CAAC,CAAC;YACT,WAAW,EACP,iGAAiG;YACrG,OAAO,EAAE,CAAC;SACb;QACD,MAAM,EAAE;YACJ,WAAW,EAAE,oBAAoB;YACjC,IAAI,EAAE,OAAO;YACb,KAAK,EAAE,EAAE,IAAI,EAAE,0BAAW,CAAC,GAAG,EAAE;SACnC;QACD,WAAW,EAAE;YACT,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,2BAA2B;YACxC,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,GAAG;SACf;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,WAAW,EAAX,0BAAW;YACX,SAAS,EAAT,sBAAS;SACZ;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/export-query-schema.d.ts

@@ -4,12 +4,17 @@ export declare const exportQuerySchema: {
     readonly type: "object";
     readonly additionalProperties: true;
     readonly required: readonly ["environment"];
+    readonly description: "Available query parameters for  the [deprecated export/import](https://docs.getunleash.io/reference/deploy/import-export) functionality.";
     readonly properties: {
         readonly environment: {
             readonly type: "string";
+            readonly example: "development";
+            readonly description: "The environment to export from";
         };
         readonly downloadFile: {
             readonly type: "boolean";
+            readonly example: true;
+            readonly description: "Whether to return a downloadable file";
         };
     };
     readonly oneOf: readonly [{
@@ -17,6 +22,7 @@ export declare const exportQuerySchema: {
         readonly properties: {
             readonly features: {
                 readonly type: "array";
+                readonly example: readonly ["MyAwesomeFeature"];
                 readonly items: {
                     readonly type: "string";
                     readonly minLength: 1;
@@ -29,6 +35,7 @@ export declare const exportQuerySchema: {
         readonly properties: {
             readonly tag: {
                 readonly type: "string";
+                readonly example: "release";
                 readonly description: "Selects features to export by tag. Takes precedence over the features field.";
             };
         };

package/dist/lib/openapi/spec/export-query-schema.js

@@ -6,12 +6,17 @@ exports.exportQuerySchema = {
     type: 'object',
     additionalProperties: true,
     required: ['environment'],
+    description: 'Available query parameters for  the [deprecated export/import](https://docs.getunleash.io/reference/deploy/import-export) functionality.',
     properties: {
         environment: {
             type: 'string',
+            example: 'development',
+            description: 'The environment to export from',
         },
         downloadFile: {
             type: 'boolean',
+            example: true,
+            description: 'Whether to return a downloadable file',
         },
     },
     oneOf: [
@@ -20,6 +25,7 @@ exports.exportQuerySchema = {
             properties: {
                 features: {
                     type: 'array',
+                    example: ['MyAwesomeFeature'],
                     items: {
                         type: 'string',
                         minLength: 1,
@@ -33,6 +39,7 @@ exports.exportQuerySchema = {
             properties: {
                 tag: {
                     type: 'string',
+                    example: 'release',
                     description: 'Selects features to export by tag. Takes precedence over the features field.',
                 },
             },

package/dist/lib/openapi/spec/export-query-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"export-query-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/export-query-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAG;IAC7B,GAAG,EAAE,wCAAwC;IAC7C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,QAAQ,EAAE,CAAC,aAAa,CAAC;IACzB,UAAU,EAAE;QACR,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,YAAY,EAAE;YACV,IAAI,EAAE,SAAS;SAClB;KACJ;IACD,KAAK,EAAE;QACH;YACI,QAAQ,EAAE,CAAC,UAAU,CAAC;YACtB,UAAU,EAAE;gBACR,QAAQ,EAAE;oBACN,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,QAAQ;wBACd,SAAS,EAAE,CAAC;qBACf;oBACD,WAAW,EAAE,qCAAqC;iBACrD;aACJ;SACJ;QACD;YACI,QAAQ,EAAE,CAAC,KAAK,CAAC;YACjB,UAAU,EAAE;gBACR,GAAG,EAAE;oBACD,IAAI,EAAE,QAAQ;oBACd,WAAW,EACP,8EAA8E;iBACrF;aACJ;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE,EAAE;KACd;CACK,CAAC"}
+{"version":3,"file":"export-query-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/export-query-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAG;IAC7B,GAAG,EAAE,wCAAwC;IAC7C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,IAAI;IAC1B,QAAQ,EAAE,CAAC,aAAa,CAAC;IACzB,WAAW,EACP,0IAA0I;IAC9I,UAAU,EAAE;QACR,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,gCAAgC;SAChD;QACD,YAAY,EAAE;YACV,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,uCAAuC;SACvD;KACJ;IACD,KAAK,EAAE;QACH;YACI,QAAQ,EAAE,CAAC,UAAU,CAAC;YACtB,UAAU,EAAE;gBACR,QAAQ,EAAE;oBACN,IAAI,EAAE,OAAO;oBACb,OAAO,EAAE,CAAC,kBAAkB,CAAC;oBAC7B,KAAK,EAAE;wBACH,IAAI,EAAE,QAAQ;wBACd,SAAS,EAAE,CAAC;qBACf;oBACD,WAAW,EAAE,qCAAqC;iBACrD;aACJ;SACJ;QACD;YACI,QAAQ,EAAE,CAAC,KAAK,CAAC;YACjB,UAAU,EAAE;gBACR,GAAG,EAAE;oBACD,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,SAAS;oBAClB,WAAW,EACP,8EAA8E;iBACrF;aACJ;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE,EAAE;KACd;CACK,CAAC"}