unleash-server 5.2.7 → 5.3.0

package/dist/lib/openapi/spec/project-overview-schema.js

@@ -12,6 +12,8 @@ const feature_environment_schema_1 = require("./feature-environment-schema");
 const project_stats_schema_1 = require("./project-stats-schema");
 const create_feature_strategy_schema_1 = require("./create-feature-strategy-schema");
 const project_environment_schema_1 = require("./project-environment-schema");
+const create_strategy_variant_schema_1 = require("./create-strategy-variant-schema");
+const strategy_variant_schema_1 = require("./strategy-variant-schema");
 exports.projectOverviewSchema = {
     $id: '#/components/schemas/projectOverviewSchema',
     type: 'object',
@@ -49,6 +51,12 @@ exports.projectOverviewSchema = {
             example: 'open',
             description: "The project's [collaboration mode](https://docs.getunleash.io/reference/project-collaboration-mode). Determines whether non-project members can submit change requests or not.",
         },
+        featureLimit: {
+            type: 'number',
+            nullable: true,
+            example: 100,
+            description: 'A limit on the number of features allowed in the project. Null if no limit.',
+        },
         members: {
             type: 'number',
             example: 4,
@@ -111,12 +119,14 @@ exports.projectOverviewSchema = {
             environmentSchema: environment_schema_1.environmentSchema,
             projectEnvironmentSchema: project_environment_schema_1.projectEnvironmentSchema,
             createFeatureStrategySchema: create_feature_strategy_schema_1.createFeatureStrategySchema,
+            createStrategyVariantSchema: create_strategy_variant_schema_1.createStrategyVariantSchema,
             constraintSchema: constraint_schema_1.constraintSchema,
             featureSchema: feature_schema_1.featureSchema,
             featureEnvironmentSchema: feature_environment_schema_1.featureEnvironmentSchema,
             overrideSchema: override_schema_1.overrideSchema,
             parametersSchema: parameters_schema_1.parametersSchema,
             featureStrategySchema: feature_strategy_schema_1.featureStrategySchema,
+            strategyVariantSchema: strategy_variant_schema_1.strategyVariantSchema,
             variantSchema: variant_schema_1.variantSchema,
             projectStatsSchema: project_stats_schema_1.projectStatsSchema,
         },

package/dist/lib/openapi/spec/project-overview-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"project-overview-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/project-overview-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,qDAAiD;AACjD,uDAAmD;AACnD,uEAAkE;AAClE,qDAAiD;AACjD,2DAAuD;AACvD,6DAAyD;AACzD,6EAAwE;AACxE,iEAA4D;AAC5D,qFAA+E;AAC/E,6EAAwE;AAE3D,QAAA,qBAAqB,GAAG;IACjC,GAAG,EAAE,4CAA4C;IACjD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC;IAC7B,WAAW,EACP,mKAAmK;IACvK,UAAU,EAAE;QACR,KAAK,EAAE;YACH,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,oBAAoB;SACpC;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC;SACb;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,UAAU;YACnB,WAAW,EAAE,0BAA0B;SAC1C;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;YACnC,WAAW,EAAE,0CAA0C;SAC1D;QACD,iBAAiB,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;YACjB,WAAW,EACP,uHAAuH;SAC9H;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC3B,OAAO,EAAE,MAAM;YACf,WAAW,EACP,gLAAgL;SACvL;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC;YACV,WAAW,EAAE,wCAAwC;SACxD;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE;YACX,WAAW,EACP,oIAAoI;SAC3I;QACD,YAAY,EAAE;YACV,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,+CAA+C;aACxD;YACD,OAAO,EAAE;gBACL,EAAE,WAAW,EAAE,aAAa,EAAE;gBAC9B;oBACI,WAAW,EAAE,YAAY;oBACzB,eAAe,EAAE;wBACb,IAAI,EAAE,iBAAiB;wBACvB,WAAW,EAAE,EAAE;wBACf,UAAU,EAAE;4BACR,OAAO,EAAE,IAAI;4BACb,UAAU,EAAE,eAAe;4BAC3B,OAAO,EAAE,cAAc;yBAC1B;qBACJ;iBACJ;aACJ;YACD,WAAW,EAAE,oDAAoD;SACpE;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;YACD,WAAW,EACP,yEAAyE;SAChF;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;SACtC;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;SACtC;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EACP,yDAAyD;SAChE;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,iBAAiB,EAAjB,sCAAiB;YACjB,wBAAwB,EAAxB,qDAAwB;YACxB,2BAA2B,EAA3B,4DAA2B;YAC3B,gBAAgB,EAAhB,oCAAgB;YAChB,aAAa,EAAb,8BAAa;YACb,wBAAwB,EAAxB,qDAAwB;YACxB,cAAc,EAAd,gCAAc;YACd,gBAAgB,EAAhB,oCAAgB;YAChB,qBAAqB,EAArB,+CAAqB;YACrB,aAAa,EAAb,8BAAa;YACb,kBAAkB,EAAlB,yCAAkB;SACrB;KACJ;CACK,CAAC"}
+{"version":3,"file":"project-overview-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/project-overview-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,qDAAiD;AACjD,uDAAmD;AACnD,uEAAkE;AAClE,qDAAiD;AACjD,2DAAuD;AACvD,6DAAyD;AACzD,6EAAwE;AACxE,iEAA4D;AAC5D,qFAA+E;AAC/E,6EAAwE;AACxE,qFAA+E;AAC/E,uEAAkE;AAErD,QAAA,qBAAqB,GAAG;IACjC,GAAG,EAAE,4CAA4C;IACjD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,SAAS,EAAE,MAAM,CAAC;IAC7B,WAAW,EACP,mKAAmK;IACvK,UAAU,EAAE;QACR,KAAK,EAAE;YACH,IAAI,EAAE,yCAAyC;YAC/C,WAAW,EAAE,oBAAoB;SACpC;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC;SACb;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,UAAU;YACnB,WAAW,EAAE,0BAA0B;SAC1C;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;YACnC,WAAW,EAAE,0CAA0C;SAC1D;QACD,iBAAiB,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;YACjB,WAAW,EACP,uHAAuH;SAC9H;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,MAAM,EAAE,WAAW,CAAC;YAC3B,OAAO,EAAE,MAAM;YACf,WAAW,EACP,gLAAgL;SACvL;QACD,YAAY,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,GAAG;YACZ,WAAW,EACP,6EAA6E;SACpF;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC;YACV,WAAW,EAAE,wCAAwC;SACxD;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,EAAE;YACX,WAAW,EACP,oIAAoI;SAC3I;QACD,YAAY,EAAE;YACV,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,+CAA+C;aACxD;YACD,OAAO,EAAE;gBACL,EAAE,WAAW,EAAE,aAAa,EAAE;gBAC9B;oBACI,WAAW,EAAE,YAAY;oBACzB,eAAe,EAAE;wBACb,IAAI,EAAE,iBAAiB;wBACvB,WAAW,EAAE,EAAE;wBACf,UAAU,EAAE;4BACR,OAAO,EAAE,IAAI;4BACb,UAAU,EAAE,eAAe;4BAC3B,OAAO,EAAE,cAAc;yBAC1B;qBACJ;iBACJ;aACJ;YACD,WAAW,EAAE,oDAAoD;SACpE;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;YACD,WAAW,EACP,yEAAyE;SAChF;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;SACtC;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;SACtC;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EACP,yDAAyD;SAChE;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,iBAAiB,EAAjB,sCAAiB;YACjB,wBAAwB,EAAxB,qDAAwB;YACxB,2BAA2B,EAA3B,4DAA2B;YAC3B,2BAA2B,EAA3B,4DAA2B;YAC3B,gBAAgB,EAAhB,oCAAgB;YAChB,aAAa,EAAb,8BAAa;YACb,wBAAwB,EAAxB,qDAAwB;YACxB,cAAc,EAAd,gCAAc;YACd,gBAAgB,EAAhB,oCAAgB;YAChB,qBAAqB,EAArB,+CAAqB;YACrB,qBAAqB,EAArB,+CAAqB;YACrB,aAAa,EAAb,8BAAa;YACb,kBAAkB,EAAlB,yCAAkB;SACrB;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/proxy-client-schema.d.ts

@@ -3,6 +3,7 @@ export declare const proxyClientSchema: {
     readonly $id: "#/components/schemas/proxyClientSchema";
     readonly type: "object";
     readonly required: readonly ["appName", "interval", "started", "strategies"];
+    readonly description: "Frontend SDK client registration information";
     readonly properties: {
         readonly appName: {
             readonly type: "string";
@@ -19,6 +20,8 @@ export declare const proxyClientSchema: {
         readonly environment: {
             readonly type: "string";
             readonly deprecated: true;
+            readonly description: "deprecated";
+            readonly example: "development";
         };
         readonly interval: {
             readonly type: "number";

package/dist/lib/openapi/spec/proxy-client-schema.js

@@ -5,6 +5,7 @@ exports.proxyClientSchema = {
     $id: '#/components/schemas/proxyClientSchema',
     type: 'object',
     required: ['appName', 'interval', 'started', 'strategies'],
+    description: 'Frontend SDK client registration information',
     properties: {
         appName: {
             type: 'string',
@@ -21,6 +22,8 @@ exports.proxyClientSchema = {
         environment: {
             type: 'string',
             deprecated: true,
+            description: 'deprecated',
+            example: 'development',
         },
         interval: {
             type: 'number',

package/dist/lib/openapi/spec/proxy-client-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"proxy-client-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/proxy-client-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAG;IAC7B,GAAG,EAAE,wCAAwC;IAC7C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC;IAC1D,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,uCAAuC;SACvD;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,yEAAyE;SAChF;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,8DAA8D;SACrE;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,IAAI;SACnB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,kFAAkF;SACzF;QACD,OAAO,EAAE;YACL,KAAK,EAAE;gBACH,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE;gBACvC,EAAE,IAAI,EAAE,QAAQ,EAAE;aACrB;YACD,WAAW,EACP,+DAA+D;SACtE;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;YACD,WAAW,EAAE,oDAAoD;SACpE;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"proxy-client-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/proxy-client-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAG;IAC7B,GAAG,EAAE,wCAAwC;IAC7C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC;IAC1D,WAAW,EAAE,8CAA8C;IAC3D,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,uCAAuC;SACvD;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,yEAAyE;SAChF;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,8DAA8D;SACrE;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE,IAAI;YAChB,WAAW,EAAE,YAAY;YACzB,OAAO,EAAE,aAAa;SACzB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,kFAAkF;SACzF;QACD,OAAO,EAAE;YACL,KAAK,EAAE;gBACH,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE;gBACvC,EAAE,IAAI,EAAE,QAAQ,EAAE;aACrB;YACD,WAAW,EACP,+DAA+D;SACtE;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;YACD,WAAW,EAAE,oDAAoD;SACpE;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -1,42 +1,60 @@
 import { FromSchema } from 'json-schema-to-ts';
-import { PayloadType } from 'unleash-client';
 export declare const proxyFeatureSchema: {
     readonly $id: "#/components/schemas/proxyFeatureSchema";
     readonly type: "object";
     readonly required: readonly ["name", "enabled", "impressionData"];
     readonly additionalProperties: false;
+    readonly description: "Frontend API feature";
     readonly properties: {
         readonly name: {
             readonly type: "string";
+            readonly example: "disable-comments";
+            readonly description: "Unique feature name.";
         };
         readonly enabled: {
             readonly type: "boolean";
+            readonly example: true;
+            readonly description: "Always set to `true`.";
         };
         readonly impressionData: {
             readonly type: "boolean";
+            readonly example: false;
+            readonly description: "`true` if the impression data collection is enabled for the feature, otherwise `false`.";
         };
         readonly variant: {
             readonly type: "object";
             readonly required: readonly ["name", "enabled"];
             readonly additionalProperties: false;
+            readonly description: "Variant details";
             readonly properties: {
                 readonly name: {
                     readonly type: "string";
+                    readonly description: "The variants name. Is unique for this feature toggle";
+                    readonly example: "blue_group";
                 };
                 readonly enabled: {
                     readonly type: "boolean";
+                    readonly example: true;
+                    readonly description: "Whether the variant is enabled or not.";
                 };
                 readonly payload: {
                     readonly type: "object";
                     readonly additionalProperties: false;
                     readonly required: readonly ["type", "value"];
+                    readonly description: "Extra data configured for this variant";
+                    readonly example: {
+                        readonly type: "json";
+                        readonly value: "{\"color\": \"red\"}";
+                    };
                     readonly properties: {
                         readonly type: {
                             readonly type: "string";
-                            readonly enum: PayloadType[];
+                            readonly description: "The format of the payload.";
+                            readonly enum: readonly ["json", "csv", "string"];
                         };
                         readonly value: {
                             readonly type: "string";
+                            readonly description: "The payload value stringified.";
                         };
                     };
                 };

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

@@ -1,43 +1,60 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.proxyFeatureSchema = void 0;
-const unleash_client_1 = require("unleash-client");
 exports.proxyFeatureSchema = {
     $id: '#/components/schemas/proxyFeatureSchema',
     type: 'object',
     required: ['name', 'enabled', 'impressionData'],
     additionalProperties: false,
+    description: 'Frontend API feature',
     properties: {
         name: {
             type: 'string',
+            example: 'disable-comments',
+            description: 'Unique feature name.',
         },
         enabled: {
             type: 'boolean',
+            example: true,
+            description: 'Always set to `true`.',
         },
         impressionData: {
             type: 'boolean',
+            example: false,
+            description: '`true` if the impression data collection is enabled for the feature, otherwise `false`.',
         },
         variant: {
             type: 'object',
             required: ['name', 'enabled'],
             additionalProperties: false,
+            description: 'Variant details',
             properties: {
                 name: {
                     type: 'string',
+                    description: 'The variants name. Is unique for this feature toggle',
+                    example: 'blue_group',
                 },
                 enabled: {
                     type: 'boolean',
+                    example: true,
+                    description: 'Whether the variant is enabled or not.',
                 },
                 payload: {
                     type: 'object',
                     additionalProperties: false,
                     required: ['type', 'value'],
+                    description: 'Extra data configured for this variant',
+                    example: { type: 'json', value: '{"color": "red"}' },
                     properties: {
                         type: {
                             type: 'string',
-                            enum: Object.values(unleash_client_1.PayloadType),
+                            description: 'The format of the payload.',
+                            enum: ['json', 'csv', 'string'],
+                        },
+                        value: {
+                            type: 'string',
+                            description: 'The payload value stringified.',
                         },
-                        value: { type: 'string' },
                     },
                 },
             },

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

@@ -1 +1 @@
-{"version":3,"file":"proxy-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/proxy-feature-schema.ts"],"names":[],"mappings":";;;AACA,mDAA6C;AAEhC,QAAA,kBAAkB,GAAG;IAC9B,GAAG,EAAE,yCAAyC;IAC9C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,gBAAgB,CAAC;IAC/C,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;SAClB;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,SAAS;SAClB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;YAC7B,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACR,IAAI,EAAE;oBACF,IAAI,EAAE,QAAQ;iBACjB;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,SAAS;iBAClB;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,oBAAoB,EAAE,KAAK;oBAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;oBAC3B,UAAU,EAAE;wBACR,IAAI,EAAE;4BACF,IAAI,EAAE,QAAQ;4BACd,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,4BAAW,CAAC;yBACnC;wBACD,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;qBAC5B;iBACJ;aACJ;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"proxy-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/proxy-feature-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,kBAAkB,GAAG;IAC9B,GAAG,EAAE,yCAAyC;IAC9C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,EAAE,gBAAgB,CAAC;IAC/C,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,sBAAsB;IACnC,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,kBAAkB;YAC3B,WAAW,EAAE,sBAAsB;SACtC;QACD,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EAAE,uBAAuB;SACvC;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,WAAW,EACP,yFAAyF;SAChG;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;YAC7B,oBAAoB,EAAE,KAAK;YAC3B,WAAW,EAAE,iBAAiB;YAC9B,UAAU,EAAE;gBACR,IAAI,EAAE;oBACF,IAAI,EAAE,QAAQ;oBACd,WAAW,EACP,sDAAsD;oBAC1D,OAAO,EAAE,YAAY;iBACxB;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,IAAI;oBACb,WAAW,EAAE,wCAAwC;iBACxD;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,oBAAoB,EAAE,KAAK;oBAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;oBAC3B,WAAW,EAAE,wCAAwC;oBACrD,OAAO,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB,EAAE;oBACpD,UAAU,EAAE;wBACR,IAAI,EAAE;4BACF,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,4BAA4B;4BACzC,IAAI,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC;yBAClC;wBACD,KAAK,EAAE;4BACH,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,gCAAgC;yBAChD;qBACJ;iBACJ;aACJ;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

package/dist/lib/openapi/spec/proxy-features-schema.d.ts

@@ -4,8 +4,10 @@ export declare const proxyFeaturesSchema: {
     readonly type: "object";
     readonly required: readonly ["toggles"];
     readonly additionalProperties: false;
+    readonly description: "Frontend SDK features list";
     readonly properties: {
         readonly toggles: {
+            readonly description: "The actual features returned to the Frontend SDK";
             readonly type: "array";
             readonly items: {
                 readonly $ref: "#/components/schemas/proxyFeatureSchema";
@@ -19,38 +21,57 @@ export declare const proxyFeaturesSchema: {
                 readonly type: "object";
                 readonly required: readonly ["name", "enabled", "impressionData"];
                 readonly additionalProperties: false;
+                readonly description: "Frontend API feature";
                 readonly properties: {
                     readonly name: {
                         readonly type: "string";
+                        readonly example: "disable-comments";
+                        readonly description: "Unique feature name.";
                     };
                     readonly enabled: {
                         readonly type: "boolean";
+                        readonly example: true;
+                        readonly description: "Always set to `true`.";
                     };
                     readonly impressionData: {
                         readonly type: "boolean";
+                        readonly example: false;
+                        readonly description: "`true` if the impression data collection is enabled for the feature, otherwise `false`.";
                     };
                     readonly variant: {
                         readonly type: "object";
                         readonly required: readonly ["name", "enabled"];
                         readonly additionalProperties: false;
+                        readonly description: "Variant details";
                         readonly properties: {
                             readonly name: {
                                 readonly type: "string";
+                                readonly description: "The variants name. Is unique for this feature toggle";
+                                readonly example: "blue_group";
                             };
                             readonly enabled: {
                                 readonly type: "boolean";
+                                readonly example: true;
+                                readonly description: "Whether the variant is enabled or not.";
                             };
                             readonly payload: {
                                 readonly type: "object";
                                 readonly additionalProperties: false;
                                 readonly required: readonly ["type", "value"];
+                                readonly description: "Extra data configured for this variant";
+                                readonly example: {
+                                    readonly type: "json";
+                                    readonly value: "{\"color\": \"red\"}";
+                                };
                                 readonly properties: {
                                     readonly type: {
                                         readonly type: "string";
-                                        readonly enum: import("unleash-client").PayloadType[];
+                                        readonly description: "The format of the payload.";
+                                        readonly enum: readonly ["json", "csv", "string"];
                                     };
                                     readonly value: {
                                         readonly type: "string";
+                                        readonly description: "The payload value stringified.";
                                     };
                                 };
                             };

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

@@ -7,8 +7,10 @@ exports.proxyFeaturesSchema = {
     type: 'object',
     required: ['toggles'],
     additionalProperties: false,
+    description: 'Frontend SDK features list',
     properties: {
         toggles: {
+            description: 'The actual features returned to the Frontend SDK',
             type: 'array',
             items: {
                 $ref: proxy_feature_schema_1.proxyFeatureSchema.$id,

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

@@ -1 +1 @@
-{"version":3,"file":"proxy-features-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/proxy-features-schema.ts"],"names":[],"mappings":";;;AACA,iEAA4D;AAE/C,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,CAAC;IACrB,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,yCAAkB,CAAC,GAAG;aAC/B;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,kBAAkB,EAAlB,yCAAkB;SACrB;KACJ;CACK,CAAC"}
+{"version":3,"file":"proxy-features-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/proxy-features-schema.ts"],"names":[],"mappings":";;;AACA,iEAA4D;AAE/C,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,CAAC;IACrB,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,4BAA4B;IACzC,UAAU,EAAE;QACR,OAAO,EAAE;YACL,WAAW,EAAE,kDAAkD;YAC/D,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,yCAAkB,CAAC,GAAG;aAC/B;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,kBAAkB,EAAlB,yCAAkB;SACrB;KACJ;CACK,CAAC"}

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

@@ -63,50 +63,88 @@ export declare const publicSignupTokenSchema: {
                 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: {};
@@ -114,20 +152,30 @@ export declare const publicSignupTokenSchema: {
             readonly roleSchema: {
                 readonly $id: "#/components/schemas/roleSchema";
                 readonly type: "object";
+                readonly description: "A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform";
                 readonly additionalProperties: false;
                 readonly required: readonly ["id", "type", "name"];
                 readonly properties: {
                     readonly id: {
-                        readonly type: "number";
+                        readonly type: "integer";
+                        readonly description: "The role id";
+                        readonly example: 9;
+                        readonly minimum: 0;
                     };
                     readonly type: {
+                        readonly description: "A role can either be a global root role (applies to all projects) or a project role";
                         readonly type: "string";
+                        readonly example: "root";
                     };
                     readonly name: {
+                        readonly description: "The name of the role";
                         readonly type: "string";
+                        readonly example: "Editor";
                     };
                     readonly description: {
+                        readonly description: "A more detailed description of the role and what use it's intended for";
                         readonly type: "string";
+                        readonly example: "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.";
                     };
                 };
                 readonly components: {};