unleash-server 5.2.7 → 5.3.0

package/dist/lib/openapi/spec/export-result-schema.js

@@ -13,44 +13,125 @@ const override_schema_1 = require("./override-schema");
 const variants_schema_1 = require("./variants-schema");
 const constraint_schema_1 = require("./constraint-schema");
 const tag_type_schema_1 = require("./tag-type-schema");
+const strategy_variant_schema_1 = require("./strategy-variant-schema");
 exports.exportResultSchema = {
     $id: '#/components/schemas/exportResultSchema',
     type: 'object',
     additionalProperties: false,
+    description: 'The result of the export operation, providing you with the feature toggle definitions, strategy definitions and the rest of the elements relevant to the features (tags, environments etc.)',
     required: ['features', 'featureStrategies', 'tagTypes'],
     properties: {
         features: {
             type: 'array',
+            description: 'All the exported features.',
+            example: [
+                {
+                    name: 'my-feature',
+                    description: 'best feature ever',
+                    type: 'release',
+                    project: 'default',
+                    stale: false,
+                    impressionData: false,
+                    archived: false,
+                },
+            ],
             items: {
                 $ref: '#/components/schemas/featureSchema',
             },
         },
         featureStrategies: {
             type: 'array',
+            description: 'All strategy instances that are used by the exported features in the `features` list.',
+            example: [
+                {
+                    name: 'flexibleRollout',
+                    id: '924974d7-8003-43ee-87eb-c5f887c06fd1',
+                    featureName: 'my-feature',
+                    title: 'Rollout 50%',
+                    parameters: {
+                        groupId: 'default',
+                        rollout: '50',
+                        stickiness: 'random',
+                    },
+                    constraints: [],
+                    disabled: false,
+                    segments: [1],
+                },
+            ],
             items: {
                 $ref: '#/components/schemas/featureStrategySchema',
             },
         },
         featureEnvironments: {
             type: 'array',
+            description: 'Environment-specific configuration for all the features in the `features` list. Includes data such as whether the feature is enabled in the selected export environment, whether there are any variants assigned, etc.',
+            example: [
+                {
+                    enabled: true,
+                    featureName: 'my-feature',
+                    environment: 'development',
+                    variants: [
+                        {
+                            name: 'a',
+                            weight: 500,
+                            overrides: [],
+                            stickiness: 'random',
+                            weightType: 'variable',
+                        },
+                        {
+                            name: 'b',
+                            weight: 500,
+                            overrides: [],
+                            stickiness: 'random',
+                            weightType: 'variable',
+                        },
+                    ],
+                    name: 'variant-testing',
+                },
+            ],
             items: {
                 $ref: '#/components/schemas/featureEnvironmentSchema',
             },
         },
         contextFields: {
             type: 'array',
+            description: 'A list of all the context fields that are in use by any of the strategies in the `featureStrategies` list.',
+            example: [
+                {
+                    name: 'appName',
+                    description: 'Allows you to constrain on application name',
+                    stickiness: false,
+                    sortOrder: 2,
+                    legalValues: [],
+                },
+            ],
             items: {
                 $ref: '#/components/schemas/contextFieldSchema',
             },
         },
         featureTags: {
             type: 'array',
+            description: 'A list of all the tags that have been applied to any of the features in the `features` list.',
+            example: [
+                {
+                    featureName: 'my-feature',
+                    tagType: 'simple',
+                    tagValue: 'user-facing',
+                },
+            ],
             items: {
                 $ref: '#/components/schemas/featureTagSchema',
             },
         },
         segments: {
             type: 'array',
+            description: 'A list of all the segments that are used by the strategies in the `featureStrategies` list.',
+            example: [
+                {
+                    id: 1,
+                    name: 'new-segment-name',
+                },
+            ],
             items: {
                 type: 'object',
                 additionalProperties: false,
@@ -67,6 +148,14 @@ exports.exportResultSchema = {
         },
         tagTypes: {
             type: 'array',
+            description: 'A list of all of the tag types that are used in the `featureTags` list.',
+            example: [
+                {
+                    name: 'simple',
+                    description: 'Used to simplify filtering of features',
+                    icon: '#',
+                },
+            ],
             items: {
                 $ref: '#/components/schemas/tagTypeSchema',
             },
@@ -76,6 +165,7 @@ exports.exportResultSchema = {
         schemas: {
             featureSchema: feature_schema_1.featureSchema,
             featureStrategySchema: feature_strategy_schema_1.featureStrategySchema,
+            strategyVariantSchema: strategy_variant_schema_1.strategyVariantSchema,
             featureEnvironmentSchema: feature_environment_schema_1.featureEnvironmentSchema,
             contextFieldSchema: context_field_schema_1.contextFieldSchema,
             featureTagSchema: feature_tag_schema_1.featureTagSchema,

package/dist/lib/openapi/spec/export-result-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"export-result-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/export-result-schema.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AACjD,uEAAkE;AAClE,6EAAwE;AACxE,iEAA4D;AAC5D,6DAAwD;AACxD,2DAAuD;AACvD,6DAAwD;AACxD,qDAAiD;AACjD,uDAAmD;AACnD,uDAAmD;AACnD,2DAAuD;AACvD,uDAAkD;AAErC,QAAA,kBAAkB,GAAG;IAC9B,GAAG,EAAE,yCAAyC;IAC9C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,UAAU,EAAE,mBAAmB,EAAE,UAAU,CAAC;IACvD,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;SACJ;QACD,iBAAiB,EAAE;YACf,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,4CAA4C;aACrD;SACJ;QACD,mBAAmB,EAAE;YACjB,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,+CAA+C;aACxD;SACJ;QACD,aAAa,EAAE;YACX,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,yCAAyC;aAClD;SACJ;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,uCAAuC;aAChD;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,KAAK;gBAC3B,QAAQ,EAAE,CAAC,IAAI,CAAC;gBAChB,UAAU,EAAE;oBACR,EAAE,EAAE;wBACA,IAAI,EAAE,QAAQ;qBACjB;oBACD,IAAI,EAAE;wBACF,IAAI,EAAE,QAAQ;qBACjB;iBACJ;aACJ;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,aAAa,EAAb,8BAAa;YACb,qBAAqB,EAArB,+CAAqB;YACrB,wBAAwB,EAAxB,qDAAwB;YACxB,kBAAkB,EAAlB,yCAAkB;YAClB,gBAAgB,EAAhB,qCAAgB;YAChB,cAAc,EAAd,gCAAc;YACd,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;YACd,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,qCAAgB;YAChB,aAAa,EAAb,+BAAa;SAChB;KACJ;CACK,CAAC"}
+{"version":3,"file":"export-result-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/export-result-schema.ts"],"names":[],"mappings":";;;AACA,qDAAiD;AACjD,uEAAkE;AAClE,6EAAwE;AACxE,iEAA4D;AAC5D,6DAAwD;AACxD,2DAAuD;AACvD,6DAAwD;AACxD,qDAAiD;AACjD,uDAAmD;AACnD,uDAAmD;AACnD,2DAAuD;AACvD,uDAAkD;AAClD,uEAAkE;AAErD,QAAA,kBAAkB,GAAG;IAC9B,GAAG,EAAE,yCAAyC;IAC9C,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,WAAW,EACP,6LAA6L;IACjM,QAAQ,EAAE,CAAC,UAAU,EAAE,mBAAmB,EAAE,UAAU,CAAC;IACvD,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,4BAA4B;YACzC,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,YAAY;oBAClB,WAAW,EAAE,mBAAmB;oBAChC,IAAI,EAAE,SAAS;oBACf,OAAO,EAAE,SAAS;oBAClB,KAAK,EAAE,KAAK;oBACZ,cAAc,EAAE,KAAK;oBACrB,QAAQ,EAAE,KAAK;iBAClB;aACJ;YACD,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;SACJ;QACD,iBAAiB,EAAE;YACf,IAAI,EAAE,OAAO;YACb,WAAW,EACP,uFAAuF;YAC3F,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,iBAAiB;oBACvB,EAAE,EAAE,sCAAsC;oBAC1C,WAAW,EAAE,YAAY;oBACzB,KAAK,EAAE,aAAa;oBACpB,UAAU,EAAE;wBACR,OAAO,EAAE,SAAS;wBAClB,OAAO,EAAE,IAAI;wBACb,UAAU,EAAE,QAAQ;qBACvB;oBACD,WAAW,EAAE,EAAE;oBACf,QAAQ,EAAE,KAAK;oBACf,QAAQ,EAAE,CAAC,CAAC,CAAC;iBAChB;aACJ;YACD,KAAK,EAAE;gBACH,IAAI,EAAE,4CAA4C;aACrD;SACJ;QACD,mBAAmB,EAAE;YACjB,IAAI,EAAE,OAAO;YACb,WAAW,EACP,wNAAwN;YAC5N,OAAO,EAAE;gBACL;oBACI,OAAO,EAAE,IAAI;oBACb,WAAW,EAAE,YAAY;oBACzB,WAAW,EAAE,aAAa;oBAC1B,QAAQ,EAAE;wBACN;4BACI,IAAI,EAAE,GAAG;4BACT,MAAM,EAAE,GAAG;4BACX,SAAS,EAAE,EAAE;4BACb,UAAU,EAAE,QAAQ;4BACpB,UAAU,EAAE,UAAU;yBACzB;wBACD;4BACI,IAAI,EAAE,GAAG;4BACT,MAAM,EAAE,GAAG;4BACX,SAAS,EAAE,EAAE;4BACb,UAAU,EAAE,QAAQ;4BACpB,UAAU,EAAE,UAAU;yBACzB;qBACJ;oBACD,IAAI,EAAE,iBAAiB;iBAC1B;aACJ;YACD,KAAK,EAAE;gBACH,IAAI,EAAE,+CAA+C;aACxD;SACJ;QACD,aAAa,EAAE;YACX,IAAI,EAAE,OAAO;YACb,WAAW,EACP,4GAA4G;YAChH,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,SAAS;oBACf,WAAW,EAAE,6CAA6C;oBAC1D,UAAU,EAAE,KAAK;oBACjB,SAAS,EAAE,CAAC;oBACZ,WAAW,EAAE,EAAE;iBAClB;aACJ;YACD,KAAK,EAAE;gBACH,IAAI,EAAE,yCAAyC;aAClD;SACJ;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,WAAW,EACP,8FAA8F;YAClG,OAAO,EAAE;gBACL;oBACI,WAAW,EAAE,YAAY;oBACzB,OAAO,EAAE,QAAQ;oBACjB,QAAQ,EAAE,aAAa;iBAC1B;aACJ;YACD,KAAK,EAAE;gBACH,IAAI,EAAE,uCAAuC;aAChD;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EACP,6FAA6F;YACjG,OAAO,EAAE;gBACL;oBACI,EAAE,EAAE,CAAC;oBACL,IAAI,EAAE,kBAAkB;iBAC3B;aACJ;YACD,KAAK,EAAE;gBACH,IAAI,EAAE,QAAQ;gBACd,oBAAoB,EAAE,KAAK;gBAC3B,QAAQ,EAAE,CAAC,IAAI,CAAC;gBAChB,UAAU,EAAE;oBACR,EAAE,EAAE;wBACA,IAAI,EAAE,QAAQ;qBACjB;oBACD,IAAI,EAAE;wBACF,IAAI,EAAE,QAAQ;qBACjB;iBACJ;aACJ;SACJ;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EACP,yEAAyE;YAC7E,OAAO,EAAE;gBACL;oBACI,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wCAAwC;oBACrD,IAAI,EAAE,GAAG;iBACZ;aACJ;YACD,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,aAAa,EAAb,8BAAa;YACb,qBAAqB,EAArB,+CAAqB;YACrB,qBAAqB,EAArB,+CAAqB;YACrB,wBAAwB,EAAxB,qDAAwB;YACxB,kBAAkB,EAAlB,yCAAkB;YAClB,gBAAgB,EAAhB,qCAAgB;YAChB,cAAc,EAAd,gCAAc;YACd,aAAa,EAAb,8BAAa;YACb,cAAc,EAAd,gCAAc;YACd,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,qCAAgB;YAChB,aAAa,EAAb,+BAAa;SAChB;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/feature-environment-schema.d.ts

@@ -14,9 +14,12 @@ export declare const featureEnvironmentSchema: {
         readonly featureName: {
             readonly type: "string";
             readonly example: "disable-comments";
+            readonly description: "The name of the feature";
         };
         readonly environment: {
             readonly type: "string";
+            readonly example: "development";
+            readonly description: "The name of the environment";
         };
         readonly type: {
             readonly type: "string";
@@ -35,6 +38,7 @@ export declare const featureEnvironmentSchema: {
         };
         readonly variantCount: {
             readonly type: "number";
+            readonly description: "The number of defined variants";
         };
         readonly strategies: {
             readonly type: "array";
@@ -100,6 +104,7 @@ export declare const featureEnvironmentSchema: {
             readonly parametersSchema: {
                 readonly $id: "#/components/schemas/parametersSchema";
                 readonly type: "object";
+                readonly description: "A list of parameters for a strategy";
                 readonly additionalProperties: {
                     readonly type: "string";
                 };
@@ -154,11 +159,18 @@ export declare const featureEnvironmentSchema: {
                     };
                     readonly constraints: {
                         readonly type: "array";
-                        readonly description: "A list of the constraints attached to the strategy";
+                        readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/strategy-constraints";
                         readonly items: {
                             readonly $ref: "#/components/schemas/constraintSchema";
                         };
                     };
+                    readonly variants: {
+                        readonly type: "array";
+                        readonly description: "Strategy level variants";
+                        readonly items: {
+                            readonly $ref: "#/components/schemas/strategyVariantSchema";
+                        };
+                    };
                     readonly parameters: {
                         readonly $ref: "#/components/schemas/parametersSchema";
                     };
@@ -212,14 +224,119 @@ export declare const featureEnvironmentSchema: {
                         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 strategyVariantSchema: {
+                            readonly $id: "#/components/schemas/strategyVariantSchema";
+                            readonly type: "object";
+                            readonly additionalProperties: false;
+                            readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
+                            readonly required: readonly ["name", "weight", "weightType", "stickiness"];
+                            readonly properties: {
+                                readonly name: {
+                                    readonly type: "string";
+                                    readonly description: "The variant name. Must be unique for this feature toggle";
+                                    readonly example: "blue_group";
+                                };
+                                readonly weight: {
+                                    readonly type: "integer";
+                                    readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer 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. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
+                                    readonly type: "string";
+                                    readonly example: "fix";
+                                    readonly enum: readonly ["variable", "fix"];
+                                };
+                                readonly stickiness: {
+                                    readonly type: "string";
+                                    readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this 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 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 components: {};
+                        };
                     };
                 };
             };
+            readonly strategyVariantSchema: {
+                readonly $id: "#/components/schemas/strategyVariantSchema";
+                readonly type: "object";
+                readonly additionalProperties: false;
+                readonly description: "This is an experimental property. It may change or be removed as we work on it. Please don't depend on it yet. A strategy variant allows you to attach any data to strategies instead of only returning `true`/`false`. Strategy variants take precedence over feature variants.";
+                readonly required: readonly ["name", "weight", "weightType", "stickiness"];
+                readonly properties: {
+                    readonly name: {
+                        readonly type: "string";
+                        readonly description: "The variant name. Must be unique for this feature toggle";
+                        readonly example: "blue_group";
+                    };
+                    readonly weight: {
+                        readonly type: "integer";
+                        readonly description: "The weight is the likelihood of any one user getting this variant. It is an integer 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. Refer to the [variant weight documentation](https://docs.getunleash.io/reference/feature-toggle-variants#variant-weight).";
+                        readonly type: "string";
+                        readonly example: "fix";
+                        readonly enum: readonly ["variable", "fix"];
+                    };
+                    readonly stickiness: {
+                        readonly type: "string";
+                        readonly description: "The [stickiness](https://docs.getunleash.io/reference/feature-toggle-variants#variant-stickiness) to use for distribution of this 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 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 components: {};
+            };
             readonly variantSchema: {
                 readonly $id: "#/components/schemas/variantSchema";
                 readonly type: "object";
@@ -241,7 +358,8 @@ export declare const featureEnvironmentSchema: {
                     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";
@@ -252,17 +370,21 @@ export declare const featureEnvironmentSchema: {
                         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: {

package/dist/lib/openapi/spec/feature-environment-schema.js

@@ -5,6 +5,7 @@ const constraint_schema_1 = require("./constraint-schema");
 const parameters_schema_1 = require("./parameters-schema");
 const feature_strategy_schema_1 = require("./feature-strategy-schema");
 const variant_schema_1 = require("./variant-schema");
+const strategy_variant_schema_1 = require("./strategy-variant-schema");
 exports.featureEnvironmentSchema = {
     $id: '#/components/schemas/featureEnvironmentSchema',
     type: 'object',
@@ -20,9 +21,12 @@ exports.featureEnvironmentSchema = {
         featureName: {
             type: 'string',
             example: 'disable-comments',
+            description: 'The name of the feature',
         },
         environment: {
             type: 'string',
+            example: 'development',
+            description: 'The name of the environment',
         },
         type: {
             type: 'string',
@@ -41,6 +45,7 @@ exports.featureEnvironmentSchema = {
         },
         variantCount: {
             type: 'number',
+            description: 'The number of defined variants',
         },
         strategies: {
             type: 'array',
@@ -62,6 +67,7 @@ exports.featureEnvironmentSchema = {
             constraintSchema: constraint_schema_1.constraintSchema,
             parametersSchema: parameters_schema_1.parametersSchema,
             featureStrategySchema: feature_strategy_schema_1.featureStrategySchema,
+            strategyVariantSchema: strategy_variant_schema_1.strategyVariantSchema,
             variantSchema: variant_schema_1.variantSchema,
         },
     },

package/dist/lib/openapi/spec/feature-environment-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"feature-environment-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/feature-environment-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,2DAAuD;AACvD,uEAAkE;AAClE,qDAAiD;AAEpC,QAAA,wBAAwB,GAAG;IACpC,GAAG,EAAE,+CAA+C;IACpD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;IAC7B,WAAW,EAAE,mDAAmD;IAChE,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,YAAY;YACrB,WAAW,EAAE,6BAA6B;SAC7C;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,kBAAkB;SAC9B;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;SACjB;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,6BAA6B;SAC7C;QACD,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EACP,0EAA0E;SACjF;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC;YACV,WAAW,EACP,4EAA4E;SACnF;QACD,YAAY,EAAE;YACV,IAAI,EAAE,QAAQ;SACjB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,4CAA4C;aACrD;YACD,WAAW,EACP,6DAA6D;SACpE;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;YACD,WAAW,EAAE,gDAAgD;SAChE;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;YAChB,qBAAqB,EAArB,+CAAqB;YACrB,aAAa,EAAb,8BAAa;SAChB;KACJ;CACK,CAAC"}
+{"version":3,"file":"feature-environment-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/feature-environment-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AACvD,2DAAuD;AACvD,uEAAkE;AAClE,qDAAiD;AACjD,uEAAkE;AAErD,QAAA,wBAAwB,GAAG;IACpC,GAAG,EAAE,+CAA+C;IACpD,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC;IAC7B,WAAW,EAAE,mDAAmD;IAChE,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,YAAY;YACrB,WAAW,EAAE,6BAA6B;SAC7C;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,kBAAkB;YAC3B,WAAW,EAAE,yBAAyB;SACzC;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,6BAA6B;SAC7C;QACD,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,aAAa;YACtB,WAAW,EAAE,6BAA6B;SAC7C;QACD,OAAO,EAAE;YACL,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,WAAW,EACP,0EAA0E;SACjF;QACD,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,CAAC;YACV,WAAW,EACP,4EAA4E;SACnF;QACD,YAAY,EAAE;YACV,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,gCAAgC;SAChD;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,4CAA4C;aACrD;YACD,WAAW,EACP,6DAA6D;SACpE;QACD,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACH,IAAI,EAAE,oCAAoC;aAC7C;YACD,WAAW,EAAE,gDAAgD;SAChE;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;YAChB,gBAAgB,EAAhB,oCAAgB;YAChB,qBAAqB,EAArB,+CAAqB;YACrB,qBAAqB,EAArB,+CAAqB;YACrB,aAAa,EAAb,8BAAa;SAChB;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/feature-events-schema.d.ts

@@ -4,22 +4,32 @@ export declare const featureEventsSchema: {
     readonly type: "object";
     readonly additionalProperties: false;
     readonly required: readonly ["events"];
+    readonly description: "One or more events happening to a specific feature toggle";
     readonly properties: {
         readonly version: {
-            readonly type: "number";
+            readonly type: "integer";
+            readonly description: "An API versioning number";
+            readonly minimum: 1;
+            readonly enum: readonly [1];
+            readonly example: 1;
         };
         readonly toggleName: {
+            readonly description: "The name of the feature toggle these events relate to";
             readonly type: "string";
+            readonly example: "my.first.feature.toggle";
         };
         readonly events: {
+            readonly description: "The list of events";
             readonly type: "array";
             readonly items: {
                 readonly $ref: "#/components/schemas/eventSchema";
             };
         };
         readonly totalEvents: {
+            readonly description: "How many events are there for this feature toggle";
             readonly type: "integer";
             readonly minimum: 0;
+            readonly example: 13;
         };
     };
     readonly components: {
@@ -29,40 +39,83 @@ export declare const featureEventsSchema: {
                 readonly type: "object";
                 readonly additionalProperties: false;
                 readonly required: readonly ["id", "createdAt", "type", "createdBy"];
+                readonly description: "An event describing something happening in the system";
                 readonly properties: {
                     readonly id: {
                         readonly type: "integer";
                         readonly minimum: 1;
+                        readonly description: "The ID of the event. An increasing natural number.";
                     };
                     readonly createdAt: {
                         readonly type: "string";
                         readonly format: "date-time";
+                        readonly description: "The time the event happened as a RFC 3339-conformant timestamp.";
+                        readonly example: "2023-07-05T12:56:00.000Z";
                     };
                     readonly type: {
                         readonly type: "string";
+                        readonly description: "What [type](https://docs.getunleash.io/reference/api/legacy/unleash/admin/events#event-type-description) of event this is";
+                        readonly enum: readonly ["application-created", "feature-created", "feature-deleted", "feature-updated", "feature-metadata-updated", "feature-variants-updated", "feature-environment-variants-updated", "feature-project-change", "feature-archived", "feature-revived", "feature-import", "feature-tagged", "feature-tag-import", "feature-strategy-update", "feature-strategy-add", "feature-strategy-remove", "strategy-order-changed", "drop-feature-tags", "feature-untagged", "feature-stale-on", "feature-stale-off", "drop-features", "feature-environment-enabled", "feature-environment-disabled", "strategy-created", "strategy-deleted", "strategy-deprecated", "strategy-reactivated", "strategy-updated", "strategy-import", "drop-strategies", "context-field-created", "context-field-updated", "context-field-deleted", "project-access-added", "project-created", "project-updated", "project-deleted", "project-import", "project-user-added", "project-user-removed", "project-user-role-changed", "project-group-role-changed", "project-group-added", "project-group-removed", "drop-projects", "tag-created", "tag-deleted", "tag-import", "drop-tags", "tag-type-created", "tag-type-deleted", "tag-type-updated", "tag-type-import", "drop-tag-types", "addon-config-created", "addon-config-updated", "addon-config-deleted", "db-pool-update", "user-created", "user-updated", "user-deleted", "drop-environments", "environment-import", "segment-created", "segment-updated", "segment-deleted", "group-created", "group-updated", "setting-created", "setting-updated", "setting-deleted", "client-metrics", "client-register", "pat-created", "pat-deleted", "public-signup-token-created", "public-signup-token-user-added", "public-signup-token-updated", "change-request-created", "change-request-discarded", "change-added", "change-discarded", "change-edited", "change-request-approved", "change-request-approval-added", "change-request-cancelled", "change-request-sent-to-review", "change-request-applied", "api-token-created", "api-token-updated", "api-token-deleted", "feature-favorited", "feature-unfavorited", "project-favorited", "project-unfavorited", "features-exported", "features-imported", "service-account-created", "service-account-deleted", "service-account-updated", "feature-potentially-stale-on"];
+                        readonly example: "feature-created";
                     };
                     readonly createdBy: {
                         readonly type: "string";
+                        readonly description: "Which user created this event";
+                        readonly example: "johndoe";
                     };
                     readonly environment: {
                         readonly type: "string";
+                        readonly description: "The feature toggle environment the event relates to, if applicable.";
                         readonly nullable: true;
+                        readonly example: "development";
                     };
                     readonly project: {
                         readonly type: "string";
                         readonly nullable: true;
+                        readonly description: "The project the event relates to, if applicable.";
+                        readonly example: "default";
                     };
                     readonly featureName: {
                         readonly type: "string";
                         readonly nullable: true;
+                        readonly description: "The name of the feature toggle the event relates to, if applicable.";
+                        readonly example: "my.first.feature";
                     };
                     readonly data: {
                         readonly type: "object";
                         readonly nullable: true;
+                        readonly 'x-enforcer-exception-skip-codes': "WSCH006";
+                        readonly additionalProperties: true;
+                        readonly description: "Extra associated data related to the event, such as feature toggle state, segment configuration, etc., if applicable.";
+                        readonly example: {
+                            readonly name: "new-feature";
+                            readonly description: "Toggle description";
+                            readonly type: "release";
+                            readonly project: "my-project";
+                            readonly stale: false;
+                            readonly variants: readonly [];
+                            readonly createdAt: "2022-05-31T13:32:20.547Z";
+                            readonly lastSeenAt: any;
+                            readonly impressionData: true;
+                        };
                     };
                     readonly preData: {
+                        readonly description: "Data relating to the previous state of the event's subject.";
                         readonly type: "object";
                         readonly nullable: true;
+                        readonly 'x-enforcer-exception-skip-codes': "WSCH006";
+                        readonly additionalProperties: true;
+                        readonly example: {
+                            readonly name: "new-feature";
+                            readonly description: "Toggle description";
+                            readonly type: "release";
+                            readonly project: "my-project";
+                            readonly stale: false;
+                            readonly variants: readonly [];
+                            readonly createdAt: "2022-05-31T13:32:20.547Z";
+                            readonly lastSeenAt: any;
+                            readonly impressionData: true;
+                        };
                     };
                     readonly tags: {
                         readonly type: "array";
@@ -70,6 +123,7 @@ export declare const featureEventsSchema: {
                             readonly $ref: "#/components/schemas/tagSchema";
                         };
                         readonly nullable: true;
+                        readonly description: "Any tags related to the event, if applicable.";
                     };
                 };
                 readonly components: {
@@ -99,6 +153,92 @@ export declare const featureEventsSchema: {
                             };
                             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: {};
+                                    };
+                                };
+                            };
+                        };
                     };
                 };
             };