unleash-server 5.1.8 → 5.2.0

package/dist/lib/openapi/spec/index.d.ts

@@ -137,3 +137,6 @@ export * from './batch-features-schema';
 export * from './token-string-list-schema';
 export * from './bulk-toggle-features-schema';
 export * from './admin-count-schema';
+export * from './advanced-playground-feature-schema';
+export * from './advanced-playground-response-schema';
+export * from './advanced-playground-request-schema';

package/dist/lib/openapi/spec/index.js

@@ -153,4 +153,7 @@ __exportStar(require("./batch-features-schema"), exports);
 __exportStar(require("./token-string-list-schema"), exports);
 __exportStar(require("./bulk-toggle-features-schema"), exports);
 __exportStar(require("./admin-count-schema"), exports);
+__exportStar(require("./advanced-playground-feature-schema"), exports);
+__exportStar(require("./advanced-playground-response-schema"), exports);
+__exportStar(require("./advanced-playground-request-schema"), exports);
 //# sourceMappingURL=index.js.map

package/dist/lib/openapi/spec/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,8CAA4B;AAC5B,+CAA6B;AAC7B,+CAA6B;AAC7B,gDAA8B;AAC9B,gDAA8B;AAC9B,gDAA8B;AAC9B,gDAA8B;AAC9B,gDAA8B;AAC9B,gDAA8B;AAC9B,iDAA+B;AAC/B,+DAA6C;AAC7C,iDAA+B;AAC/B,iDAA+B;AAC/B,iDAA+B;AAC/B,iDAA+B;AAC/B,iDAA+B;AAC/B,iDAA+B;AAC/B,iDAA+B;AAC/B,kDAAgC;AAChC,kDAAgC;AAChC,kDAAgC;AAChC,kDAAgC;AAChC,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,wDAAsC;AACtC,mDAAiC;AACjC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,qDAAmC;AACnC,qDAAmC;AACnC,qDAAmC;AACnC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,uDAAqC;AACrC,uDAAqC;AACrC,uDAAqC;AACrC,uDAAqC;AACrC,uDAAqC;AACrC,uDAAqC;AACrC,uDAAqC;AACrC,wDAAsC;AACtC,wDAAsC;AACtC,wDAAsC;AACtC,wDAAsC;AACtC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,2DAAyC;AACzC,2DAAyC;AACzC,2DAAyC;AACzC,2DAAyC;AACzC,2DAAyC;AACzC,2DAAyC;AACzC,2DAAyC;AACzC,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,6DAA2C;AAC3C,6DAA2C;AAC3C,6DAA2C;AAC3C,8DAA4C;AAC5C,8DAA4C;AAC5C,8DAA4C;AAC5C,8DAA4C;AAC5C,+DAA6C;AAC7C,+DAA6C;AAC7C,+DAA6C;AAC7C,+DAA6C;AAC7C,+DAA6C;AAC7C,+DAA6C;AAC7C,+DAA6C;AAC7C,gEAA8C;AAC9C,gEAA8C;AAC9C,gEAA8C;AAC9C,gEAA8C;AAC9C,iEAA+C;AAC/C,iEAA+C;AAC/C,gEAA8C;AAC9C,iEAA+C;AAC/C,mEAAiD;AACjD,mEAAiD;AACjD,mEAAiD;AACjD,oEAAkD;AAClD,sEAAoD;AACpD,sEAAoD;AACpD,uEAAqD;AACrD,+DAA6C;AAC7C,yEAAuD;AACvD,yDAAuC;AACvC,wDAAsC;AACtC,yDAAuC;AACvC,yDAAuC;AACvC,4DAA0C;AAC1C,wEAAsD;AACtD,mEAAiD;AACjD,0DAAwC;AACxC,yDAAuC;AACvC,0DAAwC;AACxC,0DAAwC;AACxC,6DAA2C;AAC3C,gEAA8C;AAC9C,uDAAqC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA4B;AAC5B,8CAA4B;AAC5B,+CAA6B;AAC7B,+CAA6B;AAC7B,gDAA8B;AAC9B,gDAA8B;AAC9B,gDAA8B;AAC9B,gDAA8B;AAC9B,gDAA8B;AAC9B,gDAA8B;AAC9B,iDAA+B;AAC/B,+DAA6C;AAC7C,iDAA+B;AAC/B,iDAA+B;AAC/B,iDAA+B;AAC/B,iDAA+B;AAC/B,iDAA+B;AAC/B,iDAA+B;AAC/B,iDAA+B;AAC/B,kDAAgC;AAChC,kDAAgC;AAChC,kDAAgC;AAChC,kDAAgC;AAChC,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,wDAAsC;AACtC,mDAAiC;AACjC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,oDAAkC;AAClC,qDAAmC;AACnC,qDAAmC;AACnC,qDAAmC;AACnC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,sDAAoC;AACpC,uDAAqC;AACrC,uDAAqC;AACrC,uDAAqC;AACrC,uDAAqC;AACrC,uDAAqC;AACrC,uDAAqC;AACrC,uDAAqC;AACrC,wDAAsC;AACtC,wDAAsC;AACtC,wDAAsC;AACtC,wDAAsC;AACtC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,yDAAuC;AACvC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,0DAAwC;AACxC,2DAAyC;AACzC,2DAAyC;AACzC,2DAAyC;AACzC,2DAAyC;AACzC,2DAAyC;AACzC,2DAAyC;AACzC,2DAAyC;AACzC,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,6DAA2C;AAC3C,6DAA2C;AAC3C,6DAA2C;AAC3C,8DAA4C;AAC5C,8DAA4C;AAC5C,8DAA4C;AAC5C,8DAA4C;AAC5C,+DAA6C;AAC7C,+DAA6C;AAC7C,+DAA6C;AAC7C,+DAA6C;AAC7C,+DAA6C;AAC7C,+DAA6C;AAC7C,+DAA6C;AAC7C,gEAA8C;AAC9C,gEAA8C;AAC9C,gEAA8C;AAC9C,gEAA8C;AAC9C,iEAA+C;AAC/C,iEAA+C;AAC/C,gEAA8C;AAC9C,iEAA+C;AAC/C,mEAAiD;AACjD,mEAAiD;AACjD,mEAAiD;AACjD,oEAAkD;AAClD,sEAAoD;AACpD,sEAAoD;AACpD,uEAAqD;AACrD,+DAA6C;AAC7C,yEAAuD;AACvD,yDAAuC;AACvC,wDAAsC;AACtC,yDAAuC;AACvC,yDAAuC;AACvC,4DAA0C;AAC1C,wEAAsD;AACtD,mEAAiD;AACjD,0DAAwC;AACxC,yDAAuC;AACvC,0DAAwC;AACxC,0DAAwC;AACxC,6DAA2C;AAC3C,gEAA8C;AAC9C,uDAAqC;AACrC,uEAAqD;AACrD,wEAAsD;AACtD,uEAAqD"}

