unleash-server
Version:
Unleash is an enterprise ready feature flag service. It provides different strategies for handling feature flags.
48 lines • 2.54 kB
TypeScript
import type { FromSchema } from 'json-schema-to-ts';
export declare const updateStrategySchema: {
readonly $id: "#/components/schemas/updateStrategySchema";
readonly type: "object";
readonly description: "The data required to update a strategy type.";
readonly required: readonly ["parameters"];
readonly properties: {
readonly description: {
readonly type: "string";
readonly description: "A description of the strategy type.";
readonly example: "Enable the feature for users who have not logged in before.";
};
readonly parameters: {
readonly type: "array";
readonly description: "The parameter list lets you pass arguments to your custom activation strategy. These will be made available to your custom strategy implementation.";
readonly items: {
readonly type: "object";
readonly required: readonly ["name", "type"];
readonly properties: {
readonly name: {
readonly type: "string";
readonly description: "The name of the parameter";
readonly example: "Rollout percentage";
};
readonly type: {
readonly type: "string";
readonly description: "The [type of the parameter](https://docs.getunleash.io/concepts/activation-strategies#parameters)";
readonly enum: readonly ["string", "percentage", "list", "number", "boolean"];
readonly example: "percentage";
};
readonly description: {
readonly type: "string";
readonly description: "A description of this strategy parameter. Use this to indicate to the users what the parameter does.";
readonly example: "How many percent of users should see this feature?";
};
readonly required: {
readonly type: "boolean";
readonly description: "Whether this parameter must be configured when using the strategy. Defaults to `false`";
readonly example: false;
};
};
};
};
};
readonly components: {};
};
export type UpdateStrategySchema = FromSchema<typeof updateStrategySchema>;
//# sourceMappingURL=update-strategy-schema.d.ts.map