unleash-server 5.2.7 → 5.3.0

package/dist/lib/openapi/spec/playground-response-schema.d.ts

@@ -67,6 +67,7 @@ export declare const playgroundResponseSchema: {
             readonly parametersSchema: {
                 readonly $id: "#/components/schemas/parametersSchema";
                 readonly type: "object";
+                readonly description: "A list of parameters for a strategy";
                 readonly additionalProperties: {
                     readonly type: "string";
                 };
@@ -194,7 +195,6 @@ export declare const playgroundResponseSchema: {
                                     readonly type: {
                                         readonly description: "The format of the payload.";
                                         readonly type: "string";
-                                        readonly enum: readonly ["json", "csv", "string"];
                                     };
                                     readonly value: {
                                         readonly type: "string";
@@ -276,6 +276,53 @@ export declare const playgroundResponseSchema: {
                                                 readonly type: "boolean";
                                                 readonly description: "Whether this strategy evaluates to true or not.";
                                             };
+                                            readonly variant: {
+                                                readonly description: "The feature variant you receive based on the provided context or the _disabled\n                          variant_. If a feature is disabled or doesn't have any\n                          variants, you would get the _disabled variant_.\n                          Otherwise, you'll get one of the feature's defined variants.";
+                                                readonly type: "object";
+                                                readonly additionalProperties: false;
+                                                readonly required: readonly ["name", "enabled"];
+                                                readonly properties: {
+                                                    readonly name: {
+                                                        readonly type: "string";
+                                                        readonly description: "The variant's name. If there is no variant or if the toggle is disabled, this will be `disabled`";
+                                                        readonly example: "red-variant";
+                                                    };
+                                                    readonly enabled: {
+                                                        readonly type: "boolean";
+                                                        readonly description: "Whether the variant is enabled or not. If the feature is disabled or if it doesn't have variants, this property will be `false`";
+                                                    };
+                                                    readonly payload: {
+                                                        readonly type: "object";
+                                                        readonly additionalProperties: false;
+                                                        readonly required: readonly ["type", "value"];
+                                                        readonly description: "An optional payload attached to the variant.";
+                                                        readonly properties: {
+                                                            readonly type: {
+                                                                readonly description: "The format of the payload.";
+                                                                readonly type: "string";
+                                                                readonly enum: readonly ["json", "csv", "string"];
+                                                            };
+                                                            readonly value: {
+                                                                readonly type: "string";
+                                                                readonly description: "The payload value stringified.";
+                                                                readonly example: "{\"property\": \"value\"}";
+                                                            };
+                                                        };
+                                                    };
+                                                };
+                                                readonly nullable: true;
+                                                readonly example: {
+                                                    readonly name: "green";
+                                                    readonly enabled: true;
+                                                };
+                                            };
+                                            readonly variants: {
+                                                readonly type: "array";
+                                                readonly description: "The feature variants.";
+                                                readonly items: {
+                                                    readonly $ref: "#/components/schemas/variantSchema";
+                                                };
+                                            };
                                         };
                                     }];
                                     readonly description: "The strategy's evaluation result. If the strategy is a custom strategy that Unleash can't evaluate, `evaluationStatus` will be `unknown`. Otherwise, it will be `true` or `false`";
@@ -452,11 +499,121 @@ export declare const playgroundResponseSchema: {
                                     readonly parametersSchema: {
                                         readonly $id: "#/components/schemas/parametersSchema";
                                         readonly type: "object";
+                                        readonly description: "A list of parameters for a strategy";
                                         readonly additionalProperties: {
                                             readonly type: "string";
                                         };
                                         readonly components: {};
                                     };
+                                    readonly variantSchema: {
+                                        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: "variable";
+                                                readonly enum: readonly ["variable", "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 additionalProperties: false;
+                                                readonly properties: {
+                                                    readonly type: {
+                                                        readonly description: "The type of the value. Commonly used types are string, json and csv.";
+                                                        readonly type: "string";
+                                                        readonly enum: readonly ["json", "csv", "string"];
+                                                    };
+                                                    readonly value: {
+                                                        readonly description: "The actual value of payload";
+                                                        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";
+                                                };
+                                            };
+                                        };
+                                        readonly components: {
+                                            readonly schemas: {
+                                                readonly overrideSchema: {
+                                                    readonly $id: "#/components/schemas/overrideSchema";
+                                                    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: {};
+                                                };
+                                            };
+                                        };
+                                    };
+                                    readonly overrideSchema: {
+                                        readonly $id: "#/components/schemas/overrideSchema";
+                                        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: {};
+                                    };
                                 };
                             };
                         };
