unleash-server 5.2.7 → 5.3.0

package/dist/lib/openapi/spec/ui-config-schema.d.ts

@@ -3,52 +3,87 @@ export declare const uiConfigSchema: {
     readonly $id: "#/components/schemas/uiConfigSchema";
     readonly type: "object";
     readonly additionalProperties: false;
+    readonly description: "A collection of properties used to configure the Unleash Admin UI.";
     readonly required: readonly ["version", "unleashUrl", "baseUriPath", "versionInfo"];
     readonly properties: {
         readonly slogan: {
             readonly type: "string";
+            readonly description: "The slogan to display in the UI footer.";
+            readonly example: "The enterprise-ready feature toggle service.";
         };
         readonly name: {
             readonly type: "string";
+            readonly description: "The name of this Unleash instance. Used to build the text in the footer.";
+            readonly example: "Unleash enterprise";
         };
         readonly version: {
             readonly type: "string";
+            readonly description: "The current version of Unleash";
+            readonly example: "5.3.0-main";
         };
         readonly environment: {
             readonly type: "string";
+            readonly description: "What kind of Unleash instance it is: Enterprise, Pro, or Open source";
+            readonly example: "Enterprise";
         };
         readonly unleashUrl: {
             readonly type: "string";
+            readonly description: "The URL of the Unleash instance.";
+            readonly example: "https://unleash.mycompany.com/enterprise";
         };
         readonly baseUriPath: {
             readonly type: "string";
+            readonly description: "The base URI path at which this Unleash instance is listening.";
+            readonly example: "/enterprise";
         };
         readonly disablePasswordAuth: {
             readonly type: "boolean";
+            readonly description: "Whether password authentication should be disabled or not.";
+            readonly example: false;
         };
         readonly emailEnabled: {
             readonly type: "boolean";
+            readonly description: "Whether this instance can send out emails or not.";
+            readonly example: true;
         };
         readonly maintenanceMode: {
             readonly type: "boolean";
+            readonly description: "Whether maintenance mode is currently active or not.";
+            readonly example: false;
         };
         readonly segmentValuesLimit: {
             readonly type: "number";
+            readonly description: "The maximum number of values that can be used in a single segment.";
+            readonly example: 1000;
         };
         readonly strategySegmentsLimit: {
             readonly type: "number";
+            readonly description: "The maximum number of segments that can be applied to a single strategy.";
+            readonly example: 5;
         };
         readonly networkViewEnabled: {
             readonly type: "boolean";
+            readonly description: "Whether to enable the Unleash network view or not.";
+            readonly example: true;
         };
         readonly frontendApiOrigins: {
             readonly type: "array";
+            readonly description: "The list of origins that the front-end API should accept requests from.";
+            readonly example: readonly ["*"];
             readonly items: {
                 readonly type: "string";
             };
         };
         readonly flags: {
             readonly type: "object";
+            readonly description: "Additional (largely experimental) features that are enabled in this Unleash instance.";
+            readonly example: {
+                readonly messageBanner: {
+                    readonly name: "disabled";
+                    readonly enabled: false;
+                };
+                readonly featuresExportImport: true;
+            };
             readonly additionalProperties: {
                 readonly anyOf: readonly [{
                     readonly type: "boolean";
@@ -58,6 +93,19 @@ export declare const uiConfigSchema: {
             };
         };
         readonly links: {
+            readonly description: "Relevant links to use in the UI.";
+            readonly example: readonly [{
+                readonly value: "Documentation";
+                readonly icon: "library_books";
+                readonly href: "https://docs.getunleash.io/docs";
+                readonly title: "User documentation";
+            }, {
+                readonly value: "GitHub";
+                readonly icon: "c_github";
+                readonly href: "https://github.com/Unleash/unleash";
+                readonly title: "Source code on GitHub";
+            }];
+            readonly 'x-enforcer-exception-skip-codes': "WSCH006";
             readonly type: "array";
             readonly items: {
                 readonly type: "object";
@@ -65,6 +113,8 @@ export declare const uiConfigSchema: {
         };
         readonly authenticationType: {
             readonly type: "string";
+            readonly description: "The type of authentication enabled for this Unleash instance";
+            readonly example: "enterprise";
             readonly enum: readonly ["open-source", "demo", "enterprise", "hosted", "custom", "none"];
         };
         readonly versionInfo: {
@@ -77,16 +127,22 @@ export declare const uiConfigSchema: {
                 readonly $id: "#/components/schemas/versionSchema";
                 readonly type: "object";
                 readonly additionalProperties: false;
-                readonly required: readonly ["current", "latest", "isLatest", "instanceId"];
+                readonly description: "Detailed information about an Unleash version";
+                readonly required: readonly ["current", "latest", "isLatest"];
                 readonly properties: {
                     readonly current: {
                         readonly type: "object";
                         readonly additionalProperties: false;
+                        readonly description: "The current version of Unleash.";
                         readonly properties: {
                             readonly oss: {
+                                readonly description: "The OSS version used when building this Unleash instance, represented as a git revision belonging to the [main Unleash git repo](https://github.com/Unleash/unleash/)";
+                                readonly example: "5.3.0-main";
                                 readonly type: "string";
                             };
                             readonly enterprise: {
+                                readonly description: "The Enterpris version of Unleash used to build this instance, represented as a git revision belonging to the [Unleash Enterprise](https://github.com/ivarconr/unleash-enterprise) repository. Will be an empty string if no enterprise version was used,";
+                                readonly example: "5.3.0-main+2105.45ed03c9";
                                 readonly type: "string";
                             };
                         };
@@ -94,20 +150,29 @@ export declare const uiConfigSchema: {
                     readonly latest: {
                         readonly type: "object";
                         readonly additionalProperties: false;
+                        readonly description: "Information about the latest available Unleash releases. Will be an empty object if no data is available.";
                         readonly properties: {
                             readonly oss: {
+                                readonly description: "The latest available OSS version of Unleash";
                                 readonly type: "string";
+                                readonly example: "5.1.5";
                             };
                             readonly enterprise: {
+                                readonly description: "The latest available Enterprise version of Unleash";
                                 readonly type: "string";
+                                readonly example: "5.1.5";
                             };
                         };
                     };
                     readonly isLatest: {
                         readonly type: "boolean";
+                        readonly description: "Whether the Unleash server is running the latest release (`true`) or if there are updates available (`false`)";
+                        readonly example: true;
                     };
                     readonly instanceId: {
                         readonly type: "string";
+                        readonly description: "The instance identifier of the Unleash instance";
+                        readonly example: "0d652a82-43db-4144-8e02-864b0b030710";
                     };
                 };
                 readonly components: {};
@@ -116,22 +181,33 @@ export declare const uiConfigSchema: {
                 readonly $id: "#/components/schemas/variantFlagSchema";
                 readonly type: "object";
                 readonly additionalProperties: false;
+                readonly description: "A representation of an evaluated Unleash feature variant.";
                 readonly properties: {
                     readonly name: {
+                        readonly description: "The name of the variant. Will always be disabled if `enabled` is false.";
+                        readonly example: "blue";
                         readonly type: "string";
                     };
                     readonly enabled: {
                         readonly type: "boolean";
+                        readonly description: "Whether the variant is enabled or not.";
+                        readonly example: true;
                     };
                     readonly payload: {
                         readonly type: "object";
+                        readonly description: "Additional data associated with this variant.";
                         readonly additionalProperties: false;
                         readonly properties: {
                             readonly type: {
+                                readonly description: "The type of data contained.";
                                 readonly type: "string";
+                                readonly enum: readonly ["string", "json", "csv"];
+                                readonly example: "json";
                             };
                             readonly value: {
+                                readonly description: "The actual associated data";
                                 readonly type: "string";
+                                readonly example: "{ \"starter\": \"squirtle\" }";
                             };
                         };
                     };

package/dist/lib/openapi/spec/ui-config-schema.js

@@ -7,52 +7,87 @@ exports.uiConfigSchema = {
     $id: '#/components/schemas/uiConfigSchema',
     type: 'object',
     additionalProperties: false,
+    description: 'A collection of properties used to configure the Unleash Admin UI.',
     required: ['version', 'unleashUrl', 'baseUriPath', 'versionInfo'],
     properties: {
         slogan: {
             type: 'string',
+            description: 'The slogan to display in the UI footer.',
+            example: 'The enterprise-ready feature toggle service.',
         },
         name: {
             type: 'string',
+            description: 'The name of this Unleash instance. Used to build the text in the footer.',
+            example: 'Unleash enterprise',
         },
         version: {
             type: 'string',
+            description: 'The current version of Unleash',
+            example: '5.3.0-main',
         },
         environment: {
             type: 'string',
+            description: 'What kind of Unleash instance it is: Enterprise, Pro, or Open source',
+            example: 'Enterprise',
         },
         unleashUrl: {
             type: 'string',
+            description: 'The URL of the Unleash instance.',
+            example: 'https://unleash.mycompany.com/enterprise',
         },
         baseUriPath: {
             type: 'string',
+            description: 'The base URI path at which this Unleash instance is listening.',
+            example: '/enterprise',
         },
         disablePasswordAuth: {
             type: 'boolean',
+            description: 'Whether password authentication should be disabled or not.',
+            example: false,
         },
         emailEnabled: {
             type: 'boolean',
+            description: 'Whether this instance can send out emails or not.',
+            example: true,
         },
         maintenanceMode: {
             type: 'boolean',
+            description: 'Whether maintenance mode is currently active or not.',
+            example: false,
         },
         segmentValuesLimit: {
             type: 'number',
+            description: 'The maximum number of values that can be used in a single segment.',
+            example: 1000,
         },
         strategySegmentsLimit: {
             type: 'number',
+            description: 'The maximum number of segments that can be applied to a single strategy.',
+            example: 5,
         },
         networkViewEnabled: {
             type: 'boolean',
+            description: 'Whether to enable the Unleash network view or not.',
+            example: true,
         },
         frontendApiOrigins: {
             type: 'array',
+            description: 'The list of origins that the front-end API should accept requests from.',
+            example: ['*'],
             items: {
                 type: 'string',
             },
         },
         flags: {
             type: 'object',
+            description: 'Additional (largely experimental) features that are enabled in this Unleash instance.',
+            example: {
+                messageBanner: {
+                    name: 'disabled',
+                    enabled: false,
+                },
+                featuresExportImport: true,
+            },
             additionalProperties: {
                 anyOf: [
                     {
@@ -65,6 +100,22 @@ exports.uiConfigSchema = {
             },
         },
         links: {
+            description: 'Relevant links to use in the UI.',
+            example: [
+                {
+                    value: 'Documentation',
+                    icon: 'library_books',
+                    href: 'https://docs.getunleash.io/docs',
+                    title: 'User documentation',
+                },
+                {
+                    value: 'GitHub',
+                    icon: 'c_github',
+                    href: 'https://github.com/Unleash/unleash',
+                    title: 'Source code on GitHub',
+                },
+            ],
+            'x-enforcer-exception-skip-codes': 'WSCH006',
             type: 'array',
             items: {
                 type: 'object',
@@ -72,6 +123,8 @@ exports.uiConfigSchema = {
         },
         authenticationType: {
             type: 'string',
+            description: 'The type of authentication enabled for this Unleash instance',
+            example: 'enterprise',
             enum: [
                 'open-source',
                 'demo',

package/dist/lib/openapi/spec/ui-config-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"ui-config-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/ui-config-schema.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AACjD,+DAA0D;AAE7C,QAAA,cAAc,GAAG;IAC1B,GAAG,EAAE,qCAAqC;IAC1C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,CAAC;IACjE,UAAU,EAAE;QACR,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,mBAAmB,EAAE;YACjB,IAAI,EAAE,SAAS;SAClB;QACD,YAAY,EAAE;YACV,IAAI,EAAE,SAAS;SAClB;QACD,eAAe,EAAE;YACb,IAAI,EAAE,SAAS;SAClB;QACD,kBAAkB,EAAE;YAChB,IAAI,EAAE,QAAQ;SACjB;QACD,qBAAqB,EAAE;YACnB,IAAI,EAAE,QAAQ;SACjB;QACD,kBAAkB,EAAE;YAChB,IAAI,EAAE,SAAS;SAClB;QACD,kBAAkB,EAAE;YAChB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE;gBAClB,KAAK,EAAE;oBACH;wBACI,IAAI,EAAE,SAAS;qBAClB;oBACD;wBACI,IAAI,EAAE,wCAAwC;qBACjD;iBACJ;aACJ;SACJ;QACD,KAAK,EAAE;YACH,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;QACD,kBAAkB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE;gBACF,aAAa;gBACb,MAAM;gBACN,YAAY;gBACZ,QAAQ;gBACR,QAAQ;gBACR,MAAM;aACT;SACJ;QACD,WAAW,EAAE;YACT,IAAI,EAAE,oCAAoC;SAC7C;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,aAAa,EAAb,8BAAa;YACb,iBAAiB,EAAjB,uCAAiB;SACpB;KACJ;CACK,CAAC"}
+{"version":3,"file":"ui-config-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/ui-config-schema.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AACjD,+DAA0D;AAE7C,QAAA,cAAc,GAAG;IAC1B,GAAG,EAAE,qCAAqC;IAC1C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,oEAAoE;IACxE,QAAQ,EAAE,CAAC,SAAS,EAAE,YAAY,EAAE,aAAa,EAAE,aAAa,CAAC;IACjE,UAAU,EAAE;QACR,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,yCAAyC;YACtD,OAAO,EAAE,8CAA8C;SAC1D;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,0EAA0E;YAC9E,OAAO,EAAE,oBAAoB;SAChC;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,gCAAgC;YAC7C,OAAO,EAAE,YAAY;SACxB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,sEAAsE;YAC1E,OAAO,EAAE,YAAY;SACxB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,kCAAkC;YAC/C,OAAO,EAAE,0CAA0C;SACtD;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,gEAAgE;YACpE,OAAO,EAAE,aAAa;SACzB;QACD,mBAAmB,EAAE;YACjB,IAAI,EAAE,SAAS;YACf,WAAW,EACP,4DAA4D;YAChE,OAAO,EAAE,KAAK;SACjB;QACD,YAAY,EAAE;YACV,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,mDAAmD;YAChE,OAAO,EAAE,IAAI;SAChB;QACD,eAAe,EAAE;YACb,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,sDAAsD;YACnE,OAAO,EAAE,KAAK;SACjB;QACD,kBAAkB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,oEAAoE;YACxE,OAAO,EAAE,IAAI;SAChB;QACD,qBAAqB,EAAE;YACnB,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,0EAA0E;YAC9E,OAAO,EAAE,CAAC;SACb;QACD,kBAAkB,EAAE;YAChB,IAAI,EAAE,SAAS;YACf,WAAW,EAAE,oDAAoD;YACjE,OAAO,EAAE,IAAI;SAChB;QACD,kBAAkB,EAAE;YAChB,IAAI,EAAE,OAAO;YACb,WAAW,EACP,yEAAyE;YAC7E,OAAO,EAAE,CAAC,GAAG,CAAC;YACd,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,uFAAuF;YAC3F,OAAO,EAAE;gBACL,aAAa,EAAE;oBACX,IAAI,EAAE,UAAU;oBAChB,OAAO,EAAE,KAAK;iBACjB;gBACD,oBAAoB,EAAE,IAAI;aAC7B;YACD,oBAAoB,EAAE;gBAClB,KAAK,EAAE;oBACH;wBACI,IAAI,EAAE,SAAS;qBAClB;oBACD;wBACI,IAAI,EAAE,wCAAwC;qBACjD;iBACJ;aACJ;SACJ;QACD,KAAK,EAAE;YACH,WAAW,EAAE,kCAAkC;YAC/C,OAAO,EAAE;gBACL;oBACI,KAAK,EAAE,eAAe;oBACtB,IAAI,EAAE,eAAe;oBACrB,IAAI,EAAE,iCAAiC;oBACvC,KAAK,EAAE,oBAAoB;iBAC9B;gBACD;oBACI,KAAK,EAAE,QAAQ;oBACf,IAAI,EAAE,UAAU;oBAChB,IAAI,EAAE,oCAAoC;oBAC1C,KAAK,EAAE,uBAAuB;iBACjC;aACJ;YACD,iCAAiC,EAAE,SAAS;YAC5C,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;QACD,kBAAkB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,8DAA8D;YAClE,OAAO,EAAE,YAAY;YACrB,IAAI,EAAE;gBACF,aAAa;gBACb,MAAM;gBACN,YAAY;gBACZ,QAAQ;gBACR,QAAQ;gBACR,MAAM;aACT;SACJ;QACD,WAAW,EAAE;YACT,IAAI,EAAE,oCAAoC;SAC7C;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,aAAa,EAAb,8BAAa;YACb,iBAAiB,EAAjB,uCAAiB;SACpB;KACJ;CACK,CAAC"}

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

@@ -3,8 +3,11 @@ export declare const updateApiTokenSchema: {
     readonly $id: "#/components/schemas/updateApiTokenSchema";
     readonly type: "object";
     readonly required: readonly ["expiresAt"];
+    readonly description: "An object with fields to updated for a given API token.";
     readonly properties: {
         readonly expiresAt: {
+            readonly description: "The new time when this token should expire.";
+            readonly example: "2023-09-04T11:26:24+02:00";
             readonly type: "string";
             readonly format: "date-time";
         };

package/dist/lib/openapi/spec/update-api-token-schema.js

@@ -5,8 +5,11 @@ exports.updateApiTokenSchema = {
     $id: '#/components/schemas/updateApiTokenSchema',
     type: 'object',
     required: ['expiresAt'],
+    description: 'An object with fields to updated for a given API token.',
     properties: {
         expiresAt: {
+            description: 'The new time when this token should expire.',
+            example: '2023-09-04T11:26:24+02:00',
             type: 'string',
             format: 'date-time',
         },

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

@@ -1 +1 @@
-{"version":3,"file":"update-api-token-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-api-token-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAG;IAChC,GAAG,EAAE,2CAA2C;IAChD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,WAAW,CAAC;IACvB,UAAU,EAAE;QACR,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;SACtB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"update-api-token-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-api-token-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,oBAAoB,GAAG;IAChC,GAAG,EAAE,2CAA2C;IAChD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,WAAW,CAAC;IACvB,WAAW,EAAE,yDAAyD;IACtE,UAAU,EAAE;QACR,SAAS,EAAE;YACP,WAAW,EAAE,6CAA6C;YAC1D,OAAO,EAAE,2BAA2B;YACpC,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;SACtB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -2,35 +2,32 @@ import { FromSchema } from 'json-schema-to-ts';
 export declare const updateFeatureSchema: {
     readonly $id: "#/components/schemas/updateFeatureSchema";
     readonly type: "object";
-    readonly required: readonly ["name"];
+    readonly description: "Data used for updating a feature toggle";
     readonly properties: {
-        readonly name: {
-            readonly type: "string";
-        };
         readonly description: {
             readonly type: "string";
+            readonly example: "Controls disabling of the comments section in case of an incident";
+            readonly description: "Detailed description of the feature";
         };
         readonly type: {
             readonly type: "string";
+            readonly example: "kill-switch";
+            readonly description: "Type of the toggle e.g. experiment, kill-switch, release, operational, permission";
         };
         readonly stale: {
             readonly type: "boolean";
+            readonly example: true;
+            readonly description: "`true` if the feature is archived";
         };
         readonly archived: {
             readonly type: "boolean";
-        };
-        readonly createdAt: {
-            readonly type: "string";
-            readonly format: "date-time";
+            readonly example: true;
+            readonly description: "If `true` the feature toggle will be moved to the [archive](https://docs.getunleash.io/reference/archived-toggles) with a property `archivedAt` set to current time";
         };
         readonly impressionData: {
             readonly type: "boolean";
-        };
-        readonly constraints: {
-            readonly type: "array";
-            readonly items: {
-                readonly $ref: "#/components/schemas/constraintSchema";
-            };
+            readonly example: false;
+            readonly description: "`true` if the impression data collection is enabled for the feature";
         };
     };
     readonly components: {

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

@@ -5,35 +5,32 @@ const constraint_schema_1 = require("./constraint-schema");
 exports.updateFeatureSchema = {
     $id: '#/components/schemas/updateFeatureSchema',
     type: 'object',
-    required: ['name'],
+    description: 'Data used for updating a feature toggle',
     properties: {
-        name: {
-            type: 'string',
-        },
         description: {
             type: 'string',
+            example: 'Controls disabling of the comments section in case of an incident',
+            description: 'Detailed description of the feature',
         },
         type: {
             type: 'string',
+            example: 'kill-switch',
+            description: 'Type of the toggle e.g. experiment, kill-switch, release, operational, permission',
         },
         stale: {
             type: 'boolean',
+            example: true,
+            description: '`true` if the feature is archived',
         },
         archived: {
             type: 'boolean',
-        },
-        createdAt: {
-            type: 'string',
-            format: 'date-time',
+            example: true,
+            description: 'If `true` the feature toggle will be moved to the [archive](https://docs.getunleash.io/reference/archived-toggles) with a property `archivedAt` set to current time',
         },
         impressionData: {
             type: 'boolean',
-        },
-        constraints: {
-            type: 'array',
-            items: {
-                $ref: '#/components/schemas/constraintSchema',
-            },
+            example: false,
+            description: '`true` if the impression data collection is enabled for the feature',
         },
     },
     components: {

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

@@ -1 +1 @@
-{"version":3,"file":"update-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-feature-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AAE1C,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,KAAK,EAAE;YACH,IAAI,EAAE,SAAS;SAClB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;SAClB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;SACtB;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,SAAS;SAClB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,uCAAuC;aAChD;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;SACnB;KACJ;CACK,CAAC"}
+{"version":3,"file":"update-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-feature-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AAE1C,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,yCAAyC;IACtD,UAAU,EAAE;QACR,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EACH,mEAAmE;YACvE,WAAW,EAAE,qCAAqC;SACrD;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EACP,mFAAmF;SAC1F;QACD,KAAK,EAAE;YACH,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,mCAAmC;SACnD;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EACP,qKAAqK;SAC5K;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EACP,qEAAqE;SAC5E;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;SACnB;KACJ;CACK,CAAC"}

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

@@ -2,18 +2,22 @@ import { FromSchema } from 'json-schema-to-ts';
 export declare const updateFeatureStrategySchema: {
     readonly $id: "#/components/schemas/updateFeatureStrategySchema";
     readonly type: "object";
+    readonly description: "Update a strategy configuration in a feature";
     readonly properties: {
         readonly name: {
             readonly type: "string";
+            readonly description: "The name of the strategy type";
         };
         readonly sortOrder: {
             readonly type: "number";
+            readonly description: "The order of the strategy in the list in feature environment configuration";
         };
         readonly constraints: {
             readonly type: "array";
             readonly items: {
                 readonly $ref: "#/components/schemas/constraintSchema";
             };
+            readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
         };
         readonly title: {
             readonly type: "string";
@@ -80,6 +84,7 @@ export declare const updateFeatureStrategySchema: {
             readonly parametersSchema: {
                 readonly $id: "#/components/schemas/parametersSchema";
                 readonly type: "object";
+                readonly description: "A list of parameters for a strategy";
                 readonly additionalProperties: {
                     readonly type: "string";
                 };

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

@@ -6,18 +6,22 @@ const constraint_schema_1 = require("./constraint-schema");
 exports.updateFeatureStrategySchema = {
     $id: '#/components/schemas/updateFeatureStrategySchema',
     type: 'object',
+    description: 'Update a strategy configuration in a feature',
     properties: {
         name: {
             type: 'string',
+            description: 'The name of the strategy type',
         },
         sortOrder: {
             type: 'number',
+            description: 'The order of the strategy in the list in feature environment configuration',
         },
         constraints: {
             type: 'array',
             items: {
                 $ref: '#/components/schemas/constraintSchema',
             },
+            description: 'A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints',
         },
         title: {
             type: 'string',

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

@@ -1 +1 @@
-{"version":3,"file":"update-feature-strategy-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-feature-strategy-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,2DAAuD;AAE1C,QAAA,2BAA2B,GAAG;IACvC,GAAG,EAAE,kDAAkD;IACvD,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,uCAAuC;aAChD;SACJ;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,sCAAsC;YACnD,OAAO,EAAE,yBAAyB;SACrC;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;YACf,WAAW,EACP,mHAAmH;YACvH,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,IAAI;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,uCAAuC;SAChD;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;SACnB;KACJ;CACK,CAAC"}
+{"version":3,"file":"update-feature-strategy-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-feature-strategy-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,2DAAuD;AAE1C,QAAA,2BAA2B,GAAG;IACvC,GAAG,EAAE,kDAAkD;IACvD,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,8CAA8C;IAC3D,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,+BAA+B;SAC/C;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,4EAA4E;SACnF;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,uCAAuC;aAChD;YACD,WAAW,EACP,mHAAmH;SAC1H;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,sCAAsC;YACnD,OAAO,EAAE,yBAAyB;SACrC;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;YACf,WAAW,EACP,mHAAmH;YACvH,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,IAAI;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,uCAAuC;SAChD;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;SACnB;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/update-feature-type-lifetime-schema.d.ts

@@ -0,0 +1,19 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const updateFeatureTypeLifetimeSchema: {
+    readonly $id: "#/components/schemas/updateFeatureTypeLifetimeSchema";
+    readonly type: "object";
+    readonly required: readonly ["lifetimeDays"];
+    readonly description: "Data used when updating the lifetime of a [feature toggle type](https://docs.getunleash.io/reference/feature-toggle-types).";
+    readonly properties: {
+        readonly lifetimeDays: {
+            readonly description: "The new lifetime (in days) that you want to assign to the feature toggle type. If the value is `null` or `0`, then the feature toggles of that type will never be marked as potentially stale. Otherwise, they will be considered potentially stale after the number of days indicated by this property.";
+            readonly example: 7;
+            readonly type: "integer";
+            readonly nullable: true;
+            readonly minimum: 0;
+            readonly maximum: 2147483647;
+        };
+    };
+    readonly components: {};
+};
+export declare type UpdateFeatureTypeLifetimeSchema = FromSchema<typeof updateFeatureTypeLifetimeSchema>;

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateFeatureTypeLifetimeSchema = void 0;
+exports.updateFeatureTypeLifetimeSchema = {
+    $id: '#/components/schemas/updateFeatureTypeLifetimeSchema',
+    type: 'object',
+    required: ['lifetimeDays'],
+    description: 'Data used when updating the lifetime of a [feature toggle type](https://docs.getunleash.io/reference/feature-toggle-types).',
+    properties: {
+        lifetimeDays: {
+            description: 'The new lifetime (in days) that you want to assign to the feature toggle type. If the value is `null` or `0`, then the feature toggles of that type will never be marked as potentially stale. Otherwise, they will be considered potentially stale after the number of days indicated by this property.',
+            example: 7,
+            type: 'integer',
+            nullable: true,
+            minimum: 0,
+            maximum: 2147483647, // Postgres' max integer: https://www.postgresql.org/docs/9.1/datatype-numeric.html
+        },
+    },
+    components: {},
+};
+//# sourceMappingURL=update-feature-type-lifetime-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"update-feature-type-lifetime-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-feature-type-lifetime-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,+BAA+B,GAAG;IAC3C,GAAG,EAAE,sDAAsD;IAC3D,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,cAAc,CAAC;IAC1B,WAAW,EACP,6HAA6H;IACjI,UAAU,EAAE;QACR,YAAY,EAAE;YACV,WAAW,EACP,0SAA0S;YAC9S,OAAO,EAAE,CAAC;YACV,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,UAAU,EAAE,mFAAmF;SAC3G;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -0,0 +1,47 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const updateStrategySchema: {
+    readonly $id: "#/components/schemas/updateStrategySchema";
+    readonly type: "object";
+    readonly description: "The data required to update a strategy type.";
+    readonly required: readonly ["parameters"];
+    readonly properties: {
+        readonly description: {
+            readonly type: "string";
+            readonly description: "A description of the strategy type.";
+            readonly example: "Enable the feature for users who have not logged in before.";
+        };
+        readonly parameters: {
+            readonly type: "array";
+            readonly description: "The parameter list lets you pass arguments to your custom activation strategy. These will be made available to your custom strategy implementation.";
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["name", "type"];
+                readonly properties: {
+                    readonly name: {
+                        readonly type: "string";
+                        readonly description: "The name of the parameter";
+                        readonly example: "Rollout percentage";
+                    };
+                    readonly type: {
+                        readonly type: "string";
+                        readonly description: "The [type of the parameter](https://docs.getunleash.io/reference/custom-activation-strategies#parameter-types)";
+                        readonly enum: readonly ["string", "percentage", "list", "number", "boolean"];
+                        readonly example: "percentage";
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly description: "A description of this strategy parameter. Use this to indicate to the users what the parameter does.";
+                        readonly example: "How many percent of users should see this feature?";
+                    };
+                    readonly required: {
+                        readonly type: "boolean";
+                        readonly description: "Whether this parameter must be configured when using the strategy. Defaults to `false`";
+                        readonly example: false;
+                    };
+                };
+            };
+        };
+    };
+    readonly components: {};
+};
+export declare type UpdateStrategySchema = FromSchema<typeof updateStrategySchema>;