unleash-server 5.1.8 → 5.2.0

package/dist/lib/openapi/spec/advanced-playground-response-schema.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.advancedPlaygroundResponseSchema = void 0;
+const sdk_context_schema_1 = require("./sdk-context-schema");
+const constraint_schema_1 = require("./constraint-schema");
+const parameters_schema_1 = require("./parameters-schema");
+const variant_schema_1 = require("./variant-schema");
+const override_schema_1 = require("./override-schema");
+const playground_constraint_schema_1 = require("./playground-constraint-schema");
+const playground_segment_schema_1 = require("./playground-segment-schema");
+const playground_strategy_schema_1 = require("./playground-strategy-schema");
+const advanced_playground_request_schema_1 = require("./advanced-playground-request-schema");
+const advanced_playground_feature_schema_1 = require("./advanced-playground-feature-schema");
+const advanced_playground_environment_feature_schema_1 = require("./advanced-playground-environment-feature-schema");
+exports.advancedPlaygroundResponseSchema = {
+    $id: '#/components/schemas/advancedPlaygroundResponseSchema',
+    description: 'The state of all features given the provided input.',
+    type: 'object',
+    additionalProperties: false,
+    required: ['features', 'input'],
+    properties: {
+        input: {
+            description: 'The given input used to evaluate the features.',
+            $ref: advanced_playground_request_schema_1.advancedPlaygroundRequestSchema.$id,
+        },
+        features: {
+            type: 'array',
+            description: 'The list of features that have been evaluated.',
+            items: {
+                $ref: advanced_playground_feature_schema_1.advancedPlaygroundFeatureSchema.$id,
+            },
+        },
+    },
+    components: {
+        schemas: {
+            constraintSchema: constraint_schema_1.constraintSchema,
+            parametersSchema: parameters_schema_1.parametersSchema,
+            playgroundConstraintSchema: playground_constraint_schema_1.playgroundConstraintSchema,
+            advancedPlaygroundFeatureSchema: advanced_playground_feature_schema_1.advancedPlaygroundFeatureSchema,
+            advancedPlaygroundEnvironmentFeatureSchema: advanced_playground_environment_feature_schema_1.advancedPlaygroundEnvironmentFeatureSchema,
+            advancedPlaygroundRequestSchema: advanced_playground_request_schema_1.advancedPlaygroundRequestSchema,
+            playgroundSegmentSchema: playground_segment_schema_1.playgroundSegmentSchema,
+            playgroundStrategySchema: playground_strategy_schema_1.playgroundStrategySchema,
+            sdkContextSchema: sdk_context_schema_1.sdkContextSchema,
+            variantSchema: variant_schema_1.variantSchema,
+            overrideSchema: override_schema_1.overrideSchema,
+        },
+    },
+};
+//# sourceMappingURL=advanced-playground-response-schema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"advanced-playground-response-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/advanced-playground-response-schema.ts"],"names":[],"mappings":";;;AACA,6DAAwD;AACxD,2DAAuD;AACvD,2DAAuD;AACvD,qDAAiD;AACjD,uDAAmD;AACnD,iFAA4E;AAC5E,2EAAsE;AACtE,6EAAwE;AACxE,6FAAuF;AACvF,6FAAuF;AACvF,qHAA8G;AAEjG,QAAA,gCAAgC,GAAG;IAC5C,GAAG,EAAE,uDAAuD;IAC5D,WAAW,EAAE,qDAAqD;IAClE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC;IAC/B,UAAU,EAAE;QACR,KAAK,EAAE;YACH,WAAW,EAAE,gDAAgD;YAC7D,IAAI,EAAE,oEAA+B,CAAC,GAAG;SAC5C;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,gDAAgD;YAC7D,KAAK,EAAE;gBACH,IAAI,EAAE,oEAA+B,CAAC,GAAG;aAC5C;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;YAChB,0BAA0B,EAA1B,yDAA0B;YAC1B,+BAA+B,EAA/B,oEAA+B;YAC/B,0CAA0C,EAA1C,2FAA0C;YAC1C,+BAA+B,EAA/B,oEAA+B;YAC/B,uBAAuB,EAAvB,mDAAuB;YACvB,wBAAwB,EAAxB,qDAAwB;YACxB,gBAAgB,EAAhB,qCAAgB;YAChB,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;SACjB;KACJ;CACK,CAAC"}

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