@@ -591,6 +748,7 @@ export declare const playgroundResponseSchema: {
                         readonly parametersSchema: {
                             readonly $id: "#/components/schemas/parametersSchema";
                             readonly type: "object";
+                            readonly description: "A list of parameters for a strategy";
                             readonly additionalProperties: {
                                 readonly type: "string";
                             };
@@ -617,7 +775,8 @@ export declare const playgroundResponseSchema: {
                                 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 example: "variable";
+                                    readonly enum: readonly ["variable", "fix"];
                                 };
                                 readonly stickiness: {
                                     readonly type: "string";
@@ -628,17 +787,21 @@ export declare const playgroundResponseSchema: {
                                     readonly type: "object";
                                     readonly required: readonly ["type", "value"];
                                     readonly description: "Extra data configured for this variant";
+                                    readonly additionalProperties: false;
                                     readonly properties: {
                                         readonly type: {
+                                            readonly description: "The type of the value. Commonly used types are string, json and csv.";
                                             readonly type: "string";
+                                            readonly enum: readonly ["json", "csv", "string"];
                                         };
                                         readonly value: {
+                                            readonly description: "The actual value of payload";
                                             readonly type: "string";
                                         };
                                     };
                                     readonly example: {
                                         readonly type: "json";
-                                        readonly value: "{color: red}";
+                                        readonly value: "{\"color\": \"red\"}";
                                     };
                                 };
                                 readonly overrides: {
@@ -932,6 +1095,53 @@ export declare const playgroundResponseSchema: {
                                     readonly type: "boolean";
                                     readonly description: "Whether this strategy evaluates to true or not.";
                                 };
+                                readonly variant: {
+                                    readonly description: "The feature variant you receive based on the provided context or the _disabled\n                          variant_. If a feature is disabled or doesn't have any\n                          variants, you would get the _disabled variant_.\n                          Otherwise, you'll get one of the feature's defined variants.";
+                                    readonly type: "object";
+                                    readonly additionalProperties: false;
+                                    readonly required: readonly ["name", "enabled"];
+                                    readonly properties: {
+                                        readonly name: {
+                                            readonly type: "string";
+                                            readonly description: "The variant's name. If there is no variant or if the toggle is disabled, this will be `disabled`";
+                                            readonly example: "red-variant";
+                                        };
+                                        readonly enabled: {
+                                            readonly type: "boolean";
+                                            readonly description: "Whether the variant is enabled or not. If the feature is disabled or if it doesn't have variants, this property will be `false`";
+                                        };
+                                        readonly payload: {
+                                            readonly type: "object";
+                                            readonly additionalProperties: false;
+                                            readonly required: readonly ["type", "value"];
+                                            readonly description: "An optional payload attached to the variant.";
+                                            readonly properties: {
+                                                readonly type: {
+                                                    readonly description: "The format of the payload.";
+                                                    readonly type: "string";
+                                                    readonly enum: readonly ["json", "csv", "string"];
+                                                };
+                                                readonly value: {
+                                                    readonly type: "string";
+                                                    readonly description: "The payload value stringified.";
+                                                    readonly example: "{\"property\": \"value\"}";
+                                                };
+                                            };
+                                        };
+                                    };
+                                    readonly nullable: true;
+                                    readonly example: {
+                                        readonly name: "green";
+                                        readonly enabled: true;
+                                    };
+                                };
+                                readonly variants: {
+                                    readonly type: "array";
+                                    readonly description: "The feature variants.";
+                                    readonly items: {
+                                        readonly $ref: "#/components/schemas/variantSchema";
+                                    };
+                                };
                             };
                         }];
                         readonly description: "The strategy's evaluation result. If the strategy is a custom strategy that Unleash can't evaluate, `evaluationStatus` will be `unknown`. Otherwise, it will be `true` or `false`";
@@ -1108,11 +1318,121 @@ export declare const playgroundResponseSchema: {
                         readonly parametersSchema: {
                             readonly $id: "#/components/schemas/parametersSchema";
                             readonly type: "object";
+                            readonly description: "A list of parameters for a strategy";
                             readonly additionalProperties: {
                                 readonly type: "string";
                             };
                             readonly components: {};
                         };
+                        readonly variantSchema: {
+                            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: "variable";
+                                    readonly enum: readonly ["variable", "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 additionalProperties: false;
+                                    readonly properties: {
+                                        readonly type: {
+                                            readonly description: "The type of the value. Commonly used types are string, json and csv.";
+                                            readonly type: "string";
+                                            readonly enum: readonly ["json", "csv", "string"];
+                                        };
+                                        readonly value: {
+                                            readonly description: "The actual value of payload";
+                                            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";
+                                    };
+                                };
+                            };
+                            readonly components: {
+                                readonly schemas: {
+                                    readonly overrideSchema: {
+                                        readonly $id: "#/components/schemas/overrideSchema";
+                                        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: {};
+                                    };
+                                };
+                            };
+                        };
+                        readonly overrideSchema: {
+                            readonly $id: "#/components/schemas/overrideSchema";
+                            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: {};
+                        };
                     };
                 };
             };
@@ -1189,7 +1509,8 @@ export declare const playgroundResponseSchema: {
                     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 example: "variable";
+                        readonly enum: readonly ["variable", "fix"];
                     };
                     readonly stickiness: {
                         readonly type: "string";
@@ -1200,17 +1521,21 @@ export declare const playgroundResponseSchema: {
                         readonly type: "object";
                         readonly required: readonly ["type", "value"];
                         readonly description: "Extra data configured for this variant";
+                        readonly additionalProperties: false;
                         readonly properties: {
                             readonly type: {
+                                readonly description: "The type of the value. Commonly used types are string, json and csv.";
                                 readonly type: "string";
+                                readonly enum: readonly ["json", "csv", "string"];
                             };
                             readonly value: {
+                                readonly description: "The actual value of payload";
                                 readonly type: "string";
                             };
                         };
                         readonly example: {
                             readonly type: "json";
-                            readonly value: "{color: red}";
+                            readonly value: "{\"color\": \"red\"}";
                         };
                     };
                     readonly overrides: {