unleash-server 5.1.8 → 5.2.0

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

@@ -3,23 +3,30 @@ export declare const clientFeaturesSchema: {
     readonly $id: "#/components/schemas/clientFeaturesSchema";
     readonly type: "object";
     readonly required: readonly ["version", "features"];
+    readonly description: "Configuration data for server-side SDKs for evaluating feature flags.";
     readonly properties: {
         readonly version: {
             readonly type: "number";
+            readonly description: "A version number for the format used in the response. Most Unleash instances now return version 2, which includes segments as a separate array";
+            readonly example: 2;
+            readonly minimum: 0;
         };
         readonly features: {
+            readonly description: "A list of feature toggles with their configuration";
             readonly type: "array";
             readonly items: {
                 readonly $ref: "#/components/schemas/clientFeatureSchema";
             };
         };
         readonly segments: {
+            readonly description: "A list of [Segments](https://docs.getunleash.io/reference/segments) configured for this Unleash instance";
             readonly type: "array";
             readonly items: {
                 readonly $ref: "#/components/schemas/segmentSchema";
             };
         };
         readonly query: {
+            readonly description: "A summary of filters and parameters sent to the endpoint. Used by the server to build the features and segments response";
             readonly $ref: "#/components/schemas/clientFeaturesQuerySchema";
         };
     };
@@ -73,55 +80,60 @@ export declare const clientFeaturesSchema: {
                 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: {
@@ -180,7 +192,7 @@ export declare const clientFeaturesSchema: {
                         };
                         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"];
@@ -297,23 +309,34 @@ export declare const clientFeaturesSchema: {
                             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";
@@ -322,8 +345,13 @@ export declare const clientFeaturesSchema: {
                                             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";
@@ -337,15 +365,20 @@ export declare const clientFeaturesSchema: {
                                         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: {};
@@ -358,15 +391,20 @@ export declare const clientFeaturesSchema: {
                             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: {};
@@ -513,30 +551,42 @@ export declare const clientFeaturesSchema: {
                 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: {};
@@ -546,15 +596,20 @@ export declare const clientFeaturesSchema: {
                 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: {};
@@ -569,7 +624,7 @@ export declare const clientFeaturesSchema: {
             };
             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"];
@@ -686,23 +741,34 @@ export declare const clientFeaturesSchema: {
                 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";
@@ -711,8 +777,13 @@ export declare const clientFeaturesSchema: {
                                 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";
@@ -726,15 +797,20 @@ export declare const clientFeaturesSchema: {
                             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-features-schema.js

@@ -14,23 +14,30 @@ exports.clientFeaturesSchema = {
     $id: '#/components/schemas/clientFeaturesSchema',
     type: 'object',
     required: ['version', 'features'],
+    description: 'Configuration data for server-side SDKs for evaluating feature flags.',
     properties: {
         version: {
             type: 'number',
+            description: 'A version number for the format used in the response. Most Unleash instances now return version 2, which includes segments as a separate array',
+            example: 2,
+            minimum: 0,
         },
         features: {
+            description: 'A list of feature toggles with their configuration',
             type: 'array',
             items: {
                 $ref: '#/components/schemas/clientFeatureSchema',
             },
         },
         segments: {
+            description: 'A list of [Segments](https://docs.getunleash.io/reference/segments) configured for this Unleash instance',
             type: 'array',
             items: {
                 $ref: '#/components/schemas/segmentSchema',
             },
         },
         query: {
+            description: 'A summary of filters and parameters sent to the endpoint. Used by the server to build the features and segments response',
             $ref: '#/components/schemas/clientFeaturesQuerySchema',
         },
     },

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

@@ -1 +1 @@
-{"version":3,"file":"client-features-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/client-features-schema.ts"],"names":[],"mappings":";;;AACA,iFAA2E;AAC3E,qDAAiD;AACjD,2DAAuD;AACvD,6DAAyD;AACzD,uDAAmD;AACnD,2DAAuD;AACvD,uEAAkE;AAClE,mEAA8D;AAC9D,qDAAiD;AAEpC,QAAA,oBAAoB,GAAG;IAChC,GAAG,EAAE,2CAA2C;IAChD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC;IACjC,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;SACjB;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,0CAA0C;aACnD;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;SACJ;QACD,KAAK,EAAE;YACH,IAAI,EAAE,gDAAgD;SACzD;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,mBAAmB,EAAnB,2CAAmB;YACnB,iBAAiB,EAAjB,sCAAiB;YACjB,aAAa,EAAb,8BAAa;YACb,yBAAyB,EAAzB,wDAAyB;YACzB,cAAc,EAAd,gCAAc;YACd,gBAAgB,EAAhB,oCAAgB;YAChB,qBAAqB,EAArB,+CAAqB;YACrB,aAAa,EAAb,8BAAa;SAChB;KACJ;CACK,CAAC"}
+{"version":3,"file":"client-features-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/client-features-schema.ts"],"names":[],"mappings":";;;AACA,iFAA2E;AAC3E,qDAAiD;AACjD,2DAAuD;AACvD,6DAAyD;AACzD,uDAAmD;AACnD,2DAAuD;AACvD,uEAAkE;AAClE,mEAA8D;AAC9D,qDAAiD;AAEpC,QAAA,oBAAoB,GAAG;IAChC,GAAG,EAAE,2CAA2C;IAChD,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,EAAE,UAAU,CAAC;IACjC,WAAW,EACP,uEAAuE;IAC3E,UAAU,EAAE;QACR,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,WAAW,EACP,gJAAgJ;YACpJ,OAAO,EAAE,CAAC;YACV,OAAO,EAAE,CAAC;SACb;QACD,QAAQ,EAAE;YACN,WAAW,EAAE,oDAAoD;YACjE,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,0CAA0C;aACnD;SACJ;QACD,QAAQ,EAAE;YACN,WAAW,EACP,0GAA0G;YAC9G,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;SACJ;QACD,KAAK,EAAE;YACH,WAAW,EACP,0HAA0H;YAC9H,IAAI,EAAE,gDAAgD;SACzD;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,mBAAmB,EAAnB,2CAAmB;YACnB,iBAAiB,EAAjB,sCAAiB;YACjB,aAAa,EAAb,8BAAa;YACb,yBAAyB,EAAzB,wDAAyB;YACzB,cAAc,EAAd,gCAAc;YACd,gBAAgB,EAAhB,oCAAgB;YAChB,qBAAqB,EAArB,+CAAqB;YACrB,aAAa,EAAb,8BAAa;SAChB;KACJ;CACK,CAAC"}

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

@@ -17,7 +17,7 @@ test('clientFeaturesSchema required fields', () => {
                     {
                         name: 'a',
                         weight: 1,
-                        weightType: 'b',
+                        weightType: 'fix',
                         stickiness: 'c',
                         payload: {
                             type: 'a',
@@ -43,7 +43,6 @@ test('clientFeaturesSchema java-sdk expected response', () => {
         {
           "id": 1,
           "name": "some-name",
-          "description": null,
           "constraints": [
             {
               "contextName": "some-name",
@@ -58,19 +57,16 @@ test('clientFeaturesSchema java-sdk expected response', () => {
       "features": [
         {
           "name": "Test.old",
-          "description": "No variants here!",
           "enabled": true,
           "strategies": [
             {
               "name": "default"
             }
           ],
-          "variants": null,
-          "createdAt": "2019-01-24T10:38:10.370Z"
+          "variants": null
         },
         {
           "name": "Test.variants",
-          "description": null,
           "enabled": true,
           "strategies": [
             {
@@ -89,8 +85,7 @@ test('clientFeaturesSchema java-sdk expected response', () => {
               "name": "variant2",
               "weight": 50
             }
-          ],
-          "createdAt": "2019-01-24T10:41:45.236Z"
+          ]
         },
         {
           "name": "featureX",
@@ -164,8 +159,7 @@ test('clientFeaturesSchema unleash-proxy expected response', () => {
               "name": "default"
             }
           ],
-          "variants": null,
-          "createdAt": "2019-01-24T10:38:10.370Z"
+          "variants": null
         },
         {
           "name": "Test.variants",
@@ -188,8 +182,7 @@ test('clientFeaturesSchema unleash-proxy expected response', () => {
               "name": "variant2",
               "weight": 50
             }
-          ],
-          "createdAt": "2019-01-24T10:41:45.236Z"
+          ]
         },
         {
           "name": "featureX",

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

@@ -1 +1 @@
-{"version":3,"file":"client-features-schema.test.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/client-features-schema.test.ts"],"names":[],"mappings":";;AAAA,0CAA6C;AAG7C,IAAI,CAAC,gCAAgC,EAAE,GAAG,EAAE;IACxC,MAAM,CACF,IAAA,yBAAc,EAAC,2CAA2C,EAAE,EAAE,CAAC,CAClE,CAAC,eAAe,EAAE,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE;IAC9C,MAAM,IAAI,GAAyB;QAC/B,OAAO,EAAE,CAAC;QACV,KAAK,EAAE,EAAE;QACT,QAAQ,EAAE;YACN;gBACI,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,KAAK;gBACd,cAAc,EAAE,KAAK;gBACrB,QAAQ,EAAE;oBACN;wBACI,IAAI,EAAE,GAAG;wBACT,MAAM,EAAE,CAAC;wBACT,UAAU,EAAE,GAAG;wBACf,UAAU,EAAE,GAAG;wBACf,OAAO,EAAE;4BACL,IAAI,EAAE,GAAG;4BACT,KAAK,EAAE,GAAG;yBACb;wBACD,SAAS,EAAE;4BACP;gCACI,WAAW,EAAE,GAAG;gCAChB,MAAM,EAAE,CAAC,GAAG,CAAC;6BAChB;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EAAC,2CAA2C,EAAE,IAAI,CAAC,CACpE,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,iDAAiD,EAAE,GAAG,EAAE;IACzD,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA+FX,CAAC;IAEH,MAAM,CACF,IAAA,yBAAc,EACV,2CAA2C,EAC3C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CACnB,CACJ,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,sDAAsD,EAAE,GAAG,EAAE;IAC9D,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA+FX,CAAC;IAEH,MAAM,CACF,IAAA,yBAAc,EACV,2CAA2C,EAC3C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CACnB,CACJ,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;IAC3D,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA6JX,CAAC;IAEH,MAAM,CACF,IAAA,yBAAc,EACV,2CAA2C,EAC3C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CACnB,CACJ,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC"}
+{"version":3,"file":"client-features-schema.test.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/client-features-schema.test.ts"],"names":[],"mappings":";;AAAA,0CAA6C;AAG7C,IAAI,CAAC,gCAAgC,EAAE,GAAG,EAAE;IACxC,MAAM,CACF,IAAA,yBAAc,EAAC,2CAA2C,EAAE,EAAE,CAAC,CAClE,CAAC,eAAe,EAAE,CAAC;AACxB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE;IAC9C,MAAM,IAAI,GAAyB;QAC/B,OAAO,EAAE,CAAC;QACV,KAAK,EAAE,EAAE;QACT,QAAQ,EAAE;YACN;gBACI,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,KAAK;gBACd,cAAc,EAAE,KAAK;gBACrB,QAAQ,EAAE;oBACN;wBACI,IAAI,EAAE,GAAG;wBACT,MAAM,EAAE,CAAC;wBACT,UAAU,EAAE,KAAK;wBACjB,UAAU,EAAE,GAAG;wBACf,OAAO,EAAE;4BACL,IAAI,EAAE,GAAG;4BACT,KAAK,EAAE,GAAG;yBACb;wBACD,SAAS,EAAE;4BACP;gCACI,WAAW,EAAE,GAAG;gCAChB,MAAM,EAAE,CAAC,GAAG,CAAC;6BAChB;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EAAC,2CAA2C,EAAE,IAAI,CAAC,CACpE,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,iDAAiD,EAAE,GAAG,EAAE;IACzD,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA0FX,CAAC;IAEH,MAAM,CACF,IAAA,yBAAc,EACV,2CAA2C,EAC3C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CACnB,CACJ,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,sDAAsD,EAAE,GAAG,EAAE;IAC9D,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA6FX,CAAC;IAEH,MAAM,CACF,IAAA,yBAAc,EACV,2CAA2C,EAC3C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CACnB,CACJ,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,IAAI,CAAC,mDAAmD,EAAE,GAAG,EAAE;IAC3D,MAAM,IAAI,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA6JX,CAAC;IAEH,MAAM,CACF,IAAA,yBAAc,EACV,2CAA2C,EAC3C,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CACnB,CACJ,CAAC,aAAa,EAAE,CAAC;AACtB,CAAC,CAAC,CAAC"}

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

@@ -69,7 +69,7 @@ export declare const clientMetricsSchema: {
                                 readonly minimum: 0;
                             };
                             readonly variants: {
-                                readonly description: "How many times each variant was returned";
+                                readonly description: "An object describing how many times each variant was returned. Variant names are used as properties, and the number of times they were exposed is the corresponding value (i.e. `{ [variantName]: number }`).";
                                 readonly type: "object";
                                 readonly additionalProperties: {
                                     readonly type: "integer";

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

@@ -72,7 +72,7 @@ exports.clientMetricsSchema = {
                                 minimum: 0,
                             },
                             variants: {
-                                description: 'How many times each variant was returned',
+                                description: 'An object describing how many times each variant was returned. Variant names are used as properties, and the number of times they were exposed is the corresponding value (i.e. `{ [variantName]: number }`).',
                                 type: 'object',
                                 additionalProperties: {
                                     type: 'integer',

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

@@ -1 +1 @@
-{"version":3,"file":"client-metrics-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/client-metrics-schema.ts"],"names":[],"mappings":";;;AACA,+CAA2C;AAE9B,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;IAC/B,WAAW,EACP,yEAAyE;IAC7E,UAAU,EAAE;QACR,OAAO,EAAE;YACL,WAAW,EACP,wDAAwD;YAC5D,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,oBAAoB;SAChC;QACD,UAAU,EAAE;YACR,WAAW,EACP,qHAAqH;YACzH,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,2BAA2B;SACvC;QACD,WAAW,EAAE;YACT,WAAW,EAAE,iDAAiD;YAC9D,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;SACzB;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC;YACtC,WAAW,EACP,yEAAyE;YAC7E,UAAU,EAAE;gBACR,KAAK,EAAE;oBACH,IAAI,EAAE,iCAAiC;oBACvC,WAAW,EACP,6FAA6F;oBACjG,OAAO,EAAE,0BAA0B;iBACtC;gBACD,IAAI,EAAE;oBACF,IAAI,EAAE,iCAAiC;oBACvC,WAAW,EACP,mFAAmF;oBACvF,OAAO,EAAE,0BAA0B;iBACtC;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,WAAW,EACP,mEAAmE;oBACvE,OAAO,EAAE;wBACL,YAAY,EAAE;4BACV,GAAG,EAAE,EAAE;4BACP,EAAE,EAAE,EAAE;4BACN,QAAQ,EAAE;gCACN,IAAI,EAAE,CAAC;gCACP,KAAK,EAAE,EAAE;gCACT,GAAG,EAAE,EAAE;6BACV;yBACJ;wBACD,aAAa,EAAE;4BACX,GAAG,EAAE,CAAC;4BACN,EAAE,EAAE,GAAG;yBACV;qBACJ;oBACD,oBAAoB,EAAE;wBAClB,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACR,GAAG,EAAE;gCACD,WAAW,EACP,6CAA6C;gCACjD,IAAI,EAAE,QAAQ;gCACd,OAAO,EAAE,GAAG;gCACZ,OAAO,EAAE,CAAC;6BACb;4BACD,EAAE,EAAE;gCACA,WAAW,EACP,8CAA8C;gCAClD,IAAI,EAAE,SAAS;gCACf,OAAO,EAAE,EAAE;gCACX,OAAO,EAAE,CAAC;6BACb;4BACD,QAAQ,EAAE;gCACN,WAAW,EACP,0CAA0C;gCAC9C,IAAI,EAAE,QAAQ;gCACd,oBAAoB,EAAE;oCAClB,IAAI,EAAE,SAAS;oCACf,OAAO,EAAE,CAAC;iCACb;gCACD,OAAO,EAAE;oCACL,QAAQ,EAAE,EAAE;oCACZ,QAAQ,EAAE,EAAE;oCACZ,QAAQ,EAAE,CAAC;iCACd;6BACJ;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,UAAU,EAAV,wBAAU;SACb;KACJ;CACK,CAAC"}
+{"version":3,"file":"client-metrics-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/client-metrics-schema.ts"],"names":[],"mappings":";;;AACA,+CAA2C;AAE9B,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC;IAC/B,WAAW,EACP,yEAAyE;IAC7E,UAAU,EAAE;QACR,OAAO,EAAE;YACL,WAAW,EACP,wDAAwD;YAC5D,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,oBAAoB;SAChC;QACD,UAAU,EAAE;YACR,WAAW,EACP,qHAAqH;YACzH,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,2BAA2B;SACvC;QACD,WAAW,EAAE;YACT,WAAW,EAAE,iDAAiD;YAC9D,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;SACzB;QACD,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC;YACtC,WAAW,EACP,yEAAyE;YAC7E,UAAU,EAAE;gBACR,KAAK,EAAE;oBACH,IAAI,EAAE,iCAAiC;oBACvC,WAAW,EACP,6FAA6F;oBACjG,OAAO,EAAE,0BAA0B;iBACtC;gBACD,IAAI,EAAE;oBACF,IAAI,EAAE,iCAAiC;oBACvC,WAAW,EACP,mFAAmF;oBACvF,OAAO,EAAE,0BAA0B;iBACtC;gBACD,OAAO,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,WAAW,EACP,mEAAmE;oBACvE,OAAO,EAAE;wBACL,YAAY,EAAE;4BACV,GAAG,EAAE,EAAE;4BACP,EAAE,EAAE,EAAE;4BACN,QAAQ,EAAE;gCACN,IAAI,EAAE,CAAC;gCACP,KAAK,EAAE,EAAE;gCACT,GAAG,EAAE,EAAE;6BACV;yBACJ;wBACD,aAAa,EAAE;4BACX,GAAG,EAAE,CAAC;4BACN,EAAE,EAAE,GAAG;yBACV;qBACJ;oBACD,oBAAoB,EAAE;wBAClB,IAAI,EAAE,QAAQ;wBACd,UAAU,EAAE;4BACR,GAAG,EAAE;gCACD,WAAW,EACP,6CAA6C;gCACjD,IAAI,EAAE,QAAQ;gCACd,OAAO,EAAE,GAAG;gCACZ,OAAO,EAAE,CAAC;6BACb;4BACD,EAAE,EAAE;gCACA,WAAW,EACP,8CAA8C;gCAClD,IAAI,EAAE,SAAS;gCACf,OAAO,EAAE,EAAE;gCACX,OAAO,EAAE,CAAC;6BACb;4BACD,QAAQ,EAAE;gCACN,WAAW,EACP,+MAA+M;gCACnN,IAAI,EAAE,QAAQ;gCACd,oBAAoB,EAAE;oCAClB,IAAI,EAAE,SAAS;oCACf,OAAO,EAAE,CAAC;iCACb;gCACD,OAAO,EAAE;oCACL,QAAQ,EAAE,EAAE;oCACZ,QAAQ,EAAE,EAAE;oCACZ,QAAQ,EAAE,CAAC;iCACd;6BACJ;yBACJ;qBACJ;iBACJ;aACJ;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,UAAU,EAAV,wBAAU;SACb;KACJ;CACK,CAAC"}

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

@@ -10,6 +10,7 @@ export declare const contextFieldSchema: {
         };
         readonly description: {
             readonly type: "string";
+            readonly nullable: true;
         };
         readonly stickiness: {
             readonly type: "boolean";
@@ -22,6 +23,18 @@ export declare const contextFieldSchema: {
             readonly format: "date-time";
             readonly nullable: true;
         };
+        readonly usedInFeatures: {
+            readonly type: "number";
+            readonly description: "Number of projects where this context field is used in";
+            readonly example: 3;
+            readonly nullable: true;
+        };
+        readonly usedInProjects: {
+            readonly type: "number";
+            readonly description: "Number of projects where this context field is used in";
+            readonly example: 2;
+            readonly nullable: true;
+        };
         readonly legalValues: {
             readonly type: "array";
             readonly items: {

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

@@ -13,6 +13,7 @@ exports.contextFieldSchema = {
         },
         description: {
             type: 'string',
+            nullable: true,
         },
         stickiness: {
             type: 'boolean',
@@ -25,6 +26,18 @@ exports.contextFieldSchema = {
             format: 'date-time',
             nullable: true,
         },
+        usedInFeatures: {
+            type: 'number',
+            description: 'Number of projects where this context field is used in',
+            example: 3,
+            nullable: true,
+        },
+        usedInProjects: {
+            type: 'number',
+            description: 'Number of projects where this context field is used in',
+            example: 2,
+            nullable: true,
+        },
         legalValues: {
             type: 'array',
             items: {

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;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,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,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"}

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

@@ -0,0 +1,43 @@
+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 required: readonly ["strategies"];
+    readonly properties: {
+        readonly strategies: {
+            readonly type: "array";
+            readonly description: "List of strategies using the context field";
+            readonly items: {
+                readonly type: "object";
+                readonly required: readonly ["id", "featureName", "projectId", "environment", "strategyName"];
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly example: "433ae8d9-dd69-4ad0-bc46-414aedbe9c55";
+                        readonly description: "The ID of the strategy.";
+                    };
+                    readonly featureName: {
+                        readonly type: "string";
+                        readonly example: "best-feature";
+                        readonly description: "The name of the feature that contains this strategy.";
+                    };
+                    readonly projectId: {
+                        readonly type: "string";
+                        readonly description: "The ID of the project that contains this feature.";
+                    };
+                    readonly environment: {
+                        readonly type: "string";
+                        readonly description: "The ID of the environment where this strategy is in.";
+                    };
+                    readonly strategyName: {
+                        readonly type: "string";
+                        readonly description: "The name of the strategy.";
+                    };
+                };
+            };
+        };
+    };
+    readonly components: {};
+};
+export declare type ContextFieldStrategiesSchema = FromSchema<typeof contextFieldStrategiesSchema>;