@@ -3,35 +3,52 @@ export declare const clientApplicationSchema: {
     readonly $id: "#/components/schemas/clientApplicationSchema";
     readonly type: "object";
     readonly required: readonly ["appName", "interval", "started", "strategies"];
+    readonly description: "A client application is an instance of one of our SDKs";
     readonly properties: {
         readonly appName: {
+            readonly description: "An identifier for the app that uses the sdk, should be static across SDK restarts";
             readonly type: "string";
+            readonly example: "example-app";
         };
         readonly instanceId: {
+            readonly description: "A unique identifier identifying the instance of the application running the SDK. Often changes based on execution environment. For instance: two pods in Kubernetes will have two different instanceIds";
             readonly type: "string";
+            readonly example: "b77f3d13-5f48-4a7b-a3f4-a449b97ce43a";
         };
         readonly sdkVersion: {
             readonly type: "string";
+            readonly description: "An SDK version identifier. Usually formatted as \"unleash-client-<language>:<version>\"";
+            readonly example: "unleash-client-java:7.0.0";
         };
         readonly environment: {
+            readonly description: "The SDK's configured 'environment' property. Deprecated. This property  does **not** control which Unleash environment the SDK gets toggles for. To control Unleash environments, use the SDKs API key.";
+            readonly deprecated: true;
             readonly type: "string";
+            readonly example: "development";
         };
         readonly interval: {
             readonly type: "number";
+            readonly description: "How often (in seconds) does the client refresh its toggles";
+            readonly example: 10;
+            readonly minimum: 0;
         };
         readonly started: {
+            readonly description: "Either an RFC-3339 timestamp or a unix timestamp in seconds";
             readonly oneOf: readonly [{
                 readonly type: "string";
                 readonly format: "date-time";
             }, {
                 readonly type: "number";
             }];
+            readonly example: "2023-06-13T16:35:00.000Z";
         };
         readonly strategies: {
+            readonly description: "Which strategies the SDKs runtime knows about";
             readonly type: "array";
             readonly items: {
                 readonly type: "string";
             };
+            readonly example: readonly ["default", "gradualRollout", "remoteAddress"];
         };
     };
     readonly components: {};

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

@@ -5,33 +5,50 @@ exports.clientApplicationSchema = {
     $id: '#/components/schemas/clientApplicationSchema',
     type: 'object',
     required: ['appName', 'interval', 'started', 'strategies'],
+    description: 'A client application is an instance of one of our SDKs',
     properties: {
         appName: {
+            description: 'An identifier for the app that uses the sdk, should be static across SDK restarts',
             type: 'string',
+            example: 'example-app',
         },
         instanceId: {
+            description: 'A unique identifier identifying the instance of the application running the SDK. Often changes based on execution environment. For instance: two pods in Kubernetes will have two different instanceIds',
             type: 'string',
+            example: 'b77f3d13-5f48-4a7b-a3f4-a449b97ce43a',
         },
         sdkVersion: {
             type: 'string',
+            description: 'An SDK version identifier. Usually formatted as "unleash-client-<language>:<version>"',
+            example: 'unleash-client-java:7.0.0',
         },
         environment: {
+            description: `The SDK's configured 'environment' property. Deprecated. This property  does **not** control which Unleash environment the SDK gets toggles for. To control Unleash environments, use the SDKs API key.`,
+            deprecated: true,
             type: 'string',
+            example: 'development',
         },
         interval: {
             type: 'number',
+            description: 'How often (in seconds) does the client refresh its toggles',
+            example: 10,
+            minimum: 0,
         },
         started: {
+            description: 'Either an RFC-3339 timestamp or a unix timestamp in seconds',
             oneOf: [
                 { type: 'string', format: 'date-time' },
                 { type: 'number' },
             ],
+            example: '2023-06-13T16:35:00.000Z',
         },
         strategies: {
+            description: 'Which strategies the SDKs runtime knows about',
             type: 'array',
             items: {
                 type: 'string',
             },
+            example: ['default', 'gradualRollout', 'remoteAddress'],
         },
     },
     components: {},

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

@@ -1 +1 @@
-{"version":3,"file":"client-application-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/client-application-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,uBAAuB,GAAG;IACnC,GAAG,EAAE,8CAA8C;IACnD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC;IAC1D,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;SACjB;QACD,OAAO,EAAE;YACL,KAAK,EAAE;gBACH,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE;gBACvC,EAAE,IAAI,EAAE,QAAQ,EAAE;aACrB;SACJ;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"client-application-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/client-application-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,uBAAuB,GAAG;IACnC,GAAG,EAAE,8CAA8C;IACnD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC;IAC1D,WAAW,EAAE,wDAAwD;IACrE,UAAU,EAAE;QACR,OAAO,EAAE;YACL,WAAW,EACP,mFAAmF;YACvF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;SACzB;QACD,UAAU,EAAE;YACR,WAAW,EACP,yMAAyM;YAC7M,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,sCAAsC;SAClD;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,uFAAuF;YAC3F,OAAO,EAAE,2BAA2B;SACvC;QACD,WAAW,EAAE;YACT,WAAW,EAAE,yMAAyM;YACtN,UAAU,EAAE,IAAI;YAChB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;SACzB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,4DAA4D;YAChE,OAAO,EAAE,EAAE;YACX,OAAO,EAAE,CAAC;SACb;QACD,OAAO,EAAE;YACL,WAAW,EACP,6DAA6D;YACjE,KAAK,EAAE;gBACH,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE;gBACvC,EAAE,IAAI,EAAE,QAAQ,EAAE;aACrB;YACD,OAAO,EAAE,0BAA0B;SACtC;QACD,UAAU,EAAE;YACR,WAAW,EAAE,+CAA+C;YAC5D,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;YACD,OAAO,EAAE,CAAC,SAAS,EAAE,gBAAgB,EAAE,eAAe,CAAC;SAC1D;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

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

@@ -3,55 +3,60 @@ export declare const clientFeatureSchema: {
     readonly $id: "#/components/schemas/clientFeatureSchema";
     readonly type: "object";
     readonly required: readonly ["name", "enabled"];
+    readonly description: "Feature toggle configuration used by SDKs to evaluate state of a toggle";
     readonly additionalProperties: false;
     readonly properties: {
         readonly name: {
             readonly type: "string";
+            readonly description: "The unique name of a feature toggle. Is validated to be URL safe on creation";
+            readonly example: "new.payment.flow.stripe";
         };
         readonly type: {
             readonly type: "string";
+            readonly description: "What kind of feature flag is this. Refer to the documentation on [feature toggle types](https://docs.getunleash.io/reference/feature-toggle-types) for more information";
+            readonly example: "release";
         };
         readonly description: {
             readonly type: "string";
+            readonly description: "A description of the toggle";
             readonly nullable: true;
-        };
-        readonly createdAt: {
-            readonly type: "string";
-            readonly format: "date-time";
-            readonly nullable: true;
-        };
-        readonly lastSeenAt: {
-            readonly type: "string";
-            readonly format: "date-time";
-            readonly nullable: true;
+            readonly example: "No variants here";
         };
         readonly enabled: {
             readonly type: "boolean";
+            readonly description: "Whether the feature flag is enabled for the current API key or not. This is ANDed with the evaluation results of the strategies list, so if this is false, the evaluation result will always be false";
+            readonly example: true;
         };
         readonly stale: {
+            readonly description: "If this is true Unleash believes this feature toggle has been active longer than Unleash expects a toggle of this type to be active";
             readonly type: "boolean";
+            readonly example: false;
         };
         readonly impressionData: {
+            readonly description: "Set to true if SDKs should trigger [impression events](https://docs.getunleash.io/reference/impression-data) when this toggle is evaluated";
             readonly type: "boolean";
             readonly nullable: true;
+            readonly example: false;
         };
         readonly project: {
+            readonly description: "Which project this feature toggle belongs to";
             readonly type: "string";
+            readonly example: "new.payment.flow";
         };
         readonly strategies: {
             readonly type: "array";
+            readonly description: "Evaluation strategies for this toggle. Each entry in this list will be evaluated and ORed together";
             readonly items: {
                 readonly $ref: "#/components/schemas/featureStrategySchema";
             };
-            readonly deprecated: true;
         };
         readonly variants: {
             readonly type: "array";
+            readonly description: "[Variants](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) configured for this toggle";
             readonly items: {
                 readonly $ref: "#/components/schemas/variantSchema";
             };
             readonly nullable: true;
-            readonly deprecated: true;
         };
     };
     readonly components: {
@@ -110,7 +115,7 @@ export declare const clientFeatureSchema: {
             };
             readonly featureStrategySchema: {
                 readonly $id: "#/components/schemas/featureStrategySchema";
-                readonly description: "A singles activation strategy configuration schema for a feature";
+                readonly description: "A single activation strategy configuration schema for a feature";
                 readonly type: "object";
                 readonly additionalProperties: false;
                 readonly required: readonly ["name"];
@@ -227,23 +232,34 @@ export declare const clientFeatureSchema: {
                 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";
@@ -252,8 +268,13 @@ export declare const clientFeatureSchema: {
                                 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";
@@ -267,15 +288,20 @@ export declare const clientFeatureSchema: {
                             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: {};
@@ -288,15 +314,20 @@ export declare const clientFeatureSchema: {
                 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/client-feature-schema.js

@@ -10,55 +10,60 @@ exports.clientFeatureSchema = {
     $id: '#/components/schemas/clientFeatureSchema',
     type: 'object',
     required: ['name', 'enabled'],
+    description: 'Feature toggle configuration used by SDKs to evaluate state of a toggle',
     additionalProperties: false,
     properties: {
         name: {
             type: 'string',
+            description: 'The unique name of a feature toggle. Is validated to be URL safe on creation',
+            example: 'new.payment.flow.stripe',
         },
         type: {
             type: 'string',
+            description: 'What kind of feature flag is this. Refer to the documentation on [feature toggle types](https://docs.getunleash.io/reference/feature-toggle-types) for more information',
+            example: 'release',
         },
         description: {
             type: 'string',
+            description: 'A description of the toggle',
             nullable: true,
-        },
-        createdAt: {
-            type: 'string',
-            format: 'date-time',
-            nullable: true,
-        },
-        lastSeenAt: {
-            type: 'string',
-            format: 'date-time',
-            nullable: true,
+            example: 'No variants here',
         },
         enabled: {
             type: 'boolean',
+            description: 'Whether the feature flag is enabled for the current API key or not. This is ANDed with the evaluation results of the strategies list, so if this is false, the evaluation result will always be false',
+            example: true,
         },
         stale: {
+            description: 'If this is true Unleash believes this feature toggle has been active longer than Unleash expects a toggle of this type to be active',
             type: 'boolean',
+            example: false,
         },
         impressionData: {
+            description: 'Set to true if SDKs should trigger [impression events](https://docs.getunleash.io/reference/impression-data) when this toggle is evaluated',
             type: 'boolean',
             nullable: true,
+            example: false,
         },
         project: {
+            description: 'Which project this feature toggle belongs to',
             type: 'string',
+            example: 'new.payment.flow',
         },
         strategies: {
             type: 'array',
+            description: 'Evaluation strategies for this toggle. Each entry in this list will be evaluated and ORed together',
             items: {
                 $ref: '#/components/schemas/featureStrategySchema',
             },
-            deprecated: true,
         },
         variants: {
             type: 'array',
+            description: '[Variants](https://docs.getunleash.io/reference/feature-toggle-variants#what-are-variants) configured for this toggle',
             items: {
                 $ref: '#/components/schemas/variantSchema',
             },
             nullable: true,
-            deprecated: true,
         },
     },
     components: {

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

@@ -1 +1 @@
-{"version":3,"file":"client-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/client-feature-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,2DAAuD;AACvD,uEAAkE;AAClE,qDAAiD;AACjD,uDAAmD;AAEtC,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;IAC7B,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;SACjB;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,MAAM,EAAE,WAAW;YACnB,QAAQ,EAAE,IAAI;SACjB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;SAClB;QACD,KAAK,EAAE;YACH,IAAI,EAAE,SAAS;SAClB;QACD,cAAc,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,IAAI;SACjB;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,4CAA4C;aACrD;YACD,UAAU,EAAE,IAAI;SACnB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;YACD,QAAQ,EAAE,IAAI;YACd,UAAU,EAAE,IAAI;SACnB;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;YAChB,qBAAqB,EAArB,+CAAqB;YACrB,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;SACjB;KACJ;CACK,CAAC"}
+{"version":3,"file":"client-feature-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/client-feature-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,2DAAuD;AACvD,uEAAkE;AAClE,qDAAiD;AACjD,uDAAmD;AAEtC,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;IAC7B,WAAW,EACP,yEAAyE;IAC7E,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,8EAA8E;YAClF,OAAO,EAAE,yBAAyB;SACrC;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,yKAAyK;YAC7K,OAAO,EAAE,SAAS;SACrB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,6BAA6B;YAC1C,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,kBAAkB;SAC9B;QACD,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,WAAW,EACP,uMAAuM;YAC3M,OAAO,EAAE,IAAI;SAChB;QACD,KAAK,EAAE;YACH,WAAW,EACP,qIAAqI;YACzI,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;SACjB;QACD,cAAc,EAAE;YACZ,WAAW,EACP,4IAA4I;YAChJ,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,KAAK;SACjB;QACD,OAAO,EAAE;YACL,WAAW,EAAE,8CAA8C;YAC3D,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,kBAAkB;SAC9B;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,WAAW,EACP,oGAAoG;YACxG,KAAK,EAAE;gBACH,IAAI,EAAE,4CAA4C;aACrD;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EACP,uHAAuH;YAC3H,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;YACD,QAAQ,EAAE,IAAI;SACjB;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;YAChB,qBAAqB,EAArB,+CAAqB;YACrB,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;SACjB;KACJ;CACK,CAAC"}

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

@@ -3,30 +3,42 @@ export declare const clientFeaturesQuerySchema: {
     readonly $id: "#/components/schemas/clientFeaturesQuerySchema";
     readonly type: "object";
     readonly additionalProperties: false;
+    readonly description: "Query parameters active for a client features request";
     readonly properties: {
         readonly tag: {
             readonly type: "array";
+            readonly description: "Features tagged with one of these tags are included";
             readonly items: {
                 readonly type: "array";
                 readonly items: {
                     readonly type: "string";
                 };
             };
+            readonly example: readonly [readonly ["simple:payment", "simple:stripejourney"]];
         };
         readonly project: {
             readonly type: "array";
             readonly items: {
                 readonly type: "string";
             };
+            readonly description: "Features that are part of these projects are included in this response. (DEPRECATED) - Handled by API tokens";
+            readonly example: readonly ["new.payment.flow"];
+            readonly deprecated: true;
         };
         readonly namePrefix: {
+            readonly description: "Features are filtered to only include features whose name starts with this prefix";
             readonly type: "string";
+            readonly example: "payment";
         };
         readonly environment: {
             readonly type: "string";
+            readonly description: "Strategies for the feature toggle configured for this environment are included. (DEPRECATED) - Handled by API tokens";
+            readonly deprecated: true;
         };
         readonly inlineSegmentConstraints: {
+            readonly description: "Set to true if requesting client does not support Unleash-Client-Specification 4.2.2 or newer. Modern SDKs will have this set to false, since they will be able to merge constraints and segments themselves";
             readonly type: "boolean";
+            readonly example: true;
         };
     };
     readonly components: {};

package/dist/lib/openapi/spec/client-features-query-schema.js

@@ -5,30 +5,42 @@ exports.clientFeaturesQuerySchema = {
     $id: '#/components/schemas/clientFeaturesQuerySchema',
     type: 'object',
     additionalProperties: false,
+    description: 'Query parameters active for a client features request',
     properties: {
         tag: {
             type: 'array',
+            description: 'Features tagged with one of these tags are included',
             items: {
                 type: 'array',
                 items: {
                     type: 'string',
                 },
             },
+            example: [['simple:payment', 'simple:stripejourney']],
         },
         project: {
             type: 'array',
             items: {
                 type: 'string',
             },
+            description: 'Features that are part of these projects are included in this response. (DEPRECATED) - Handled by API tokens',
+            example: ['new.payment.flow'],
+            deprecated: true,
         },
         namePrefix: {
+            description: 'Features are filtered to only include features whose name starts with this prefix',
             type: 'string',
+            example: 'payment',
         },
         environment: {
             type: 'string',
+            description: 'Strategies for the feature toggle configured for this environment are included. (DEPRECATED) - Handled by API tokens',
+            deprecated: true,
         },
         inlineSegmentConstraints: {
+            description: 'Set to true if requesting client does not support Unleash-Client-Specification 4.2.2 or newer. Modern SDKs will have this set to false, since they will be able to merge constraints and segments themselves',
             type: 'boolean',
+            example: true,
         },
     },
     components: {},

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

@@ -1 +1 @@
-{"version":3,"file":"client-features-query-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/client-features-query-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,yBAAyB,GAAG;IACrC,GAAG,EAAE,gDAAgD;IACrD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACR,GAAG,EAAE;YACD,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,QAAQ;iBACjB;aACJ;SACJ;QACD,OAAO,EAAE;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;SACJ;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,wBAAwB,EAAE;YACtB,IAAI,EAAE,SAAS;SAClB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"client-features-query-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/client-features-query-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,yBAAyB,GAAG;IACrC,GAAG,EAAE,gDAAgD;IACrD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EAAE,uDAAuD;IACpE,UAAU,EAAE;QACR,GAAG,EAAE;YACD,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,qDAAqD;YAClE,KAAK,EAAE;gBACH,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE;oBACH,IAAI,EAAE,QAAQ;iBACjB;aACJ;YACD,OAAO,EAAE,CAAC,CAAC,gBAAgB,EAAE,sBAAsB,CAAC,CAAC;SACxD;QACD,OAAO,EAAE;YACL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;aACjB;YACD,WAAW,EACP,8GAA8G;YAClH,OAAO,EAAE,CAAC,kBAAkB,CAAC;YAC7B,UAAU,EAAE,IAAI;SACnB;QACD,UAAU,EAAE;YACR,WAAW,EACP,mFAAmF;YACvF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,SAAS;SACrB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,sHAAsH;YAC1H,UAAU,EAAE,IAAI;SACnB;QACD,wBAAwB,EAAE;YACtB,WAAW,EACP,8MAA8M;YAClN,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;SAChB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}