unleash-server 5.1.8 → 5.2.0

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

@@ -372,7 +372,7 @@ export declare const featuresSchema: {
                                     };
                                     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"];
@@ -489,23 +489,34 @@ export declare const featuresSchema: {
                                         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";
@@ -514,8 +525,13 @@ export declare const featuresSchema: {
                                                         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";
@@ -529,15 +545,20 @@ export declare const featuresSchema: {
                                                     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: {};
@@ -550,7 +571,7 @@ export declare const featuresSchema: {
                         };
                         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"];
@@ -668,15 +689,20 @@ export declare const featuresSchema: {
                             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: {};
@@ -693,23 +719,34 @@ export declare const featuresSchema: {
                             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";
@@ -718,8 +755,13 @@ export declare const featuresSchema: {
                                             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";
@@ -733,15 +775,20 @@ export declare const featuresSchema: {
                                         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: {};
@@ -782,15 +829,20 @@ export declare const featuresSchema: {
                 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: {};
@@ -903,7 +955,7 @@ export declare const featuresSchema: {
                         };
                         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"];
@@ -1020,23 +1072,34 @@ export declare const featuresSchema: {
                             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";
@@ -1045,8 +1108,13 @@ export declare const featuresSchema: {
                                             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";
@@ -1060,15 +1128,20 @@ export declare const featuresSchema: {
                                         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: {};
@@ -1081,7 +1154,7 @@ export declare const featuresSchema: {
             };
             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"];
@@ -1206,23 +1279,34 @@ export declare const featuresSchema: {
                 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";
@@ -1231,8 +1315,13 @@ export declare const featuresSchema: {
                                 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";
@@ -1246,15 +1335,20 @@ export declare const featuresSchema: {
                             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/health-check-schema.d.ts

@@ -2,12 +2,15 @@ import { FromSchema } from 'json-schema-to-ts';
 export declare const healthCheckSchema: {
     readonly $id: "#/components/schemas/healthCheckSchema";
     readonly type: "object";
+    readonly description: "Used by service orchestrators to decide whether this Unleash instance should be marked as healthy or unhealthy";
     readonly additionalProperties: false;
     readonly required: readonly ["health"];
     readonly properties: {
         readonly health: {
+            readonly description: "The state this Unleash instance is in. GOOD if everything is ok, BAD if the instance should be restarted";
             readonly type: "string";
             readonly enum: readonly ["GOOD", "BAD"];
+            readonly example: "GOOD";
         };
     };
     readonly components: {};

package/dist/lib/openapi/spec/health-check-schema.js

@@ -4,12 +4,15 @@ exports.healthCheckSchema = void 0;
 exports.healthCheckSchema = {
     $id: '#/components/schemas/healthCheckSchema',
     type: 'object',
+    description: 'Used by service orchestrators to decide whether this Unleash instance should be marked as healthy or unhealthy',
     additionalProperties: false,
     required: ['health'],
     properties: {
         health: {
+            description: 'The state this Unleash instance is in. GOOD if everything is ok, BAD if the instance should be restarted',
             type: 'string',
             enum: ['GOOD', 'BAD'],
+            example: 'GOOD',
         },
     },
     components: {},

package/dist/lib/openapi/spec/health-check-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"health-check-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/health-check-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAG;IAC7B,GAAG,EAAE,wCAAwC;IAC7C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,QAAQ,CAAC;IACpB,UAAU,EAAE;QACR,MAAM,EAAE;YACJ,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;SACxB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}
+{"version":3,"file":"health-check-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/health-check-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,iBAAiB,GAAG;IAC7B,GAAG,EAAE,wCAAwC;IAC7C,IAAI,EAAE,QAAQ;IACd,WAAW,EACP,gHAAgH;IACpH,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,QAAQ,CAAC;IACpB,UAAU,EAAE;QACR,MAAM,EAAE;YACJ,WAAW,EACP,0GAA0G;YAC9G,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC;YACrB,OAAO,EAAE,MAAM;SAClB;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}