unleash-server 5.2.8 → 5.3.0

package/dist/lib/openapi/spec/context-field-schema.d.ts

@@ -3,39 +3,53 @@ export declare const contextFieldSchema: {
     readonly $id: "#/components/schemas/contextFieldSchema";
     readonly type: "object";
     readonly additionalProperties: false;
+    readonly description: "A representation of a [context field](https://docs.getunleash.io/reference/unleash-context).";
     readonly required: readonly ["name"];
     readonly properties: {
         readonly name: {
+            readonly description: "The name of the context field";
             readonly type: "string";
+            readonly example: "userId";
         };
         readonly description: {
+            readonly description: "The description of the context field.";
             readonly type: "string";
             readonly nullable: true;
+            readonly example: "Used to uniquely identify users";
         };
         readonly stickiness: {
+            readonly description: "Does this context field support being used for [stickiness](https://docs.getunleash.io/reference/stickiness) calculations";
             readonly type: "boolean";
+            readonly example: true;
         };
         readonly sortOrder: {
-            readonly type: "number";
+            readonly description: "Used when sorting a list of context fields. Is also used as a tiebreaker if a list of context fields is sorted alphabetically.";
+            readonly type: "integer";
+            readonly example: 900;
         };
         readonly createdAt: {
+            readonly description: "When this context field was created";
             readonly type: "string";
             readonly format: "date-time";
             readonly nullable: true;
+            readonly example: "2023-06-29T10:19:00.000Z";
         };
         readonly usedInFeatures: {
-            readonly type: "number";
+            readonly type: "integer";
             readonly description: "Number of projects where this context field is used in";
             readonly example: 3;
             readonly nullable: true;
+            readonly minimum: 0;
         };
         readonly usedInProjects: {
-            readonly type: "number";
+            readonly type: "integer";
             readonly description: "Number of projects where this context field is used in";
             readonly example: 2;
             readonly nullable: true;
+            readonly minimum: 0;
         };
         readonly legalValues: {
+            readonly description: "Allowed values for this context field schema. Can be used to narrow down accepted input";
             readonly type: "array";
             readonly items: {
                 readonly $ref: "#/components/schemas/legalValueSchema";
@@ -48,13 +62,18 @@ export declare const contextFieldSchema: {
                 readonly $id: "#/components/schemas/legalValueSchema";
                 readonly type: "object";
                 readonly additionalProperties: false;
+                readonly description: "Describes a legal value. Typically used to limit possible values for contextFields or strategy properties";
                 readonly required: readonly ["value"];
                 readonly properties: {
                     readonly value: {
+                        readonly description: "The valid value";
                         readonly type: "string";
+                        readonly example: "#c154c1";
                     };
                     readonly description: {
+                        readonly description: "Describes this specific legal value";
                         readonly type: "string";
+                        readonly example: "Deep fuchsia";
                     };
                 };
                 readonly components: {};

package/dist/lib/openapi/spec/context-field-schema.js

@@ -6,39 +6,53 @@ exports.contextFieldSchema = {
     $id: '#/components/schemas/contextFieldSchema',
     type: 'object',
     additionalProperties: false,
+    description: 'A representation of a [context field](https://docs.getunleash.io/reference/unleash-context).',
     required: ['name'],
     properties: {
         name: {
+            description: 'The name of the context field',
             type: 'string',
+            example: 'userId',
         },
         description: {
+            description: 'The description of the context field.',
             type: 'string',
             nullable: true,
+            example: 'Used to uniquely identify users',
         },
         stickiness: {
+            description: 'Does this context field support being used for [stickiness](https://docs.getunleash.io/reference/stickiness) calculations',
             type: 'boolean',
+            example: true,
         },
         sortOrder: {
-            type: 'number',
+            description: 'Used when sorting a list of context fields. Is also used as a tiebreaker if a list of context fields is sorted alphabetically.',
+            type: 'integer',
+            example: 900,
         },
         createdAt: {
+            description: 'When this context field was created',
             type: 'string',
             format: 'date-time',
             nullable: true,
+            example: '2023-06-29T10:19:00.000Z',
         },
         usedInFeatures: {
-            type: 'number',
+            type: 'integer',
             description: 'Number of projects where this context field is used in',
             example: 3,
             nullable: true,
+            minimum: 0,
         },
         usedInProjects: {
-            type: 'number',
+            type: 'integer',
             description: 'Number of projects where this context field is used in',
             example: 2,
             nullable: true,
+            minimum: 0,
         },
         legalValues: {
+            description: 'Allowed values for this context field schema. Can be used to narrow down accepted input',
             type: 'array',
             items: {
                 $ref: '#/components/schemas/legalValueSchema',

package/dist/lib/openapi/spec/context-field-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"context-field-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/context-field-schema.ts"],"names":[],"mappings":";;;AACA,6DAAwD;AAE3C,QAAA,kBAAkB,GAAG;IAC9B,GAAG,EAAE,yCAAyC;IAC9C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,SAAS;SAClB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;SACjB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;SACjB;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,wDAAwD;YAC5D,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE,IAAI;SACjB;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,wDAAwD;YAC5D,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE,IAAI;SACjB;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,qCAAgB;SACnB;KACJ;CACK,CAAC"}
+{"version":3,"file":"context-field-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/context-field-schema.ts"],"names":[],"mappings":";;;AACA,6DAAwD;AAE3C,QAAA,kBAAkB,GAAG;IAC9B,GAAG,EAAE,yCAAyC;IAC9C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,8FAA8F;IAClG,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACR,IAAI,EAAE;YACF,WAAW,EAAE,+BAA+B;YAC5C,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,QAAQ;SACpB;QACD,WAAW,EAAE;YACT,WAAW,EAAE,uCAAuC;YACpD,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,iCAAiC;SAC7C;QACD,UAAU,EAAE;YACR,WAAW,EACP,2HAA2H;YAC/H,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;SAChB;QACD,SAAS,EAAE;YACP,WAAW,EACP,gIAAgI;YACpI,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,GAAG;SACf;QACD,SAAS,EAAE;YACP,WAAW,EAAE,qCAAqC;YAClD,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,0BAA0B;SACtC;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,WAAW,EACP,wDAAwD;YAC5D,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,CAAC;SACb;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,WAAW,EACP,wDAAwD;YAC5D,OAAO,EAAE,CAAC;YACV,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,CAAC;SACb;QACD,WAAW,EAAE;YACT,WAAW,EACP,yFAAyF;YAC7F,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,uCAAuC;aAChD;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,qCAAgB;SACnB;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/context-field-strategies-schema.d.ts

@@ -2,7 +2,7 @@ import { FromSchema } from 'json-schema-to-ts';
 export declare const contextFieldStrategiesSchema: {
     readonly $id: "#/components/schemas/segmentStrategiesSchema";
     readonly type: "object";
-    readonly description: "A wrapper object containing all for strategies using a specific context field";
+    readonly description: "A wrapper object containing all strategies that use a specific context field";
     readonly required: readonly ["strategies"];
     readonly properties: {
         readonly strategies: {

package/dist/lib/openapi/spec/context-field-strategies-schema.js

@@ -4,7 +4,7 @@ exports.contextFieldStrategiesSchema = void 0;
 exports.contextFieldStrategiesSchema = {
     $id: '#/components/schemas/segmentStrategiesSchema',
     type: 'object',
-    description: 'A wrapper object containing all for strategies using a specific context field',
+    description: 'A wrapper object containing all strategies that use a specific context field',
     required: ['strategies'],
     properties: {
         strategies: {

package/dist/lib/openapi/spec/context-field-strategies-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"context-field-strategies-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/context-field-strategies-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,4BAA4B,GAAG;IACxC,GAAG,EAAE,8CAA8C;IACnD,IAAI,EAAE,QAAQ;IACd,WAAW,EACP,+EAA+E;IACnF,QAAQ,EAAE,CAAC,YAAY,CAAC;IACxB,UAAU,EAAE;QACR,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,4CAA4C;YACzD,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE;oBACN,IAAI;oBACJ,aAAa;oBACb,WAAW;oBACX,aAAa;oBACb,cAAc;iBACjB;gBACD,UAAU,EAAE;oBACR,EAAE,EAAE;wBACA,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,sCAAsC;wBAC/C,WAAW,EAAE,yBAAyB;qBACzC;oBACD,WAAW,EAAE;wBACT,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,cAAc;wBACvB,WAAW,EACP,sDAAsD;qBAC7D;oBACD,SAAS,EAAE;wBACP,IAAI,EAAE,QAAQ;wBACd,WAAW,EACP,mDAAmD;qBAC1D;oBACD,WAAW,EAAE;wBACT,IAAI,EAAE,QAAQ;wBACd,WAAW,EACP,sDAAsD;qBAC7D;oBACD,YAAY,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,2BAA2B;qBAC3C;iBACJ;aACJ;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"context-field-strategies-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/context-field-strategies-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,4BAA4B,GAAG;IACxC,GAAG,EAAE,8CAA8C;IACnD,IAAI,EAAE,QAAQ;IACd,WAAW,EACP,8EAA8E;IAClF,QAAQ,EAAE,CAAC,YAAY,CAAC;IACxB,UAAU,EAAE;QACR,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,4CAA4C;YACzD,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE;oBACN,IAAI;oBACJ,aAAa;oBACb,WAAW;oBACX,aAAa;oBACb,cAAc;iBACjB;gBACD,UAAU,EAAE;oBACR,EAAE,EAAE;wBACA,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,sCAAsC;wBAC/C,WAAW,EAAE,yBAAyB;qBACzC;oBACD,WAAW,EAAE;wBACT,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,cAAc;wBACvB,WAAW,EACP,sDAAsD;qBAC7D;oBACD,SAAS,EAAE;wBACP,IAAI,EAAE,QAAQ;wBACd,WAAW,EACP,mDAAmD;qBAC1D;oBACD,WAAW,EAAE;wBACT,IAAI,EAAE,QAAQ;wBACd,WAAW,EACP,sDAAsD;qBAC7D;oBACD,YAAY,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,WAAW,EAAE,2BAA2B;qBAC3C;iBACJ;aACJ;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

package/dist/lib/openapi/spec/context-fields-schema.d.ts

@@ -2,6 +2,7 @@ import { FromSchema } from 'json-schema-to-ts';
 export declare const contextFieldsSchema: {
     readonly $id: "#/components/schemas/contextFieldsSchema";
     readonly type: "array";
+    readonly description: "A list of context fields";
     readonly items: {
         readonly $ref: "#/components/schemas/contextFieldSchema";
     };
@@ -11,39 +12,53 @@ export declare const contextFieldsSchema: {
                 readonly $id: "#/components/schemas/contextFieldSchema";
                 readonly type: "object";
                 readonly additionalProperties: false;
+                readonly description: "A representation of a [context field](https://docs.getunleash.io/reference/unleash-context).";
                 readonly required: readonly ["name"];
                 readonly properties: {
                     readonly name: {
+                        readonly description: "The name of the context field";
                         readonly type: "string";
+                        readonly example: "userId";
                     };
                     readonly description: {
+                        readonly description: "The description of the context field.";
                         readonly type: "string";
                         readonly nullable: true;
+                        readonly example: "Used to uniquely identify users";
                     };
                     readonly stickiness: {
+                        readonly description: "Does this context field support being used for [stickiness](https://docs.getunleash.io/reference/stickiness) calculations";
                         readonly type: "boolean";
+                        readonly example: true;
                     };
                     readonly sortOrder: {
-                        readonly type: "number";
+                        readonly description: "Used when sorting a list of context fields. Is also used as a tiebreaker if a list of context fields is sorted alphabetically.";
+                        readonly type: "integer";
+                        readonly example: 900;
                     };
                     readonly createdAt: {
+                        readonly description: "When this context field was created";
                         readonly type: "string";
                         readonly format: "date-time";
                         readonly nullable: true;
+                        readonly example: "2023-06-29T10:19:00.000Z";
                     };
                     readonly usedInFeatures: {
-                        readonly type: "number";
+                        readonly type: "integer";
                         readonly description: "Number of projects where this context field is used in";
                         readonly example: 3;
                         readonly nullable: true;
+                        readonly minimum: 0;
                     };
                     readonly usedInProjects: {
-                        readonly type: "number";
+                        readonly type: "integer";
                         readonly description: "Number of projects where this context field is used in";
                         readonly example: 2;
                         readonly nullable: true;
+                        readonly minimum: 0;
                     };
                     readonly legalValues: {
+                        readonly description: "Allowed values for this context field schema. Can be used to narrow down accepted input";
                         readonly type: "array";
                         readonly items: {
                             readonly $ref: "#/components/schemas/legalValueSchema";
@@ -56,13 +71,18 @@ export declare const contextFieldsSchema: {
                             readonly $id: "#/components/schemas/legalValueSchema";
                             readonly type: "object";
                             readonly additionalProperties: false;
+                            readonly description: "Describes a legal value. Typically used to limit possible values for contextFields or strategy properties";
                             readonly required: readonly ["value"];
                             readonly properties: {
                                 readonly value: {
+                                    readonly description: "The valid value";
                                     readonly type: "string";
+                                    readonly example: "#c154c1";
                                 };
                                 readonly description: {
+                                    readonly description: "Describes this specific legal value";
                                     readonly type: "string";
+                                    readonly example: "Deep fuchsia";
                                 };
                             };
                             readonly components: {};
@@ -74,13 +94,18 @@ export declare const contextFieldsSchema: {
                 readonly $id: "#/components/schemas/legalValueSchema";
                 readonly type: "object";
                 readonly additionalProperties: false;
+                readonly description: "Describes a legal value. Typically used to limit possible values for contextFields or strategy properties";
                 readonly required: readonly ["value"];
                 readonly properties: {
                     readonly value: {
+                        readonly description: "The valid value";
                         readonly type: "string";
+                        readonly example: "#c154c1";
                     };
                     readonly description: {
+                        readonly description: "Describes this specific legal value";
                         readonly type: "string";
+                        readonly example: "Deep fuchsia";
                     };
                 };
                 readonly components: {};

package/dist/lib/openapi/spec/context-fields-schema.js

@@ -6,6 +6,7 @@ const legal_value_schema_1 = require("./legal-value-schema");
 exports.contextFieldsSchema = {
     $id: '#/components/schemas/contextFieldsSchema',
     type: 'array',
+    description: 'A list of context fields',
     items: {
         $ref: '#/components/schemas/contextFieldSchema',
     },

package/dist/lib/openapi/spec/context-fields-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"context-fields-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/context-fields-schema.ts"],"names":[],"mappings":";;;AACA,iEAA4D;AAC5D,6DAAwD;AAE3C,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,OAAO;IACb,KAAK,EAAE;QACH,IAAI,EAAE,yCAAyC;KAClD;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,kBAAkB,EAAlB,yCAAkB;YAClB,gBAAgB,EAAhB,qCAAgB;SACnB;KACJ;CACK,CAAC"}
+{"version":3,"file":"context-fields-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/context-fields-schema.ts"],"names":[],"mappings":";;;AACA,iEAA4D;AAC5D,6DAAwD;AAE3C,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,OAAO;IACb,WAAW,EAAE,0BAA0B;IACvC,KAAK,EAAE;QACH,IAAI,EAAE,yCAAyC;KAClD;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,kBAAkB,EAAlB,yCAAkB;YAClB,gBAAgB,EAAhB,qCAAgB;SACnB;KACJ;CACK,CAAC"}

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

@@ -2,47 +2,145 @@ import { FromSchema } from 'json-schema-to-ts';
 export declare const createApiTokenSchema: {
     readonly $id: "#/components/schemas/createApiTokenSchema";
     readonly type: "object";
-    readonly required: readonly ["type"];
+    readonly description: "The data required to create an [Unleash API token](https://docs.getunleash.io/reference/api-tokens-and-client-keys).";
     readonly properties: {
-        readonly secret: {
-            readonly type: "string";
-        };
-        readonly type: {
-            readonly type: "string";
-            readonly description: `One of ${string}`;
-        };
-        readonly environment: {
-            readonly type: "string";
-        };
-        readonly project: {
-            readonly type: "string";
-        };
-        readonly projects: {
-            readonly type: "array";
-            readonly items: {
-                readonly type: "string";
-            };
-        };
         readonly expiresAt: {
             readonly type: "string";
             readonly format: "date-time";
-            readonly nullable: true;
+            readonly description: "The time when this token should expire.";
+            readonly example: "2023-07-04T11:26:24+02:00";
         };
     };
-    readonly anyOf: readonly [{
-        readonly properties: {
-            readonly username: {
-                readonly type: "string";
+    readonly oneOf: readonly [{
+        readonly allOf: readonly [{
+            readonly required: readonly ["type"];
+            readonly type: "object";
+            readonly properties: {
+                readonly type: {
+                    readonly type: "string";
+                    readonly pattern: "^[Aa][Dd][Mm][Ii][Nn]$";
+                    readonly description: "An admin token. Must be the string \"admin\" (not case sensitive).";
+                    readonly example: "admin";
+                };
             };
-        };
-        readonly required: readonly ["username"];
+        }, {
+            readonly type: "object";
+            readonly required: readonly ["tokenName"];
+            readonly properties: {
+                readonly tokenName: {
+                    readonly type: "string";
+                    readonly description: "The name of the token.";
+                    readonly example: "token-64522";
+                };
+            };
+        }];
     }, {
-        readonly properties: {
-            readonly tokenName: {
-                readonly type: "string";
+        readonly allOf: readonly [{
+            readonly required: readonly ["type"];
+            readonly type: "object";
+            readonly properties: {
+                readonly type: {
+                    readonly type: "string";
+                    readonly pattern: "^[Aa][Dd][Mm][Ii][Nn]$";
+                    readonly description: "An admin token. Must be the string \"admin\" (not case sensitive).";
+                    readonly example: "admin";
+                };
             };
-        };
-        readonly required: readonly ["tokenName"];
+        }, {
+            readonly type: "object";
+            readonly required: readonly ["username"];
+            readonly properties: {
+                readonly username: {
+                    readonly deprecated: true;
+                    readonly type: "string";
+                    readonly description: "The name of the token. This property is deprecated. Use `tokenName` instead.";
+                    readonly example: "token-64523";
+                };
+            };
+        }];
+    }, {
+        readonly allOf: readonly [{
+            readonly required: readonly ["type"];
+            readonly type: "object";
+            readonly properties: {
+                readonly type: {
+                    readonly type: "string";
+                    readonly pattern: "^([Cc][Ll][Ii][Ee][Nn][Tt]|[Ff][Rr][Oo][Nn][Tt][Ee][Nn][Dd])$";
+                    readonly description: "A client or frontend token. Must be one of the strings \"client\" or \"frontend\" (not case sensitive).";
+                    readonly example: "frontend";
+                };
+                readonly environment: {
+                    readonly type: "string";
+                    readonly description: "The environment that the token should be valid for. Defaults to \"default\"";
+                    readonly example: "development";
+                };
+                readonly project: {
+                    readonly type: "string";
+                    readonly description: "The project that the token should be valid for. Defaults to \"*\" meaning every project. This property is mutually incompatible with the `projects` property. If you specify one, you cannot specify the other.";
+                    readonly example: "project-851";
+                };
+                readonly projects: {
+                    readonly type: "array";
+                    readonly description: "A list of projects that the token should be valid for. This property is mutually incompatible with the `project` property. If you specify one, you cannot specify the other.";
+                    readonly example: readonly ["project-851", "project-852"];
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+            };
+        }, {
+            readonly type: "object";
+            readonly required: readonly ["tokenName"];
+            readonly properties: {
+                readonly tokenName: {
+                    readonly type: "string";
+                    readonly description: "The name of the token.";
+                    readonly example: "token-64522";
+                };
+            };
+        }];
+    }, {
+        readonly allOf: readonly [{
+            readonly required: readonly ["type"];
+            readonly type: "object";
+            readonly properties: {
+                readonly type: {
+                    readonly type: "string";
+                    readonly pattern: "^([Cc][Ll][Ii][Ee][Nn][Tt]|[Ff][Rr][Oo][Nn][Tt][Ee][Nn][Dd])$";
+                    readonly description: "A client or frontend token. Must be one of the strings \"client\" or \"frontend\" (not case sensitive).";
+                    readonly example: "frontend";
+                };
+                readonly environment: {
+                    readonly type: "string";
+                    readonly description: "The environment that the token should be valid for. Defaults to \"default\"";
+                    readonly example: "development";
+                };
+                readonly project: {
+                    readonly type: "string";
+                    readonly description: "The project that the token should be valid for. Defaults to \"*\" meaning every project. This property is mutually incompatible with the `projects` property. If you specify one, you cannot specify the other.";
+                    readonly example: "project-851";
+                };
+                readonly projects: {
+                    readonly type: "array";
+                    readonly description: "A list of projects that the token should be valid for. This property is mutually incompatible with the `project` property. If you specify one, you cannot specify the other.";
+                    readonly example: readonly ["project-851", "project-852"];
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+            };
+        }, {
+            readonly type: "object";
+            readonly required: readonly ["username"];
+            readonly properties: {
+                readonly username: {
+                    readonly deprecated: true;
+                    readonly type: "string";
+                    readonly description: "The name of the token. This property is deprecated. Use `tokenName` instead.";
+                    readonly example: "token-64523";
+                };
+            };
+        }];
     }];
     readonly components: {};
 };

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

@@ -1,68 +1,104 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createApiTokenSchema = void 0;
-const api_token_1 = require("../../types/models/api-token");
-// TODO: (openapi) this schema isn't entirely correct: `project` and `projects`
-// are mutually exclusive.
-//
-// That is, when creating a token, you can provide either `project` _or_
-// `projects`, but *not* both.
-//
-// We should be able to annotate this using `oneOf` and `allOf`, but making
-// `oneOf` only valid for _either_ `project` _or_ `projects` is tricky.
-//
-// I've opened an issue to get some help (thought it was a bug initially).
-// There's more info available at:
-//
-// https://github.com/ajv-validator/ajv/issues/2096
-//
-// This also applies to apiTokenSchema and potentially other related schemas.
-exports.createApiTokenSchema = {
-    $id: '#/components/schemas/createApiTokenSchema',
-    type: 'object',
+const adminSchema = {
     required: ['type'],
+    type: 'object',
     properties: {
-        secret: {
+        type: {
+            type: 'string',
+            pattern: '^[Aa][Dd][Mm][Ii][Nn]$',
+            description: `An admin token. Must be the string "admin" (not case sensitive).`,
+            example: 'admin',
+        },
+    },
+};
+const tokenNameSchema = {
+    type: 'object',
+    required: ['tokenName'],
+    properties: {
+        tokenName: {
             type: 'string',
+            description: 'The name of the token.',
+            example: 'token-64522',
         },
+    },
+};
+const usernameSchema = {
+    type: 'object',
+    required: ['username'],
+    properties: {
+        username: {
+            deprecated: true,
+            type: 'string',
+            description: 'The name of the token. This property is deprecated. Use `tokenName` instead.',
+            example: 'token-64523',
+        },
+    },
+};
+const clientFrontendSchema = {
+    required: ['type'],
+    type: 'object',
+    properties: {
         type: {
             type: 'string',
-            description: `One of ${Object.values(api_token_1.ApiTokenType).join(', ')}`,
+            pattern: '^([Cc][Ll][Ii][Ee][Nn][Tt]|[Ff][Rr][Oo][Nn][Tt][Ee][Nn][Dd])$',
+            description: `A client or frontend token. Must be one of the strings "client" or "frontend" (not case sensitive).`,
+            example: 'frontend',
         },
         environment: {
             type: 'string',
+            description: 'The environment that the token should be valid for. Defaults to "default"',
+            example: 'development',
         },
         project: {
             type: 'string',
+            description: 'The project that the token should be valid for. Defaults to "*" meaning every project. This property is mutually incompatible with the `projects` property. If you specify one, you cannot specify the other.',
+            example: 'project-851',
         },
         projects: {
             type: 'array',
+            description: 'A list of projects that the token should be valid for. This property is mutually incompatible with the `project` property. If you specify one, you cannot specify the other.',
+            example: ['project-851', 'project-852'],
             items: {
                 type: 'string',
             },
         },
+    },
+};
+// TODO: (openapi) this schema isn't entirely correct: `project` and `projects`
+// are mutually exclusive.
+//
+// That is, when creating a token, you can provide either `project` _or_
+// `projects`, but *not* both.
+//
+// Because we allow additional properties, we cannot express the mutual
+// exclusiveness in the schema (with OpenAPI 3.0). As such, it's mentioned in
+// the description for now.
+exports.createApiTokenSchema = {
+    $id: '#/components/schemas/createApiTokenSchema',
+    type: 'object',
+    description: 'The data required to create an [Unleash API token](https://docs.getunleash.io/reference/api-tokens-and-client-keys).',
+    properties: {
         expiresAt: {
             type: 'string',
             format: 'date-time',
-            nullable: true,
+            description: 'The time when this token should expire.',
+            example: '2023-07-04T11:26:24+02:00',
         },
     },
-    anyOf: [
+    oneOf: [
         {
-            properties: {
-                username: {
-                    type: 'string',
-                },
-            },
-            required: ['username'],
+            allOf: [adminSchema, tokenNameSchema],
         },
         {
-            properties: {
-                tokenName: {
-                    type: 'string',
-                },
-            },
-            required: ['tokenName'],
+            allOf: [adminSchema, usernameSchema],
+        },
+        {
+            allOf: [clientFrontendSchema, tokenNameSchema],
+        },
+        {
+            allOf: [clientFrontendSchema, usernameSchema],
         },
     ],
     components: {},

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

@@ -1 +1 @@
-{"version":3,"file":"create-api-token-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/create-api-token-schema.ts"],"names":[],"mappings":";;;AACA,4DAA4D;AAE5D,+EAA+E;AAC/E,0BAA0B;AAC1B,EAAE;AACF,wEAAwE;AACxE,8BAA8B;AAC9B,EAAE;AACF,2EAA2E;AAC3E,uEAAuE;AACvE,EAAE;AACF,0EAA0E;AAC1E,kCAAkC;AAClC,EAAE;AACF,mDAAmD;AACnD,EAAE;AACF,6EAA6E;AAEhE,QAAA,oBAAoB,GAAG;IAChC,GAAG,EAAE,2CAA2C;IAChD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,UAAU,EAAE;QACR,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,UAAU,MAAM,CAAC,MAAM,CAAC,wBAAY,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;SAClE;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;SACjB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;SACjB;KACJ;IACD,KAAK,EAAE;QACH;YACI,UAAU,EAAE;gBACR,QAAQ,EAAE;oBACN,IAAI,EAAE,QAAQ;iBACjB;aACJ;YACD,QAAQ,EAAE,CAAC,UAAU,CAAC;SACzB;QACD;YACI,UAAU,EAAE;gBACR,SAAS,EAAE;oBACP,IAAI,EAAE,QAAQ;iBACjB;aACJ;YACD,QAAQ,EAAE,CAAC,WAAW,CAAC;SAC1B;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"create-api-token-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/create-api-token-schema.ts"],"names":[],"mappings":";;;AAEA,MAAM,WAAW,GAAG;IAChB,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,wBAAwB;YACjC,WAAW,EAAE,kEAAkE;YAC/E,OAAO,EAAE,OAAO;SACnB;KACJ;CACK,CAAC;AAEX,MAAM,eAAe,GAAG;IACpB,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,WAAW,CAAC;IACvB,UAAU,EAAE;QACR,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,wBAAwB;YACrC,OAAO,EAAE,aAAa;SACzB;KACJ;CACK,CAAC;AAEX,MAAM,cAAc,GAAG;IACnB,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,UAAU,CAAC;IACtB,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,UAAU,EAAE,IAAI;YAChB,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,8EAA8E;YAClF,OAAO,EAAE,aAAa;SACzB;KACJ;CACK,CAAC;AAEX,MAAM,oBAAoB,GAAG;IACzB,QAAQ,EAAE,CAAC,MAAM,CAAC;IAClB,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EACH,+DAA+D;YACnE,WAAW,EAAE,qGAAqG;YAClH,OAAO,EAAE,UAAU;SACtB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,2EAA2E;YAC/E,OAAO,EAAE,aAAa;SACzB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,+MAA+M;YACnN,OAAO,EAAE,aAAa;SACzB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EACP,8KAA8K;YAClL,OAAO,EAAE,CAAC,aAAa,EAAE,aAAa,CAAC;YACvC,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;KACJ;CACK,CAAC;AAEX,+EAA+E;AAC/E,0BAA0B;AAC1B,EAAE;AACF,wEAAwE;AACxE,8BAA8B;AAC9B,EAAE;AACF,uEAAuE;AACvE,6EAA6E;AAC7E,2BAA2B;AACd,QAAA,oBAAoB,GAAG;IAChC,GAAG,EAAE,2CAA2C;IAChD,IAAI,EAAE,QAAQ;IACd,WAAW,EACP,sHAAsH;IAC1H,UAAU,EAAE;QACR,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,WAAW,EAAE,yCAAyC;YACtD,OAAO,EAAE,2BAA2B;SACvC;KACJ;IACD,KAAK,EAAE;QACH;YACI,KAAK,EAAE,CAAC,WAAW,EAAE,eAAe,CAAC;SACxC;QACD;YACI,KAAK,EAAE,CAAC,WAAW,EAAE,cAAc,CAAC;SACvC;QACD;YACI,KAAK,EAAE,CAAC,oBAAoB,EAAE,eAAe,CAAC;SACjD;QACD;YACI,KAAK,EAAE,CAAC,oBAAoB,EAAE,cAAc,CAAC;SAChD;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -6,15 +6,24 @@ export declare const createFeatureSchema: {
     readonly properties: {
         readonly name: {
             readonly type: "string";
+            readonly example: "disable-comments";
+            readonly description: "Unique feature name";
         };
         readonly type: {
             readonly type: "string";
+            readonly example: "release";
+            readonly description: "The feature toggle's [type](https://docs.getunleash.io/reference/feature-toggle-types). One of experiment, kill-switch, release, operational, or permission";
         };
         readonly description: {
             readonly type: "string";
+            readonly nullable: true;
+            readonly example: "Controls disabling of the comments section in case of an incident";
+            readonly description: "Detailed description of the feature";
         };
         readonly impressionData: {
             readonly type: "boolean";
+            readonly example: false;
+            readonly description: "`true` if the impression data collection is enabled for the feature, otherwise `false`.";
         };
     };
     readonly components: {};