package/dist/lib/openapi/spec/instance-admin-stats-schema.d.ts

@@ -3,57 +3,120 @@ export declare const instanceAdminStatsSchema: {
     readonly $id: "#/components/schemas/instanceAdminStatsSchema";
     readonly type: "object";
     readonly additionalProperties: false;
+    readonly description: "Information about an instance and statistics about usage of various features of Unleash";
     readonly required: readonly ["instanceId"];
     readonly properties: {
         readonly instanceId: {
             readonly type: "string";
+            readonly description: "A unique identifier for this instance. Generated by the database migration scripts at first run. Typically a UUID.";
+            readonly example: "ed3861ae-78f9-4e8c-8e57-b57efc15f82b";
         };
         readonly timestamp: {
             readonly type: "string";
             readonly format: "date-time";
             readonly nullable: true;
+            readonly description: "When these statistics were produced";
+            readonly example: "2023-06-12T12:25:06Z";
         };
         readonly versionOSS: {
             readonly type: "string";
+            readonly description: "The version of Unleash OSS that is bundled in this instance";
+            readonly example: "5.1.7";
         };
         readonly versionEnterprise: {
             readonly type: "string";
+            readonly description: "The version of Unleash Enterprise that is bundled in this instance";
+            readonly example: "5.1.7";
         };
         readonly users: {
             readonly type: "number";
+            readonly description: "The number of users this instance has";
+            readonly example: 8;
+            readonly minimum: 0;
         };
         readonly featureToggles: {
             readonly type: "number";
+            readonly description: "The number of feature-toggles this instance has";
+            readonly example: 47;
+            readonly minimum: 0;
         };
         readonly projects: {
             readonly type: "number";
+            readonly description: "The number of projects defined in this instance.";
+            readonly example: 3;
+            readonly minimum: 0;
         };
         readonly contextFields: {
             readonly type: "number";
+            readonly description: "The number of context fields defined in this instance.";
+            readonly example: 7;
+            readonly minimum: 0;
         };
         readonly roles: {
             readonly type: "number";
+            readonly description: "The number of roles defined in this instance";
+            readonly example: 5;
+            readonly minimum: 0;
         };
         readonly groups: {
             readonly type: "number";
+            readonly description: "The number of groups defined in this instance";
+            readonly example: 12;
+            readonly minimum: 0;
         };
         readonly environments: {
             readonly type: "number";
+            readonly description: "The number of environments defined in this instance";
+            readonly example: 3;
+            readonly minimum: 0;
         };
         readonly segments: {
             readonly type: "number";
+            readonly description: "The number of segments defined in this instance";
+            readonly example: 19;
+            readonly minimum: 0;
         };
         readonly strategies: {
             readonly type: "number";
+            readonly description: "The number of strategies defined in this instance";
+            readonly example: 8;
+            readonly minimum: 0;
         };
         readonly SAMLenabled: {
-            readonly type: "number";
+            readonly type: "boolean";
+            readonly description: "Whether or not SAML authentication is enabled for this instance";
+            readonly example: false;
         };
         readonly OIDCenabled: {
-            readonly type: "number";
+            readonly type: "boolean";
+            readonly description: "Whether or not OIDC authentication is enabled for this instance";
+            readonly example: true;
+        };
+        readonly clientApps: {
+            readonly type: "array";
+            readonly description: "A count of connected applications in the last week, last month and all time since last restart";
+            readonly items: {
+                readonly type: "object";
+                readonly description: "An entry describing how many client applications has been observed over the defined range";
+                readonly properties: {
+                    readonly range: {
+                        readonly type: "string";
+                        readonly description: "A description of a time range";
+                        readonly enum: readonly ["allTime", "30d", "7d"];
+                        readonly example: "30d";
+                    };
+                    readonly count: {
+                        readonly type: "number";
+                        readonly description: "The number of client applications that have been observed in this period";
+                        readonly example: 1;
+                    };
+                };
+            };
         };
         readonly sum: {
             readonly type: "string";
+            readonly description: "A SHA-256 checksum of the instance statistics to be used to verify that the data in this object has not been tampered with";
+            readonly example: "b023323477abb1eb145bebf3cdb30a1c2063e3edc1f7ae474ed8ed6c80de9a3b";
         };
     };
     readonly components: {};

package/dist/lib/openapi/spec/instance-admin-stats-schema.js

@@ -5,57 +5,120 @@ exports.instanceAdminStatsSchema = {
     $id: '#/components/schemas/instanceAdminStatsSchema',
     type: 'object',
     additionalProperties: false,
+    description: 'Information about an instance and statistics about usage of various features of Unleash',
     required: ['instanceId'],
     properties: {
         instanceId: {
             type: 'string',
+            description: 'A unique identifier for this instance. Generated by the database migration scripts at first run. Typically a UUID.',
+            example: 'ed3861ae-78f9-4e8c-8e57-b57efc15f82b',
         },
         timestamp: {
             type: 'string',
             format: 'date-time',
             nullable: true,
+            description: 'When these statistics were produced',
+            example: '2023-06-12T12:25:06Z',
         },
         versionOSS: {
             type: 'string',
+            description: 'The version of Unleash OSS that is bundled in this instance',
+            example: '5.1.7',
         },
         versionEnterprise: {
             type: 'string',
+            description: 'The version of Unleash Enterprise that is bundled in this instance',
+            example: '5.1.7',
         },
         users: {
             type: 'number',
+            description: 'The number of users this instance has',
+            example: 8,
+            minimum: 0,
         },
         featureToggles: {
             type: 'number',
+            description: 'The number of feature-toggles this instance has',
+            example: 47,
+            minimum: 0,
         },
         projects: {
             type: 'number',
+            description: 'The number of projects defined in this instance.',
+            example: 3,
+            minimum: 0,
         },
         contextFields: {
             type: 'number',
+            description: 'The number of context fields defined in this instance.',
+            example: 7,
+            minimum: 0,
         },
         roles: {
             type: 'number',
+            description: 'The number of roles defined in this instance',
+            example: 5,
+            minimum: 0,
         },
         groups: {
             type: 'number',
+            description: 'The number of groups defined in this instance',
+            example: 12,
+            minimum: 0,
         },
         environments: {
             type: 'number',
+            description: 'The number of environments defined in this instance',
+            example: 3,
+            minimum: 0,
         },
         segments: {
             type: 'number',
+            description: 'The number of segments defined in this instance',
+            example: 19,
+            minimum: 0,
         },
         strategies: {
             type: 'number',
+            description: 'The number of strategies defined in this instance',
+            example: 8,
+            minimum: 0,
         },
         SAMLenabled: {
-            type: 'number',
+            type: 'boolean',
+            description: 'Whether or not SAML authentication is enabled for this instance',
+            example: false,
         },
         OIDCenabled: {
-            type: 'number',
+            type: 'boolean',
+            description: 'Whether or not OIDC authentication is enabled for this instance',
+            example: true,
+        },
+        clientApps: {
+            type: 'array',
+            description: 'A count of connected applications in the last week, last month and all time since last restart',
+            items: {
+                type: 'object',
+                description: 'An entry describing how many client applications has been observed over the defined range',
+                properties: {
+                    range: {
+                        type: 'string',
+                        description: 'A description of a time range',
+                        enum: ['allTime', '30d', '7d'],
+                        example: '30d',
+                    },
+                    count: {
+                        type: 'number',
+                        description: 'The number of client applications that have been observed in this period',
+                        example: 1,
+                    },
+                },
+            },
         },
         sum: {
             type: 'string',
+            description: 'A SHA-256 checksum of the instance statistics to be used to verify that the data in this object has not been tampered with',
+            example: 'b023323477abb1eb145bebf3cdb30a1c2063e3edc1f7ae474ed8ed6c80de9a3b',
         },
     },
     components: {},

package/dist/lib/openapi/spec/instance-admin-stats-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"instance-admin-stats-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/instance-admin-stats-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,wBAAwB,GAAG;IACpC,GAAG,EAAE,+CAA+C;IACpD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,YAAY,CAAC;IACxB,UAAU,EAAE;QACR,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;SACjB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;SACjB;QACD,iBAAiB,EAAE;YACf,IAAI,EAAE,QAAQ;SACjB;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;SACjB;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,QAAQ;SACjB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;QACD,aAAa,EAAE;YACX,IAAI,EAAE,QAAQ;SACjB;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;SACjB;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;SACjB;QACD,YAAY,EAAE;YACV,IAAI,EAAE,QAAQ;SACjB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,GAAG,EAAE;YACD,IAAI,EAAE,QAAQ;SACjB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"instance-admin-stats-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/instance-admin-stats-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,wBAAwB,GAAG;IACpC,GAAG,EAAE,+CAA+C;IACpD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,yFAAyF;IAC7F,QAAQ,EAAE,CAAC,YAAY,CAAC;IACxB,UAAU,EAAE;QACR,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,oHAAoH;YACxH,OAAO,EAAE,sCAAsC;SAClD;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,qCAAqC;YAClD,OAAO,EAAE,sBAAsB;SAClC;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,6DAA6D;YACjE,OAAO,EAAE,OAAO;SACnB;QACD,iBAAiB,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,oEAAoE;YACxE,OAAO,EAAE,OAAO;SACnB;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,uCAAuC;YACpD,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;SACb;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,iDAAiD;YAC9D,OAAO,EAAE,EAAE;YACX,OAAO,EAAE,CAAC;SACb;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,kDAAkD;YAC/D,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;SACb;QACD,aAAa,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,wDAAwD;YAC5D,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;SACb;QACD,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,8CAA8C;YAC3D,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;SACb;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,+CAA+C;YAC5D,OAAO,EAAE,EAAE;YACX,OAAO,EAAE,CAAC;SACb;QACD,YAAY,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qDAAqD;YAClE,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;SACb;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,iDAAiD;YAC9D,OAAO,EAAE,EAAE;YACX,OAAO,EAAE,CAAC;SACb;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,mDAAmD;YAChE,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;SACb;QACD,WAAW,EAAE;YACT,IAAI,EAAE,SAAS;YACf,WAAW,EACP,iEAAiE;YACrE,OAAO,EAAE,KAAK;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,SAAS;YACf,WAAW,EACP,iEAAiE;YACrE,OAAO,EAAE,IAAI;SAChB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,WAAW,EACP,gGAAgG;YACpG,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,WAAW,EACP,2FAA2F;gBAC/F,UAAU,EAAE;oBACR,KAAK,EAAE;wBACH,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,+BAA+B;wBAC5C,IAAI,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,IAAI,CAAC;wBAC9B,OAAO,EAAE,KAAK;qBACjB;oBACD,KAAK,EAAE;wBACH,IAAI,EAAE,QAAQ;wBACd,WAAW,EACP,0EAA0E;wBAC9E,OAAO,EAAE,CAAC;qBACb;iBACJ;aACJ;SACJ;QACD,GAAG,EAAE;YACD,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,4HAA4H;YAChI,OAAO,EACH,kEAAkE;SACzE;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -4,15 +4,20 @@ export declare const 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/override-schema.js

@@ -6,15 +6,20 @@ exports.overrideSchema = {
     type: 'object',
     additionalProperties: false,
     required: ['contextName', 'values'],
+    description: 'An override for deciding which variant should be assigned to a user based on the context name',
     properties: {
         contextName: {
+            description: 'The name of the context field used to determine overrides',
             type: 'string',
+            example: 'userId',
         },
         values: {
+            description: 'Which values that should be overriden',
             type: 'array',
             items: {
                 type: 'string',
             },
+            example: ['red', 'blue'],
         },
     },
     components: {},

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

@@ -1 +1 @@
-{"version":3,"file":"override-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/override-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,cAAc,GAAG;IAC1B,GAAG,EAAE,qCAAqC;IAC1C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,aAAa,EAAE,QAAQ,CAAC;IACnC,UAAU,EAAE;QACR,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"override-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/override-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,cAAc,GAAG;IAC1B,GAAG,EAAE,qCAAqC;IAC1C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,aAAa,EAAE,QAAQ,CAAC;IACnC,WAAW,EACP,+FAA+F;IACnG,UAAU,EAAE;QACR,WAAW,EAAE;YACT,WAAW,EACP,2DAA2D;YAC/D,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;SACpB;QACD,MAAM,EAAE;YACJ,WAAW,EAAE,uCAAuC;YACpD,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;YACD,OAAO,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC;SAC3B;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -8,6 +8,9 @@ export declare const passwordSchema: {
         readonly password: {
             readonly type: "string";
         };
+        readonly oldPassword: {
+            readonly type: "string";
+        };
         readonly confirmPassword: {
             readonly type: "string";
         };

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

@@ -10,6 +10,9 @@ exports.passwordSchema = {
         password: {
             type: 'string',
         },
+        oldPassword: {
+            type: 'string',
+        },
         confirmPassword: {
             type: 'string',
         },

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

@@ -1 +1 @@
-{"version":3,"file":"password-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/password-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,cAAc,GAAG;IAC1B,GAAG,EAAE,qCAAqC;IAC1C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,CAAC;IACtB,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;QACD,eAAe,EAAE;YACb,IAAI,EAAE,QAAQ;SACjB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"password-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/password-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,cAAc,GAAG;IAC1B,GAAG,EAAE,qCAAqC;IAC1C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,CAAC;IACtB,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,eAAe,EAAE;YACb,IAAI,EAAE,QAAQ;SACjB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -21,6 +21,7 @@ export declare const playgroundFeatureSchema: {
             readonly type: "object";
             readonly additionalProperties: false;
             readonly required: readonly ["result", "data"];
+            readonly description: "The feature's applicable strategies and cumulative results of the strategies";
             readonly properties: {
                 readonly result: {
                     readonly description: "The cumulative results of all the feature's strategies. Can be `true`,\n                                  `false`, or `unknown`.\n                                  This property will only be `unknown`\n                                  if one or more of the strategies can't be fully evaluated and the rest of the strategies\n                                  all resolve to `false`.";
@@ -91,6 +92,7 @@ export declare const playgroundFeatureSchema: {
         };
         readonly variants: {
             readonly type: "array";
+            readonly description: "The feature variants.";
             readonly items: {
                 readonly $ref: "#/components/schemas/variantSchema";
             };
@@ -102,7 +104,7 @@ export declare const playgroundFeatureSchema: {
                 readonly $id: "#/components/schemas/playgroundStrategySchema";
                 readonly type: "object";
                 readonly additionalProperties: false;
-                readonly required: readonly ["id", "name", "result", "segments", "constraints", "parameters", "disabled"];
+                readonly required: readonly ["id", "name", "result", "segments", "constraints", "parameters", "disabled", "links"];
                 readonly properties: {
                     readonly name: {
                         readonly description: "The strategy's name.";
@@ -116,6 +118,7 @@ export declare const playgroundFeatureSchema: {
                     readonly id: {
                         readonly description: "The strategy's id.";
                         readonly type: "string";
+                        readonly example: "3AECCF7E-FF82-4174-8287-8EBE06079A50";
                     };
                     readonly result: {
                         readonly anyOf: readonly [{
@@ -184,6 +187,17 @@ export declare const playgroundFeatureSchema: {
                         };
                         readonly $ref: "#/components/schemas/parametersSchema";
                     };
+                    readonly links: {
+                        readonly description: "A set of links to actions you can perform on this strategy";
+                        readonly type: "object";
+                        readonly required: readonly ["edit"];
+                        readonly properties: {
+                            readonly edit: {
+                                readonly type: "string";
+                                readonly example: "/projects/some-project/features/some-feature/strategies/edit?environmentId=some-env&strategyId= 3AECCF7E-FF82-4174-8287-8EBE06079A50";
+                            };
+                        };
+                    };
                 };
                 readonly components: {
                     readonly schemas: {
@@ -466,23 +480,34 @@ export declare const playgroundFeatureSchema: {
                 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: "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 properties: {
                             readonly type: {
                                 readonly type: "string";
@@ -491,8 +516,13 @@ export declare const playgroundFeatureSchema: {
                                 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";
@@ -506,15 +536,20 @@ export declare const playgroundFeatureSchema: {
                             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: {};
@@ -527,15 +562,20 @@ export declare const playgroundFeatureSchema: {
                 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/playground-feature-schema.js

@@ -37,6 +37,7 @@ exports.playgroundFeatureSchema = {
             type: 'object',
             additionalProperties: false,
             required: ['result', 'data'],
+            description: "The feature's applicable strategies and cumulative results of the strategies",
             properties: {
                 result: {
                     description: `The cumulative results of all the feature's strategies. Can be \`true\`,
@@ -112,7 +113,11 @@ exports.playgroundFeatureSchema = {
             nullable: true,
             example: { name: 'green', enabled: true },
         },
-        variants: { type: 'array', items: { $ref: variant_schema_1.variantSchema.$id } },
+        variants: {
+            type: 'array',
+            description: 'The feature variants.',
+            items: { $ref: variant_schema_1.variantSchema.$id },
+        },
     },
     components: {
         schemas: {

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

@@ -1 +1 @@
-{"version":3,"file":"playground-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/playground-feature-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,qDAAiD;AACjD,uDAAmD;AACnD,6EAGsC;AACtC,iFAA4E;AAC5E,2EAAsE;AAEzD,QAAA,8BAA8B,GAAG,aAAsB,CAAC;AAExD,QAAA,uBAAuB,GAAG;IACnC,GAAG,EAAE,8CAA8C;IACnD,WAAW,EACP,wEAAwE;IAC5E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE;QACN,MAAM;QACN,WAAW;QACX,WAAW;QACX,+BAA+B;QAC/B,SAAS;QACT,UAAU;QACV,YAAY;KACf;IACD,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,YAAY;YACrB,WAAW,EAAE,qBAAqB;SACrC;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,YAAY;YACrB,WAAW,EAAE,mDAAmD;SACnE;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;YAC5B,UAAU,EAAE;gBACR,MAAM,EAAE;oBACJ,WAAW,EAAE;oDACmB,yDAA4B,CAAC,aAAa;iEAC7B,yDAA4B,CAAC,aAAa;;4DAE/C;oBACxC,KAAK,EAAE;wBACH,EAAE,IAAI,EAAE,SAAS,EAAE;wBACnB;4BACI,IAAI,EAAE,QAAQ;4BACd,IAAI,EAAE,CAAC,yDAA4B,CAAC,aAAa,CAAC;yBACrD;qBACJ;iBACJ;gBACD,IAAI,EAAE;oBACF,WAAW,EAAE,4CAA4C;oBACzD,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,qDAAwB,CAAC,GAAG;qBACrC;iBACJ;aACJ;SACJ;QACD,6BAA6B,EAAE;YAC3B,IAAI,EAAE,SAAS;YACf,WAAW,EACP,2GAA2G;SAClH;QACD,SAAS,EAAE;YACP,WAAW,EAAE;uGAC8E,yDAA4B,CAAC,aAAa;gHACjC;YACpG,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;SAChB;QACD,OAAO,EAAE;YACL,WAAW,EAAE;;;sFAG6D;YAC1E,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;YAC7B,UAAU,EAAE;gBACR,IAAI,EAAE;oBACF,IAAI,EAAE,QAAQ;oBACd,WAAW,EACP,kGAAkG;oBACtG,OAAO,EAAE,aAAa;iBACzB;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,SAAS;oBACf,WAAW,EACP,iIAAiI;iBACxI;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,oBAAoB,EAAE,KAAK;oBAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;oBAC3B,WAAW,EAAE,8CAA8C;oBAC3D,UAAU,EAAE;wBACR,IAAI,EAAE;4BACF,WAAW,EAAE,4BAA4B;4BACzC,IAAI,EAAE,QAAQ;4BACd,IAAI,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC;yBAClC;wBACD,KAAK,EAAE;4BACH,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,gCAAgC;4BAC7C,OAAO,EAAE,uBAAuB;yBACnC;qBACJ;iBACJ;aACJ;YACD,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE;SAC5C;QACD,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,8BAAa,CAAC,GAAG,EAAE,EAAE;KAClE;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,wBAAwB,EAAxB,qDAAwB;YACxB,0BAA0B,EAA1B,yDAA0B;YAC1B,uBAAuB,EAAvB,mDAAuB;YACvB,gBAAgB,EAAhB,oCAAgB;YAChB,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;SACjB;QACD,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,8BAAa,CAAC,GAAG,EAAE,EAAE;KAClE;CACK,CAAC"}
+{"version":3,"file":"playground-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/playground-feature-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,qDAAiD;AACjD,uDAAmD;AACnD,6EAGsC;AACtC,iFAA4E;AAC5E,2EAAsE;AAEzD,QAAA,8BAA8B,GAAG,aAAsB,CAAC;AAExD,QAAA,uBAAuB,GAAG;IACnC,GAAG,EAAE,8CAA8C;IACnD,WAAW,EACP,wEAAwE;IAC5E,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE;QACN,MAAM;QACN,WAAW;QACX,WAAW;QACX,+BAA+B;QAC/B,SAAS;QACT,UAAU;QACV,YAAY;KACf;IACD,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,YAAY;YACrB,WAAW,EAAE,qBAAqB;SACrC;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,YAAY;YACrB,WAAW,EAAE,mDAAmD;SACnE;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;YAC5B,WAAW,EACP,8EAA8E;YAClF,UAAU,EAAE;gBACR,MAAM,EAAE;oBACJ,WAAW,EAAE;oDACmB,yDAA4B,CAAC,aAAa;iEAC7B,yDAA4B,CAAC,aAAa;;4DAE/C;oBACxC,KAAK,EAAE;wBACH,EAAE,IAAI,EAAE,SAAS,EAAE;wBACnB;4BACI,IAAI,EAAE,QAAQ;4BACd,IAAI,EAAE,CAAC,yDAA4B,CAAC,aAAa,CAAC;yBACrD;qBACJ;iBACJ;gBACD,IAAI,EAAE;oBACF,WAAW,EAAE,4CAA4C;oBACzD,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACH,IAAI,EAAE,qDAAwB,CAAC,GAAG;qBACrC;iBACJ;aACJ;SACJ;QACD,6BAA6B,EAAE;YAC3B,IAAI,EAAE,SAAS;YACf,WAAW,EACP,2GAA2G;SAClH;QACD,SAAS,EAAE;YACP,WAAW,EAAE;uGAC8E,yDAA4B,CAAC,aAAa;gHACjC;YACpG,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;SAChB;QACD,OAAO,EAAE;YACL,WAAW,EAAE;;;sFAG6D;YAC1E,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;YAC7B,UAAU,EAAE;gBACR,IAAI,EAAE;oBACF,IAAI,EAAE,QAAQ;oBACd,WAAW,EACP,kGAAkG;oBACtG,OAAO,EAAE,aAAa;iBACzB;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,SAAS;oBACf,WAAW,EACP,iIAAiI;iBACxI;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,oBAAoB,EAAE,KAAK;oBAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;oBAC3B,WAAW,EAAE,8CAA8C;oBAC3D,UAAU,EAAE;wBACR,IAAI,EAAE;4BACF,WAAW,EAAE,4BAA4B;4BACzC,IAAI,EAAE,QAAQ;4BACd,IAAI,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC;yBAClC;wBACD,KAAK,EAAE;4BACH,IAAI,EAAE,QAAQ;4BACd,WAAW,EAAE,gCAAgC;4BAC7C,OAAO,EAAE,uBAAuB;yBACnC;qBACJ;iBACJ;aACJ;YACD,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE;SAC5C;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,uBAAuB;YACpC,KAAK,EAAE,EAAE,IAAI,EAAE,8BAAa,CAAC,GAAG,EAAE;SACrC;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,wBAAwB,EAAxB,qDAAwB;YACxB,0BAA0B,EAA1B,yDAA0B;YAC1B,uBAAuB,EAAvB,mDAAuB;YACvB,gBAAgB,EAAhB,oCAAgB;YAChB,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;SACjB;QACD,QAAQ,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,8BAAa,CAAC,GAAG,EAAE,EAAE;KAClE;CACK,CAAC"}

package/dist/lib/openapi/spec/playground-feature-schema.test.js

@@ -36,6 +36,9 @@ const playgroundStrategy = (name, parameters) => fast_check_1.default.record({
     constraints: playgroundStrategyConstraints(),
     segments: fast_check_1.default.array(playgroundSegment()),
     disabled: fast_check_1.default.boolean(),
+    links: fast_check_1.default.constant({
+        edit: '/projects/some-project/features/some-feature/strategies/edit?environmentId=some-env&strategyId=some-strat',
+    }),
 });
 const playgroundStrategies = () => fast_check_1.default.array(fast_check_1.default.oneof(playgroundStrategy('default', fast_check_1.default.constant({})), playgroundStrategy('flexibleRollout', fast_check_1.default.record({
     groupId: fast_check_1.default.lorem({ maxCount: 1 }),

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

@@ -1 +1 @@
-{"version":3,"file":"playground-feature-schema.test.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/playground-feature-schema.test.ts"],"names":[],"mappings":";;;;;;AAAA,4DAA2C;AAC3C,qEAIwC;AACxC,0CAA6C;AAE7C,2EAGqC;AAErC,6EAGsC;AAEtC,MAAM,4BAA4B,GAC9B,GAA0C,EAAE,CACxC,oBAAE;KACG,KAAK,CAAC,oBAAE,CAAC,OAAO,EAAE,EAAE,IAAA,qCAAkB,GAAE,CAAC;KACzC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;IAC5B,GAAG,UAAU;IACb,MAAM;CACT,CAAC,CAAC,CAAC;AAEhB,MAAM,6BAA6B,GAAG,GAEpC,EAAE,CAAC,oBAAE,CAAC,KAAK,CAAC,4BAA4B,EAAE,CAAC,CAAC;AAE9C,MAAM,iBAAiB,GAAG,GAAuC,EAAE,CAC/D,oBAAE,CAAC,MAAM,CAAC;IACN,IAAI,EAAE,oBAAE,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;IACjC,EAAE,EAAE,oBAAE,CAAC,GAAG,EAAE;IACZ,MAAM,EAAE,oBAAE,CAAC,OAAO,EAAE;IACpB,WAAW,EAAE,6BAA6B,EAAE;CAC/C,CAAC,CAAC;AAEP,MAAM,kBAAkB,GAAG,CACvB,IAAY,EACZ,UAA6C,EACV,EAAE,CACrC,oBAAE,CAAC,MAAM,CAAC;IACN,EAAE,EAAE,oBAAE,CAAC,IAAI,EAAE;IACb,IAAI,EAAE,oBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;IACvB,MAAM,EAAE,oBAAE,CAAC,KAAK,CACZ,oBAAE,CAAC,MAAM,CAAC;QACN,gBAAgB,EAAE,oBAAE,CAAC,QAAQ,CACzB,yDAA4B,CAAC,kBAAkB,CAClD;QACD,OAAO,EAAE,oBAAE,CAAC,OAAO,EAAE;KACxB,CAAC,EACF,oBAAE,CAAC,MAAM,CAAC;QACN,gBAAgB,EAAE,oBAAE,CAAC,QAAQ,CACzB,yDAA4B,CAAC,oBAAoB,CACpD;QACD,OAAO,EAAE,oBAAE,CAAC,YAAY,CACpB,yDAA4B,CAAC,aAAa,EAC1C,KAAc,CACjB;KACJ,CAAC,CACL;IACD,UAAU;IACV,WAAW,EAAE,6BAA6B,EAAE;IAC5C,QAAQ,EAAE,oBAAE,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC;IACvC,QAAQ,EAAE,oBAAE,CAAC,OAAO,EAAE;CACzB,CAAC,CAAC;AAEP,MAAM,oBAAoB,GAAG,GAA0C,EAAE,CACrE,oBAAE,CAAC,KAAK,CACJ,oBAAE,CAAC,KAAK,CACJ,kBAAkB,CAAC,SAAS,EAAE,oBAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAC9C,kBAAkB,CACd,iBAAiB,EACjB,oBAAE,CAAC,MAAM,CAAC;IACN,OAAO,EAAE,oBAAE,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IAClC,OAAO,EAAE,oBAAE,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;IACzC,UAAU,EAAE,oBAAE,CAAC,YAAY,CACvB,SAAS,EACT,QAAQ,EACR,WAAW,CACd;CACJ,CAAC,CACL,EACD,kBAAkB,CACd,qBAAqB,EACrB,oBAAE,CAAC,MAAM,CAAC;IACN,SAAS,EAAE,oBAAE;SACR,WAAW,CAAC,oBAAE,CAAC,MAAM,EAAE,CAAC;SACxB,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CAC3C,CAAC,CACL,EAED,kBAAkB,CACd,YAAY,EACZ,oBAAE,CAAC,MAAM,CAAC;IACN,OAAO,EAAE,oBAAE;SACN,WAAW,CAAC,oBAAE,CAAC,YAAY,EAAE,CAAC;SAC9B,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CACnC,CAAC,CACL,EACD,kBAAkB,CACd,eAAe,EACf,oBAAE,CAAC,MAAM,CAAC;IACN,GAAG,EAAE,oBAAE,CAAC,WAAW,CAAC,oBAAE,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CAC7D,CAAC,CACL,CACJ,CACJ,CAAC;AAEC,MAAM,QAAQ,GAAG,GAAuC,EAAE,CAC7D,oBAAE;KACG,KAAK,CACF,IAAA,2BAAQ,GAAE,EACV,oBAAE,CAAC,GAAG,EAAE,EACR,oBAAE,CAAC,MAAM,CAAC;IACN,6BAA6B,EAAE,oBAAE,CAAC,OAAO,EAAE;IAC3C,SAAS,EAAE,IAAA,oCAAiB,GAAE;IAC9B,IAAI,EAAE,IAAA,oCAAiB,GAAE;IACzB,UAAU,EAAE,oBAAoB,EAAE;CACrC,CAAC,CACL;KACA,GAAG,CAAC,CAAC,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,EAAE;IACtD,MAAM,cAAc,GAAG,GAAG,EAAE;QACxB,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;QAE/B,IACI,UAAU,CAAC,IAAI,CACX,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,KAAK,IAAI,CACjD,EACH;YACE,OAAO,IAAI,CAAC;SACf;QACD,IACI,UAAU,CAAC,IAAI,CACX,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS,CACtD,EACH;YACE,OAAO,SAAS,CAAC;SACpB;QACD,OAAO,KAAK,CAAC;IACjB,CAAC,CAAC;IAEF,MAAM,SAAS,GACX,OAAO,CAAC,6BAA6B;QACrC,cAAc,EAAE,KAAK,IAAI,CAAC;IAE9B,+DAA+D;IAC/D,+BAA+B;IAC/B,IAAI,aAAa,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAOrD,CAAC;IAEF,IAAI,iBAAiB,CAAC,MAAM,IAAI,SAAS,EAAE;QACvC,MAAM,aAAa,GACf,iBAAiB,CACb,kBAAkB,GAAG,iBAAiB,CAAC,MAAM,CAChD,CAAC;QACN,MAAM,aAAa,GAAG,aAAa,CAAC,OAAO;YACvC,CAAC,CAAE,aAAa,CAAC,OAGb;YACJ,CAAC,CAAC,SAAS,CAAC;QAEhB,aAAa,GAAG;YACZ,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,OAAO,EAAE,aAAa;SACzB,CAAC;KACL;IAED,OAAO;QACH,GAAG,OAAO;QACV,SAAS;QACT,UAAU,EAAE;YACR,MAAM,EAAE,cAAc,EAAE;YACxB,IAAI,EAAE,OAAO,CAAC,UAAU;SAC3B;QACD,QAAQ,EAAE,iBAAiB;QAC3B,OAAO,EAAE,aAAa;KACzB,CAAC;AACN,CAAC,CAAC,CAAC;AA7EE,QAAA,QAAQ,YA6EV;AAEX,IAAI,CAAC,yBAAyB,EAAE,GAAG,EAAE,CACjC,oBAAE,CAAC,MAAM,CACL,oBAAE,CAAC,QAAQ,CACP,IAAA,gBAAQ,GAAE,EACV,oBAAE,CAAC,OAAO,EAAE,EACZ,CAAC,IAA6B,EAAE,GAAG,EAAE,EAAE;IACnC,MAAM,OAAO,GAAG,IAAA,yBAAc,EAC1B,mDAAuB,CAAC,GAAG,EAC3B,IAAI,CACP,CAAC;IACF,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IACjC,OAAO,OAAO,KAAK,SAAS,CAAC;AACjC,CAAC,CACJ,CACJ,CAAC,CAAC"}
+{"version":3,"file":"playground-feature-schema.test.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/playground-feature-schema.test.ts"],"names":[],"mappings":";;;;;;AAAA,4DAA2C;AAC3C,qEAIwC;AACxC,0CAA6C;AAE7C,2EAGqC;AAErC,6EAGsC;AAEtC,MAAM,4BAA4B,GAC9B,GAA0C,EAAE,CACxC,oBAAE;KACG,KAAK,CAAC,oBAAE,CAAC,OAAO,EAAE,EAAE,IAAA,qCAAkB,GAAE,CAAC;KACzC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC;IAC5B,GAAG,UAAU;IACb,MAAM;CACT,CAAC,CAAC,CAAC;AAEhB,MAAM,6BAA6B,GAAG,GAEpC,EAAE,CAAC,oBAAE,CAAC,KAAK,CAAC,4BAA4B,EAAE,CAAC,CAAC;AAE9C,MAAM,iBAAiB,GAAG,GAAuC,EAAE,CAC/D,oBAAE,CAAC,MAAM,CAAC;IACN,IAAI,EAAE,oBAAE,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,EAAE,CAAC;IACjC,EAAE,EAAE,oBAAE,CAAC,GAAG,EAAE;IACZ,MAAM,EAAE,oBAAE,CAAC,OAAO,EAAE;IACpB,WAAW,EAAE,6BAA6B,EAAE;CAC/C,CAAC,CAAC;AAEP,MAAM,kBAAkB,GAAG,CACvB,IAAY,EACZ,UAA6C,EACV,EAAE,CACrC,oBAAE,CAAC,MAAM,CAAC;IACN,EAAE,EAAE,oBAAE,CAAC,IAAI,EAAE;IACb,IAAI,EAAE,oBAAE,CAAC,QAAQ,CAAC,IAAI,CAAC;IACvB,MAAM,EAAE,oBAAE,CAAC,KAAK,CACZ,oBAAE,CAAC,MAAM,CAAC;QACN,gBAAgB,EAAE,oBAAE,CAAC,QAAQ,CACzB,yDAA4B,CAAC,kBAAkB,CAClD;QACD,OAAO,EAAE,oBAAE,CAAC,OAAO,EAAE;KACxB,CAAC,EACF,oBAAE,CAAC,MAAM,CAAC;QACN,gBAAgB,EAAE,oBAAE,CAAC,QAAQ,CACzB,yDAA4B,CAAC,oBAAoB,CACpD;QACD,OAAO,EAAE,oBAAE,CAAC,YAAY,CACpB,yDAA4B,CAAC,aAAa,EAC1C,KAAc,CACjB;KACJ,CAAC,CACL;IACD,UAAU;IACV,WAAW,EAAE,6BAA6B,EAAE;IAC5C,QAAQ,EAAE,oBAAE,CAAC,KAAK,CAAC,iBAAiB,EAAE,CAAC;IACvC,QAAQ,EAAE,oBAAE,CAAC,OAAO,EAAE;IACtB,KAAK,EAAE,oBAAE,CAAC,QAAQ,CAAC;QACf,IAAI,EAAE,2GAA2G;KACpH,CAAC;CACL,CAAC,CAAC;AAEP,MAAM,oBAAoB,GAAG,GAA0C,EAAE,CACrE,oBAAE,CAAC,KAAK,CACJ,oBAAE,CAAC,KAAK,CACJ,kBAAkB,CAAC,SAAS,EAAE,oBAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,EAC9C,kBAAkB,CACd,iBAAiB,EACjB,oBAAE,CAAC,MAAM,CAAC;IACN,OAAO,EAAE,oBAAE,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,CAAC;IAClC,OAAO,EAAE,oBAAE,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC;IACzC,UAAU,EAAE,oBAAE,CAAC,YAAY,CACvB,SAAS,EACT,QAAQ,EACR,WAAW,CACd;CACJ,CAAC,CACL,EACD,kBAAkB,CACd,qBAAqB,EACrB,oBAAE,CAAC,MAAM,CAAC;IACN,SAAS,EAAE,oBAAE;SACR,WAAW,CAAC,oBAAE,CAAC,MAAM,EAAE,CAAC;SACxB,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CAC3C,CAAC,CACL,EAED,kBAAkB,CACd,YAAY,EACZ,oBAAE,CAAC,MAAM,CAAC;IACN,OAAO,EAAE,oBAAE;SACN,WAAW,CAAC,oBAAE,CAAC,YAAY,EAAE,CAAC;SAC9B,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CACnC,CAAC,CACL,EACD,kBAAkB,CACd,eAAe,EACf,oBAAE,CAAC,MAAM,CAAC;IACN,GAAG,EAAE,oBAAE,CAAC,WAAW,CAAC,oBAAE,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;CAC7D,CAAC,CACL,CACJ,CACJ,CAAC;AAEC,MAAM,QAAQ,GAAG,GAAuC,EAAE,CAC7D,oBAAE;KACG,KAAK,CACF,IAAA,2BAAQ,GAAE,EACV,oBAAE,CAAC,GAAG,EAAE,EACR,oBAAE,CAAC,MAAM,CAAC;IACN,6BAA6B,EAAE,oBAAE,CAAC,OAAO,EAAE;IAC3C,SAAS,EAAE,IAAA,oCAAiB,GAAE;IAC9B,IAAI,EAAE,IAAA,oCAAiB,GAAE;IACzB,UAAU,EAAE,oBAAoB,EAAE;CACrC,CAAC,CACL;KACA,GAAG,CAAC,CAAC,CAAC,iBAAiB,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,EAAE;IACtD,MAAM,cAAc,GAAG,GAAG,EAAE;QACxB,MAAM,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;QAE/B,IACI,UAAU,CAAC,IAAI,CACX,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,KAAK,IAAI,CACjD,EACH;YACE,OAAO,IAAI,CAAC;SACf;QACD,IACI,UAAU,CAAC,IAAI,CACX,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS,CACtD,EACH;YACE,OAAO,SAAS,CAAC;SACpB;QACD,OAAO,KAAK,CAAC;IACjB,CAAC,CAAC;IAEF,MAAM,SAAS,GACX,OAAO,CAAC,6BAA6B;QACrC,cAAc,EAAE,KAAK,IAAI,CAAC;IAE9B,+DAA+D;IAC/D,+BAA+B;IAC/B,IAAI,aAAa,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,EAOrD,CAAC;IAEF,IAAI,iBAAiB,CAAC,MAAM,IAAI,SAAS,EAAE;QACvC,MAAM,aAAa,GACf,iBAAiB,CACb,kBAAkB,GAAG,iBAAiB,CAAC,MAAM,CAChD,CAAC;QACN,MAAM,aAAa,GAAG,aAAa,CAAC,OAAO;YACvC,CAAC,CAAE,aAAa,CAAC,OAGb;YACJ,CAAC,CAAC,SAAS,CAAC;QAEhB,aAAa,GAAG;YACZ,OAAO,EAAE,IAAI;YACb,IAAI,EAAE,aAAa,CAAC,IAAI;YACxB,OAAO,EAAE,aAAa;SACzB,CAAC;KACL;IAED,OAAO;QACH,GAAG,OAAO;QACV,SAAS;QACT,UAAU,EAAE;YACR,MAAM,EAAE,cAAc,EAAE;YACxB,IAAI,EAAE,OAAO,CAAC,UAAU;SAC3B;QACD,QAAQ,EAAE,iBAAiB;QAC3B,OAAO,EAAE,aAAa;KACzB,CAAC;AACN,CAAC,CAAC,CAAC;AA7EE,QAAA,QAAQ,YA6EV;AAEX,IAAI,CAAC,yBAAyB,EAAE,GAAG,EAAE,CACjC,oBAAE,CAAC,MAAM,CACL,oBAAE,CAAC,QAAQ,CACP,IAAA,gBAAQ,GAAE,EACV,oBAAE,CAAC,OAAO,EAAE,EACZ,CAAC,IAA6B,EAAE,GAAG,EAAE,EAAE;IACnC,MAAM,OAAO,GAAG,IAAA,yBAAc,EAC1B,mDAAuB,CAAC,GAAG,EAC3B,IAAI,CACP,CAAC;IACF,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IACjC,OAAO,OAAO,KAAK,SAAS,CAAC;AACjC,CAAC,CACJ,CACJ,CAAC,CAAC"}

package/dist/lib/openapi/spec/playground-request-schema.d.ts

@@ -11,6 +11,7 @@ export declare const playgroundRequestSchema: {
             readonly description: "The environment to evaluate toggles in.";
         };
         readonly projects: {
+            readonly description: "A list of projects to check for toggles in.";
             readonly oneOf: readonly [{
                 readonly type: "array";
                 readonly items: {
@@ -25,7 +26,6 @@ export declare const playgroundRequestSchema: {
             }];
         };
         readonly context: {
-            readonly description: "The context to use when evaluating toggles";
             readonly $ref: "#/components/schemas/sdkContextSchema";
         };
     };
@@ -42,15 +42,18 @@ export declare const playgroundRequestSchema: {
                         readonly type: "string";
                         readonly minLength: 1;
                         readonly example: "My cool application.";
+                        readonly description: "The name of the application.";
                     };
                     readonly currentTime: {
                         readonly type: "string";
                         readonly format: "date-time";
                         readonly example: "2022-07-05T12:56:41+02:00";
+                        readonly description: "A DateTime (or similar) data class instance or a string in an RFC3339-compatible format. Defaults to the current time if not set by the user.";
                     };
                     readonly environment: {
                         readonly type: "string";
                         readonly deprecated: true;
+                        readonly description: "The environment the app is running in.";
                     };
                     readonly properties: {
                         readonly type: "object";
@@ -65,14 +68,17 @@ export declare const playgroundRequestSchema: {
                     readonly remoteAddress: {
                         readonly type: "string";
                         readonly example: "192.168.1.1";
+                        readonly description: "The app's IP address";
                     };
                     readonly sessionId: {
                         readonly type: "string";
                         readonly example: "b65e7b23-fec0-4814-a129-0e9861ef18fc";
+                        readonly description: "An identifier for the current session";
                     };
                     readonly userId: {
                         readonly type: "string";
                         readonly example: "username@provider.com";
+                        readonly description: "An identifier for the current user";
                     };
                 };
                 readonly components: {};