unleash-server 5.2.7 → 5.3.0

package/dist/lib/openapi/spec/import-toggles-schema.js

@@ -15,17 +15,23 @@ const parameters_schema_1 = require("./parameters-schema");
 const legal_value_schema_1 = require("./legal-value-schema");
 const tag_type_schema_1 = require("./tag-type-schema");
 const feature_environment_schema_1 = require("./feature-environment-schema");
+const strategy_variant_schema_1 = require("./strategy-variant-schema");
 exports.importTogglesSchema = {
     $id: '#/components/schemas/importTogglesSchema',
     type: 'object',
     required: ['project', 'environment', 'data'],
     additionalProperties: false,
+    description: 'The result of the export operation for a project and environment, used at import',
     properties: {
         project: {
             type: 'string',
+            example: 'My awesome project',
+            description: 'The exported [project](https://docs.getunleash.io/reference/projects)',
         },
         environment: {
             type: 'string',
+            example: 'development',
+            description: 'The exported [environment](https://docs.getunleash.io/reference/environments)',
         },
         data: {
             $ref: '#/components/schemas/exportResultSchema',
@@ -36,6 +42,7 @@ exports.importTogglesSchema = {
             exportResultSchema: export_result_schema_1.exportResultSchema,
             featureSchema: feature_schema_1.featureSchema,
             featureStrategySchema: feature_strategy_schema_1.featureStrategySchema,
+            strategyVariantSchema: strategy_variant_schema_1.strategyVariantSchema,
             featureEnvironmentSchema: feature_environment_schema_1.featureEnvironmentSchema,
             contextFieldSchema: context_field_schema_1.contextFieldSchema,
             featureTagSchema: feature_tag_schema_1.featureTagSchema,

package/dist/lib/openapi/spec/import-toggles-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"import-toggles-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/import-toggles-schema.ts"],"names":[],"mappings":";;;AACA,iEAA4D;AAC5D,qDAAiD;AACjD,uEAAkE;AAClE,iEAA4D;AAC5D,6DAAwD;AACxD,qDAAiD;AACjD,uDAAmD;AACnD,qDAAiD;AACjD,uDAAmD;AACnD,2DAAuD;AACvD,2DAAuD;AACvD,6DAAwD;AACxD,uDAAkD;AAClD,6EAAwE;AAE3D,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,EAAE,aAAa,EAAE,MAAM,CAAC;IAC5C,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,yCAAyC;SAClD;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,kBAAkB,EAAlB,yCAAkB;YAClB,aAAa,EAAb,8BAAa;YACb,qBAAqB,EAArB,+CAAqB;YACrB,wBAAwB,EAAxB,qDAAwB;YACxB,kBAAkB,EAAlB,yCAAkB;YAClB,gBAAgB,EAAhB,qCAAgB;YAChB,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;YACd,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;YACd,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,qCAAgB;YAChB,aAAa,EAAb,+BAAa;SAChB;KACJ;CACK,CAAC"}
+{"version":3,"file":"import-toggles-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/import-toggles-schema.ts"],"names":[],"mappings":";;;AACA,iEAA4D;AAC5D,qDAAiD;AACjD,uEAAkE;AAClE,iEAA4D;AAC5D,6DAAwD;AACxD,qDAAiD;AACjD,uDAAmD;AACnD,qDAAiD;AACjD,uDAAmD;AACnD,2DAAuD;AACvD,2DAAuD;AACvD,6DAAwD;AACxD,uDAAkD;AAClD,6EAAwE;AACxE,uEAAkE;AAErD,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,EAAE,aAAa,EAAE,MAAM,CAAC;IAC5C,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,kFAAkF;IACtF,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,oBAAoB;YAC7B,WAAW,EACP,uEAAuE;SAC9E;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EACP,+EAA+E;SACtF;QACD,IAAI,EAAE;YACF,IAAI,EAAE,yCAAyC;SAClD;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,kBAAkB,EAAlB,yCAAkB;YAClB,aAAa,EAAb,8BAAa;YACb,qBAAqB,EAArB,+CAAqB;YACrB,qBAAqB,EAArB,+CAAqB;YACrB,wBAAwB,EAAxB,qDAAwB;YACxB,kBAAkB,EAAlB,yCAAkB;YAClB,gBAAgB,EAAhB,qCAAgB;YAChB,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;YACd,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;YACd,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,qCAAgB;YAChB,aAAa,EAAb,+BAAa;SAChB;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/import-toggles-validate-item-schema.d.ts

@@ -4,12 +4,17 @@ export declare const importTogglesValidateItemSchema: {
     readonly type: "object";
     readonly required: readonly ["message", "affectedItems"];
     readonly additionalProperties: false;
+    readonly description: "A description of an error or warning pertaining to a feature toggle import job.";
     readonly properties: {
         readonly message: {
             readonly type: "string";
+            readonly description: "The validation error message";
+            readonly example: "You cannot import a feature that already exist in other projects. You already have the following features defined outside of project default:";
         };
         readonly affectedItems: {
             readonly type: "array";
+            readonly description: "The items affected by this error message ";
+            readonly example: readonly ["some-feature-a", "some-feature-b"];
             readonly items: {
                 readonly type: "string";
             };

package/dist/lib/openapi/spec/import-toggles-validate-item-schema.js

@@ -6,12 +6,17 @@ exports.importTogglesValidateItemSchema = {
     type: 'object',
     required: ['message', 'affectedItems'],
     additionalProperties: false,
+    description: 'A description of an error or warning pertaining to a feature toggle import job.',
     properties: {
         message: {
             type: 'string',
+            description: 'The validation error message',
+            example: 'You cannot import a feature that already exist in other projects. You already have the following features defined outside of project default:',
         },
         affectedItems: {
             type: 'array',
+            description: 'The items affected by this error message ',
+            example: ['some-feature-a', 'some-feature-b'],
             items: {
                 type: 'string',
             },

package/dist/lib/openapi/spec/import-toggles-validate-item-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"import-toggles-validate-item-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/import-toggles-validate-item-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,+BAA+B,GAAG;IAC3C,GAAG,EAAE,sDAAsD;IAC3D,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC;IACtC,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;SACjB;QACD,aAAa,EAAE;YACX,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE,EAAE;KACd;CACK,CAAC"}
+{"version":3,"file":"import-toggles-validate-item-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/import-toggles-validate-item-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,+BAA+B,GAAG;IAC3C,GAAG,EAAE,sDAAsD;IAC3D,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,EAAE,eAAe,CAAC;IACtC,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,iFAAiF;IACrF,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,8BAA8B;YAC3C,OAAO,EACH,+IAA+I;SACtJ;QACD,aAAa,EAAE;YACX,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,2CAA2C;YACxD,OAAO,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,CAAC;YAC7C,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE,EAAE;KACd;CACK,CAAC"}

package/dist/lib/openapi/spec/import-toggles-validate-schema.d.ts

@@ -4,24 +4,37 @@ export declare const importTogglesValidateSchema: {
     readonly type: "object";
     readonly required: readonly ["errors", "warnings"];
     readonly additionalProperties: false;
+    readonly description: "An object containing [feature import](https://docs.getunleash.io/reference/deploy/environment-import-export) validation results.";
     readonly properties: {
         readonly errors: {
+            readonly description: "A list of errors that prevent the provided data from being successfully imported.";
             readonly type: "array";
+            readonly example: readonly [{
+                readonly message: "You cannot import a feature that already exist in other projects. You already have the following features defined outside of project default:";
+                readonly affectedItems: readonly ["my-feature (in project project-854)"];
+            }];
             readonly items: {
                 readonly $ref: "#/components/schemas/importTogglesValidateItemSchema";
             };
         };
         readonly warnings: {
             readonly type: "array";
+            readonly description: "A list of warnings related to the provided data.";
+            readonly example: readonly [{
+                readonly message: "The following strategy types will be used in import. Please make sure the strategy type parameters are configured as in source environment:";
+                readonly affectedItems: readonly ["custom-strategy-7"];
+            }];
             readonly items: {
                 readonly $ref: "#/components/schemas/importTogglesValidateItemSchema";
             };
         };
         readonly permissions: {
             readonly type: "array";
+            readonly description: "Any additional permissions required to import the data. If the list is empty, you require no additional permissions beyond what your user already has.";
             readonly items: {
                 readonly $ref: "#/components/schemas/importTogglesValidateItemSchema";
             };
+            readonly example: readonly [];
         };
     };
     readonly components: {
@@ -31,12 +44,17 @@ export declare const importTogglesValidateSchema: {
                 readonly type: "object";
                 readonly required: readonly ["message", "affectedItems"];
                 readonly additionalProperties: false;
+                readonly description: "A description of an error or warning pertaining to a feature toggle import job.";
                 readonly properties: {
                     readonly message: {
                         readonly type: "string";
+                        readonly description: "The validation error message";
+                        readonly example: "You cannot import a feature that already exist in other projects. You already have the following features defined outside of project default:";
                     };
                     readonly affectedItems: {
                         readonly type: "array";
+                        readonly description: "The items affected by this error message ";
+                        readonly example: readonly ["some-feature-a", "some-feature-b"];
                         readonly items: {
                             readonly type: "string";
                         };

package/dist/lib/openapi/spec/import-toggles-validate-schema.js

@@ -7,24 +7,41 @@ exports.importTogglesValidateSchema = {
     type: 'object',
     required: ['errors', 'warnings'],
     additionalProperties: false,
+    description: 'An object containing [feature import](https://docs.getunleash.io/reference/deploy/environment-import-export) validation results.',
     properties: {
         errors: {
+            description: 'A list of errors that prevent the provided data from being successfully imported.',
             type: 'array',
+            example: [
+                {
+                    message: 'You cannot import a feature that already exist in other projects. You already have the following features defined outside of project default:',
+                    affectedItems: ['my-feature (in project project-854)'],
+                },
+            ],
             items: {
                 $ref: '#/components/schemas/importTogglesValidateItemSchema',
             },
         },
         warnings: {
             type: 'array',
+            description: 'A list of warnings related to the provided data.',
+            example: [
+                {
+                    message: 'The following strategy types will be used in import. Please make sure the strategy type parameters are configured as in source environment:',
+                    affectedItems: ['custom-strategy-7'],
+                },
+            ],
             items: {
                 $ref: '#/components/schemas/importTogglesValidateItemSchema',
             },
         },
         permissions: {
             type: 'array',
+            description: 'Any additional permissions required to import the data. If the list is empty, you require no additional permissions beyond what your user already has.',
             items: {
                 $ref: '#/components/schemas/importTogglesValidateItemSchema',
             },
+            example: [],
         },
     },
     components: {

package/dist/lib/openapi/spec/import-toggles-validate-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"import-toggles-validate-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/import-toggles-validate-schema.ts"],"names":[],"mappings":";;;AACA,+FAAwF;AAE3E,QAAA,2BAA2B,GAAG;IACvC,GAAG,EAAE,kDAAkD;IACvD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;IAChC,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,MAAM,EAAE;YACJ,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,sDAAsD;aAC/D;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,sDAAsD;aAC/D;SACJ;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,sDAAsD;aAC/D;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,+BAA+B,EAA/B,qEAA+B;SAClC;KACJ;CACK,CAAC"}
+{"version":3,"file":"import-toggles-validate-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/import-toggles-validate-schema.ts"],"names":[],"mappings":";;;AACA,+FAAwF;AAE3E,QAAA,2BAA2B,GAAG;IACvC,GAAG,EAAE,kDAAkD;IACvD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;IAChC,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,kIAAkI;IACtI,UAAU,EAAE;QACR,MAAM,EAAE;YACJ,WAAW,EACP,mFAAmF;YACvF,IAAI,EAAE,OAAO;YACb,OAAO,EAAE;gBACL;oBACI,OAAO,EACH,+IAA+I;oBACnJ,aAAa,EAAE,CAAC,qCAAqC,CAAC;iBACzD;aACJ;YACD,KAAK,EAAE;gBACH,IAAI,EAAE,sDAAsD;aAC/D;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,kDAAkD;YAC/D,OAAO,EAAE;gBACL;oBACI,OAAO,EACH,6IAA6I;oBACjJ,aAAa,EAAE,CAAC,mBAAmB,CAAC;iBACvC;aACJ;YACD,KAAK,EAAE;gBACH,IAAI,EAAE,sDAAsD;aAC/D;SACJ;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,WAAW,EACP,wJAAwJ;YAC5J,KAAK,EAAE;gBACH,IAAI,EAAE,sDAAsD;aAC/D;YACD,OAAO,EAAE,EAAE;SACd;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,+BAA+B,EAA/B,qEAA+B;SAClC;KACJ;CACK,CAAC"}

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

@@ -8,6 +8,7 @@ export * from './pats-schema';
 export * from './role-schema';
 export * from './tags-schema';
 export * from './user-schema';
+export * from './create-user-response-schema';
 export * from './addon-schema';
 export * from './addon-create-update-schema';
 export * from './email-schema';
@@ -20,7 +21,8 @@ export * from './users-schema';
 export * from './addons-schema';
 export * from './events-schema';
 export * from './groups-schema';
-export * from './splash-schema';
+export * from './splash-request-schema';
+export * from './splash-response-schema';
 export * from './feature-schema';
 export * from './patches-schema';
 export * from './profile-schema';
@@ -30,7 +32,9 @@ export * from './variant-schema';
 export * from './variant-flag-schema';
 export * from './version-schema';
 export * from './features-schema';
-export * from './feedback-schema';
+export * from './feedback-create-schema';
+export * from './feedback-update-schema';
+export * from './feedback-response-schema';
 export * from './override-schema';
 export * from './password-schema';
 export * from './projects-schema';
@@ -84,7 +88,8 @@ export * from './client-features-schema';
 export * from './feature-metrics-schema';
 export * from './health-overview-schema';
 export * from './update-tag-type-schema';
-export * from './upsert-strategy-schema';
+export * from './create-strategy-schema';
+export * from './update-strategy-schema';
 export * from './create-api-token-schema';
 export * from './export-query-parameters';
 export * from './feature-strategy-schema';
@@ -95,6 +100,7 @@ export * from './update-api-token-schema';
 export * from './users-groups-base-schema';
 export * from './validate-password-schema';
 export * from './validate-tag-type-schema';
+export * from './validate-feature-schema';
 export * from './client-application-schema';
 export * from './playground-feature-schema';
 export * from './playground-request-schema';
@@ -140,3 +146,9 @@ export * from './admin-count-schema';
 export * from './advanced-playground-feature-schema';
 export * from './advanced-playground-response-schema';
 export * from './advanced-playground-request-schema';
+export * from './telemetry-settings-schema';
+export * from './create-strategy-variant-schema';
+export * from './strategy-variant-schema';
+export * from './client-segment-schema';
+export * from './update-feature-type-lifetime-schema';
+export * from './create-group-schema';

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

@@ -24,6 +24,7 @@ __exportStar(require("./pats-schema"), exports);
 __exportStar(require("./role-schema"), exports);
 __exportStar(require("./tags-schema"), exports);
 __exportStar(require("./user-schema"), exports);
+__exportStar(require("./create-user-response-schema"), exports);
 __exportStar(require("./addon-schema"), exports);
 __exportStar(require("./addon-create-update-schema"), exports);
 __exportStar(require("./email-schema"), exports);
@@ -36,7 +37,8 @@ __exportStar(require("./users-schema"), exports);
 __exportStar(require("./addons-schema"), exports);
 __exportStar(require("./events-schema"), exports);
 __exportStar(require("./groups-schema"), exports);
-__exportStar(require("./splash-schema"), exports);
+__exportStar(require("./splash-request-schema"), exports);
+__exportStar(require("./splash-response-schema"), exports);
 __exportStar(require("./feature-schema"), exports);
 __exportStar(require("./patches-schema"), exports);
 __exportStar(require("./profile-schema"), exports);
@@ -46,7 +48,9 @@ __exportStar(require("./variant-schema"), exports);
 __exportStar(require("./variant-flag-schema"), exports);
 __exportStar(require("./version-schema"), exports);
 __exportStar(require("./features-schema"), exports);
-__exportStar(require("./feedback-schema"), exports);
+__exportStar(require("./feedback-create-schema"), exports);
+__exportStar(require("./feedback-update-schema"), exports);
+__exportStar(require("./feedback-response-schema"), exports);
 __exportStar(require("./override-schema"), exports);
 __exportStar(require("./password-schema"), exports);
 __exportStar(require("./projects-schema"), exports);
@@ -100,7 +104,8 @@ __exportStar(require("./client-features-schema"), exports);
 __exportStar(require("./feature-metrics-schema"), exports);
 __exportStar(require("./health-overview-schema"), exports);
 __exportStar(require("./update-tag-type-schema"), exports);
-__exportStar(require("./upsert-strategy-schema"), exports);
+__exportStar(require("./create-strategy-schema"), exports);
+__exportStar(require("./update-strategy-schema"), exports);
 __exportStar(require("./create-api-token-schema"), exports);
 __exportStar(require("./export-query-parameters"), exports);
 __exportStar(require("./feature-strategy-schema"), exports);
@@ -111,6 +116,7 @@ __exportStar(require("./update-api-token-schema"), exports);
 __exportStar(require("./users-groups-base-schema"), exports);
 __exportStar(require("./validate-password-schema"), exports);
 __exportStar(require("./validate-tag-type-schema"), exports);
+__exportStar(require("./validate-feature-schema"), exports);
 __exportStar(require("./client-application-schema"), exports);
 __exportStar(require("./playground-feature-schema"), exports);
 __exportStar(require("./playground-request-schema"), exports);
@@ -156,4 +162,10 @@ __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);
+__exportStar(require("./telemetry-settings-schema"), exports);
+__exportStar(require("./create-strategy-variant-schema"), exports);
+__exportStar(require("./strategy-variant-schema"), exports);
+__exportStar(require("./client-segment-schema"), exports);
+__exportStar(require("./update-feature-type-lifetime-schema"), exports);
+__exportStar(require("./create-group-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;AACrC,uEAAqD;AACrD,wEAAsD;AACtD,uEAAqD"}
+{"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,gEAA8C;AAC9C,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,0DAAwC;AACxC,2DAAyC;AACzC,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,mDAAiC;AACjC,wDAAsC;AACtC,mDAAiC;AACjC,oDAAkC;AAClC,2DAAyC;AACzC,2DAAyC;AACzC,6DAA2C;AAC3C,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,2DAAyC;AACzC,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,4DAA0C;AAC1C,6DAA2C;AAC3C,6DAA2C;AAC3C,6DAA2C;AAC3C,4DAA0C;AAC1C,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;AACrD,8DAA4C;AAC5C,mEAAiD;AACjD,4DAA0C;AAC1C,0DAAwC;AACxC,wEAAsD;AACtD,wDAAsC"}

package/dist/lib/openapi/spec/legal-value-schema.d.ts

@@ -3,13 +3,18 @@ export declare const legalValueSchema: {
     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/legal-value-schema.js

@@ -5,13 +5,18 @@ exports.legalValueSchema = {
     $id: '#/components/schemas/legalValueSchema',
     type: 'object',
     additionalProperties: false,
+    description: 'Describes a legal value. Typically used to limit possible values for contextFields or strategy properties',
     required: ['value'],
     properties: {
         value: {
+            description: 'The valid value',
             type: 'string',
+            example: '#c154c1',
         },
         description: {
+            description: 'Describes this specific legal value',
             type: 'string',
+            example: 'Deep fuchsia',
         },
     },
     components: {},

package/dist/lib/openapi/spec/legal-value-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"legal-value-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/legal-value-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,gBAAgB,GAAG;IAC5B,GAAG,EAAE,uCAAuC;IAC5C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,OAAO,CAAC;IACnB,UAAU,EAAE;QACR,KAAK,EAAE;YACH,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"legal-value-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/legal-value-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,gBAAgB,GAAG;IAC5B,GAAG,EAAE,uCAAuC;IAC5C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,2GAA2G;IAC/G,QAAQ,EAAE,CAAC,OAAO,CAAC;IACnB,UAAU,EAAE;QACR,KAAK,EAAE;YACH,WAAW,EAAE,iBAAiB;YAC9B,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,SAAS;SACrB;QACD,WAAW,EAAE;YACT,WAAW,EAAE,qCAAqC;YAClD,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,cAAc;SAC1B;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -4,12 +4,17 @@ export declare const loginSchema: {
     readonly type: "object";
     readonly additionalProperties: false;
     readonly required: readonly ["username", "password"];
+    readonly description: "A username/password login request";
     readonly properties: {
         readonly username: {
+            readonly description: "The username trying to log in";
             readonly type: "string";
+            readonly example: "user";
         };
         readonly password: {
+            readonly description: "The password of the user trying to log in";
             readonly type: "string";
+            readonly example: "hunter2";
         };
     };
     readonly components: {};

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

@@ -6,12 +6,17 @@ exports.loginSchema = {
     type: 'object',
     additionalProperties: false,
     required: ['username', 'password'],
+    description: 'A username/password login request',
     properties: {
         username: {
+            description: 'The username trying to log in',
             type: 'string',
+            example: 'user',
         },
         password: {
+            description: 'The password of the user trying to log in',
             type: 'string',
+            example: 'hunter2',
         },
     },
     components: {},

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

@@ -1 +1 @@
-{"version":3,"file":"login-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/login-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,WAAW,GAAG;IACvB,GAAG,EAAE,kCAAkC;IACvC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;IAClC,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"login-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/login-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,WAAW,GAAG;IACvB,GAAG,EAAE,kCAAkC;IACvC,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;IAClC,WAAW,EAAE,mCAAmC;IAChD,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,WAAW,EAAE,+BAA+B;YAC5C,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,MAAM;SAClB;QACD,QAAQ,EAAE;YACN,WAAW,EAAE,2CAA2C;YACxD,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,SAAS;SACrB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -4,23 +4,27 @@ export declare const meSchema: {
     readonly type: "object";
     readonly additionalProperties: false;
     readonly required: readonly ["user", "permissions", "feedback", "splash"];
+    readonly description: "Detailed user information";
     readonly properties: {
         readonly user: {
             readonly $ref: "#/components/schemas/userSchema";
         };
         readonly permissions: {
+            readonly description: "User permissions for projects and environments";
             readonly type: "array";
             readonly items: {
                 readonly $ref: "#/components/schemas/permissionSchema";
             };
         };
         readonly feedback: {
+            readonly description: "User feedback information";
             readonly type: "array";
             readonly items: {
-                readonly $ref: "#/components/schemas/feedbackSchema";
+                readonly $ref: "#/components/schemas/feedbackResponseSchema";
             };
         };
         readonly splash: {
+            readonly description: "Splash screen configuration";
             readonly type: "object";
             readonly additionalProperties: {
                 readonly type: "boolean";
@@ -33,50 +37,88 @@ export declare const meSchema: {
                 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: {};
@@ -86,37 +128,53 @@ export declare const meSchema: {
                 readonly type: "object";
                 readonly additionalProperties: false;
                 readonly required: readonly ["permission"];
+                readonly description: "Project and environment permissions";
                 readonly properties: {
                     readonly permission: {
+                        readonly description: "[Project](https://docs.getunleash.io/reference/rbac#project-permissions) or [environment](https://docs.getunleash.io/reference/rbac#environment-permissions) permission name";
                         readonly type: "string";
+                        readonly example: "UPDATE_FEATURE_STRATEGY";
                     };
                     readonly project: {
+                        readonly description: "The project this permission applies to";
                         readonly type: "string";
+                        readonly example: "my-project";
                     };
                     readonly environment: {
+                        readonly description: "The environment this permission applies to";
                         readonly type: "string";
+                        readonly example: "development";
                     };
                 };
                 readonly components: {};
             };
-            readonly feedbackSchema: {
-                readonly $id: "#/components/schemas/feedbackSchema";
-                readonly type: "object";
+            readonly feedbackResponseSchema: {
+                readonly $id: "#/components/schemas/feedbackResponseSchema";
                 readonly additionalProperties: false;
+                readonly type: "object";
+                readonly description: "User feedback information about a particular feedback item.";
                 readonly properties: {
                     readonly userId: {
-                        readonly type: "number";
-                    };
-                    readonly feedbackId: {
-                        readonly type: "string";
+                        readonly description: "The ID of the user that gave the feedback.";
+                        readonly type: "integer";
+                        readonly example: 2;
                     };
                     readonly neverShow: {
+                        readonly description: "`true` if the user has asked never to see this feedback questionnaire again.";
                         readonly type: "boolean";
+                        readonly example: false;
                     };
                     readonly given: {
+                        readonly description: "When this feedback was given";
                         readonly type: "string";
                         readonly format: "date-time";
                         readonly nullable: true;
+                        readonly example: "2023-07-06T08:29:21.282Z";
+                    };
+                    readonly feedbackId: {
+                        readonly description: "The name of the feedback session";
+                        readonly type: "string";
+                        readonly example: "pnps";
                     };
                 };
                 readonly components: {};

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

@@ -3,29 +3,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.meSchema = void 0;
 const user_schema_1 = require("./user-schema");
 const permission_schema_1 = require("./permission-schema");
-const feedback_schema_1 = require("./feedback-schema");
+const feedback_response_schema_1 = require("./feedback-response-schema");
 exports.meSchema = {
     $id: '#/components/schemas/meSchema',
     type: 'object',
     additionalProperties: false,
     required: ['user', 'permissions', 'feedback', 'splash'],
+    description: 'Detailed user information',
     properties: {
         user: {
             $ref: '#/components/schemas/userSchema',
         },
         permissions: {
+            description: 'User permissions for projects and environments',
             type: 'array',
             items: {
                 $ref: '#/components/schemas/permissionSchema',
             },
         },
         feedback: {
+            description: 'User feedback information',
             type: 'array',
             items: {
-                $ref: '#/components/schemas/feedbackSchema',
+                $ref: '#/components/schemas/feedbackResponseSchema',
             },
         },
         splash: {
+            description: 'Splash screen configuration',
             type: 'object',
             additionalProperties: {
                 type: 'boolean',
@@ -36,7 +40,7 @@ exports.meSchema = {
         schemas: {
             userSchema: user_schema_1.userSchema,
             permissionSchema: permission_schema_1.permissionSchema,
-            feedbackSchema: feedback_schema_1.feedbackSchema,
+            feedbackResponseSchema: feedback_response_schema_1.feedbackResponseSchema,
         },
     },
 };