unleash-server
Version:
Unleash is an enterprise ready feature flag service. It provides different strategies for handling feature flags.
98 lines • 4.69 kB
TypeScript
import type { FromSchema } from 'json-schema-to-ts';
export declare const strategiesSchema: {
readonly $id: "#/components/schemas/strategiesSchema";
readonly type: "object";
readonly additionalProperties: false;
readonly required: readonly ["version", "strategies"];
readonly description: "List of strategies";
readonly properties: {
readonly version: {
readonly type: "integer";
readonly enum: readonly [1];
readonly example: 1;
readonly description: "Version of the strategies schema";
};
readonly strategies: {
readonly type: "array";
readonly items: {
readonly $ref: "#/components/schemas/strategySchema";
};
readonly description: "List of strategies";
};
};
readonly components: {
readonly schemas: {
readonly strategySchema: {
readonly $id: "#/components/schemas/strategySchema";
readonly description: "The [activation strategy](https://docs.getunleash.io/concepts/activation-strategies) schema";
readonly type: "object";
readonly additionalProperties: false;
readonly required: readonly ["name", "displayName", "description", "editable", "deprecated", "parameters"];
readonly properties: {
readonly title: {
readonly type: "string";
readonly nullable: true;
readonly description: "An optional title for the strategy";
readonly example: "GradualRollout - Prod25";
};
readonly name: {
readonly type: "string";
readonly description: "The name (type) of the strategy";
readonly example: "flexibleRollout";
};
readonly displayName: {
readonly type: "string";
readonly description: "A human friendly name for the strategy";
readonly example: "Gradual Rollout";
readonly nullable: true;
};
readonly description: {
readonly type: "string";
readonly nullable: true;
readonly description: "A short description of the strategy";
readonly example: "Gradual rollout to logged in users";
};
readonly editable: {
readonly type: "boolean";
readonly description: "Whether the strategy can be edited or not. Strategies bundled with Unleash cannot be edited.";
readonly example: true;
};
readonly deprecated: {
readonly type: "boolean";
readonly description: "";
readonly example: true;
};
readonly parameters: {
readonly type: "array";
readonly description: "A list of relevant parameters for each strategy";
readonly items: {
readonly type: "object";
readonly additionalProperties: false;
readonly properties: {
readonly name: {
readonly type: "string";
readonly example: "percentage";
};
readonly type: {
readonly type: "string";
readonly example: "percentage";
};
readonly description: {
readonly type: "string";
readonly example: "Gradual rollout to logged in users";
};
readonly required: {
readonly type: "boolean";
readonly example: true;
};
};
};
};
};
readonly components: {};
};
};
};
};
export type StrategiesSchema = FromSchema<typeof strategiesSchema>;
//# sourceMappingURL=strategies-schema.d.ts.map