UNPKG

unleash-server

Version:

Unleash is an enterprise ready feature flag service. It provides different strategies for handling feature flags.

github.com/Unleash/unleash

Unleash/unleash

68 lines • 3.54 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
import type { FromSchema } from 'json-schema-to-ts'; export declare const createStrategySchema: { readonly $id: "#/components/schemas/createStrategySchema"; readonly type: "object"; readonly description: "The data required to create a strategy type. Refer to the docs on [custom strategy types](https://docs.getunleash.io/concepts/activation-strategies#custom-strategies) for more information."; readonly required: readonly ["name", "parameters"]; readonly properties: { readonly name: { readonly type: "string"; readonly description: "The name of the strategy type. Must be unique."; readonly example: "my-custom-strategy"; }; readonly title: { readonly type: "string"; readonly description: "The title of the strategy"; readonly example: "My awesome strategy"; }; 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 editable: { readonly type: "boolean"; readonly description: "Whether the strategy type is editable or not. Defaults to `true`."; readonly example: false; }; readonly deprecated: { readonly type: "boolean"; readonly description: "Whether the strategy type is deprecated or not. Defaults to `false`."; readonly example: true; }; 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 CreateStrategySchema = FromSchema<typeof createStrategySchema>; //# sourceMappingURL=create-strategy-schema.d.ts.map