unleash-server 5.4.4 → 5.5.0

package/dist/lib/openapi/spec/segments-schema.d.ts

@@ -0,0 +1,177 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const segmentsSchema: {
+    readonly $id: "#/components/schemas/segmentsSchema";
+    readonly description: "Data containing a list of [segments](https://docs.getunleash.io/reference/segments)";
+    readonly type: "object";
+    readonly properties: {
+        readonly segments: {
+            readonly type: "array";
+            readonly description: "A list of segments";
+            readonly items: {
+                readonly $ref: "#/components/schemas/adminSegmentSchema";
+            };
+        };
+    };
+    readonly components: {
+        readonly schemas: {
+            readonly adminSegmentSchema: {
+                readonly $id: "#/components/schemas/adminSegmentSchema";
+                readonly type: "object";
+                readonly required: readonly ["id", "name", "constraints", "createdAt"];
+                readonly description: "A description of a [segment](https://docs.getunleash.io/reference/segments)";
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "integer";
+                        readonly description: "The ID of this segment";
+                        readonly example: 2;
+                        readonly minimum: 0;
+                    };
+                    readonly name: {
+                        readonly type: "string";
+                        readonly description: "The name of this segment";
+                        readonly example: "ios-users";
+                    };
+                    readonly description: {
+                        readonly type: "string";
+                        readonly nullable: true;
+                        readonly description: "The description for this segment";
+                        readonly example: "IOS users segment";
+                    };
+                    readonly constraints: {
+                        readonly type: "array";
+                        readonly description: "The list of constraints that are used in this segment";
+                        readonly items: {
+                            readonly $ref: "#/components/schemas/constraintSchema";
+                        };
+                    };
+                    readonly usedInFeatures: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "The number of projects that use this segment";
+                        readonly example: 3;
+                        readonly nullable: true;
+                    };
+                    readonly usedInProjects: {
+                        readonly type: "integer";
+                        readonly minimum: 0;
+                        readonly description: "The number of projects that use this segment";
+                        readonly example: 2;
+                        readonly nullable: true;
+                    };
+                    readonly project: {
+                        readonly type: "string";
+                        readonly nullable: true;
+                        readonly example: "red-vista";
+                        readonly description: "The project the segment belongs to. Only present if the segment is a project-specific segment.";
+                    };
+                    readonly createdBy: {
+                        readonly description: "The creator's email or username";
+                        readonly example: "someone@example.com";
+                        readonly type: "string";
+                        readonly nullable: true;
+                    };
+                    readonly createdAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "When the segment was created";
+                        readonly example: "2023-04-12T11:13:31.960Z";
+                    };
+                };
+                readonly components: {
+                    readonly schemas: {
+                        readonly constraintSchema: {
+                            readonly type: "object";
+                            readonly required: readonly ["contextName", "operator"];
+                            readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/reference/strategy-constraints)";
+                            readonly properties: {
+                                readonly contextName: {
+                                    readonly description: "The name of the context field that this constraint should apply to.";
+                                    readonly example: "appName";
+                                    readonly type: "string";
+                                };
+                                readonly operator: {
+                                    readonly description: "The operator to use when evaluating this constraint. For more information about the various operators, refer to [the strategy constraint operator documentation](https://docs.getunleash.io/reference/strategy-constraints#strategy-constraint-operators).";
+                                    readonly type: "string";
+                                    readonly enum: readonly ["NOT_IN", "IN", "STR_ENDS_WITH", "STR_STARTS_WITH", "STR_CONTAINS", "NUM_EQ", "NUM_GT", "NUM_GTE", "NUM_LT", "NUM_LTE", "DATE_AFTER", "DATE_BEFORE", "SEMVER_EQ", "SEMVER_GT", "SEMVER_LT"];
+                                    readonly example: "IN";
+                                };
+                                readonly caseInsensitive: {
+                                    readonly description: "Whether the operator should be case sensitive or not. Defaults to `false` (being case sensitive).";
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly inverted: {
+                                    readonly description: "Whether the result should be negated or not. If `true`, will turn a `true` result into a `false` result and vice versa.";
+                                    readonly type: "boolean";
+                                    readonly default: false;
+                                };
+                                readonly values: {
+                                    readonly type: "array";
+                                    readonly description: "The context values that should be used for constraint evaluation. Use this property instead of `value` for properties that accept multiple values.";
+                                    readonly items: {
+                                        readonly type: "string";
+                                    };
+                                    readonly example: readonly ["my-app", "my-other-app"];
+                                };
+                                readonly value: {
+                                    readonly description: "The context value that should be used for constraint evaluation. Use this property instead of `values` for properties that only accept single values.";
+                                    readonly type: "string";
+                                    readonly example: "my-app";
+                                };
+                            };
+                            readonly components: {};
+                            readonly $id: "#/components/schemas/constraintSchema";
+                            readonly additionalProperties: false;
+                        };
+                    };
+                };
+            };
+            readonly constraintSchema: {
+                readonly type: "object";
+                readonly required: readonly ["contextName", "operator"];
+                readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/reference/strategy-constraints)";
+                readonly properties: {
+                    readonly contextName: {
+                        readonly description: "The name of the context field that this constraint should apply to.";
+                        readonly example: "appName";
+                        readonly type: "string";
+                    };
+                    readonly operator: {
+                        readonly description: "The operator to use when evaluating this constraint. For more information about the various operators, refer to [the strategy constraint operator documentation](https://docs.getunleash.io/reference/strategy-constraints#strategy-constraint-operators).";
+                        readonly type: "string";
+                        readonly enum: readonly ["NOT_IN", "IN", "STR_ENDS_WITH", "STR_STARTS_WITH", "STR_CONTAINS", "NUM_EQ", "NUM_GT", "NUM_GTE", "NUM_LT", "NUM_LTE", "DATE_AFTER", "DATE_BEFORE", "SEMVER_EQ", "SEMVER_GT", "SEMVER_LT"];
+                        readonly example: "IN";
+                    };
+                    readonly caseInsensitive: {
+                        readonly description: "Whether the operator should be case sensitive or not. Defaults to `false` (being case sensitive).";
+                        readonly type: "boolean";
+                        readonly default: false;
+                    };
+                    readonly inverted: {
+                        readonly description: "Whether the result should be negated or not. If `true`, will turn a `true` result into a `false` result and vice versa.";
+                        readonly type: "boolean";
+                        readonly default: false;
+                    };
+                    readonly values: {
+                        readonly type: "array";
+                        readonly description: "The context values that should be used for constraint evaluation. Use this property instead of `value` for properties that accept multiple values.";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                        readonly example: readonly ["my-app", "my-other-app"];
+                    };
+                    readonly value: {
+                        readonly description: "The context value that should be used for constraint evaluation. Use this property instead of `values` for properties that only accept single values.";
+                        readonly type: "string";
+                        readonly example: "my-app";
+                    };
+                };
+                readonly components: {};
+                readonly $id: "#/components/schemas/constraintSchema";
+                readonly additionalProperties: false;
+            };
+        };
+    };
+};
+export declare type SegmentsSchema = FromSchema<typeof segmentsSchema>;

package/dist/lib/openapi/spec/segments-schema.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.segmentsSchema = void 0;
+const admin_segment_schema_1 = require("./admin-segment-schema");
+const constraint_schema_1 = require("./constraint-schema");
+exports.segmentsSchema = {
+    $id: '#/components/schemas/segmentsSchema',
+    description: 'Data containing a list of [segments](https://docs.getunleash.io/reference/segments)',
+    type: 'object',
+    properties: {
+        segments: {
+            type: 'array',
+            description: 'A list of segments',
+            items: {
+                $ref: '#/components/schemas/adminSegmentSchema',
+            },
+        },
+    },
+    components: {
+        schemas: {
+            adminSegmentSchema: admin_segment_schema_1.adminSegmentSchema,
+            constraintSchema: constraint_schema_1.constraintSchema,
+        },
+    },
+};
+//# sourceMappingURL=segments-schema.js.map

package/dist/lib/openapi/spec/segments-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"segments-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/segments-schema.ts"],"names":[],"mappings":";;;AACA,iEAA4D;AAC5D,2DAAuD;AAE1C,QAAA,cAAc,GAAG;IAC1B,GAAG,EAAE,qCAAqC;IAC1C,WAAW,EACP,qFAAqF;IACzF,IAAI,EAAE,QAAQ;IACd,UAAU,EAAE;QACR,QAAQ,EAAE;YACN,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,oBAAoB;YACjC,KAAK,EAAE;gBACH,IAAI,EAAE,yCAAyC;aAClD;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,kBAAkB,EAAlB,yCAAkB;YAClB,gBAAgB,EAAhB,oCAAgB;SACnB;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/segments-schema.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lib/openapi/spec/segments-schema.test.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const validate_1 = require("../validate");
+test('updateEnvironmentSchema', () => {
+    const data = {
+        segments: [],
+    };
+    expect((0, validate_1.validateSchema)('#/components/schemas/segmentsSchema', data)).toBeUndefined();
+    expect((0, validate_1.validateSchema)('#/components/schemas/segmentsSchema', {
+        segments: [],
+        additional: 'property',
+    })).toBeUndefined();
+    expect((0, validate_1.validateSchema)('#/components/schemas/segmentsSchema', {})).toMatchSnapshot();
+    expect((0, validate_1.validateSchema)('#/components/schemas/segmentsSchema', 'not an object')).toMatchSnapshot();
+});
+//# sourceMappingURL=segments-schema.test.js.map

package/dist/lib/openapi/spec/segments-schema.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"segments-schema.test.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/segments-schema.test.ts"],"names":[],"mappings":";;AAAA,0CAA6C;AAG7C,IAAI,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACjC,MAAM,IAAI,GAAmB;QACzB,QAAQ,EAAE,EAAE;KACf,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EAAC,qCAAqC,EAAE,IAAI,CAAC,CAC9D,CAAC,aAAa,EAAE,CAAC;IAElB,MAAM,CACF,IAAA,yBAAc,EAAC,qCAAqC,EAAE;QAClD,QAAQ,EAAE,EAAE;QACZ,UAAU,EAAE,UAAU;KACzB,CAAC,CACL,CAAC,aAAa,EAAE,CAAC;IAElB,MAAM,CACF,IAAA,yBAAc,EAAC,qCAAqC,EAAE,EAAE,CAAC,CAC5D,CAAC,eAAe,EAAE,CAAC;IAEpB,MAAM,CACF,IAAA,yBAAc,EAAC,qCAAqC,EAAE,eAAe,CAAC,CACzE,CAAC,eAAe,EAAE,CAAC;AACxB,CAAC,CAAC,CAAC"}

package/dist/lib/openapi/spec/state-schema.d.ts

@@ -517,9 +517,9 @@ export declare const stateSchema: {
                                                             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 description: "The type of the value. Commonly used types are string, number, json and csv.";
                                                                     readonly type: "string";
-                                                                    readonly enum: readonly ["json", "csv", "string"];
+                                                                    readonly enum: readonly ["json", "csv", "string", "number"];
                                                                 };
                                                                 readonly value: {
                                                                     readonly description: "The actual value of payload";
@@ -572,9 +572,9 @@ export declare const stateSchema: {
                                                 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 description: "The type of the value. Commonly used types are string, number, json and csv.";
                                                         readonly type: "string";
-                                                        readonly enum: readonly ["json", "csv", "string"];
+                                                        readonly enum: readonly ["json", "csv", "string", "number"];
                                                     };
                                                     readonly value: {
                                                         readonly description: "The actual value of payload";
@@ -625,9 +625,9 @@ export declare const stateSchema: {
                                                 readonly additionalProperties: false;
                                                 readonly properties: {
                                                     readonly type: {
-                                                        readonly description: "The type of the value. Commonly used types are string, json and csv.";
+                                                        readonly description: "The type of the value. Commonly used types are string, number, json and csv.";
                                                         readonly type: "string";
-                                                        readonly enum: readonly ["json", "csv", "string"];
+                                                        readonly enum: readonly ["json", "csv", "string", "number"];
                                                     };
                                                     readonly value: {
                                                         readonly description: "The actual value of payload";
@@ -833,9 +833,9 @@ export declare const stateSchema: {
                                                 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 description: "The type of the value. Commonly used types are string, number, json and csv.";
                                                         readonly type: "string";
-                                                        readonly enum: readonly ["json", "csv", "string"];
+                                                        readonly enum: readonly ["json", "csv", "string", "number"];
                                                     };
                                                     readonly value: {
                                                         readonly description: "The actual value of payload";
@@ -888,9 +888,9 @@ export declare const stateSchema: {
                                     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 description: "The type of the value. Commonly used types are string, number, json and csv.";
                                             readonly type: "string";
-                                            readonly enum: readonly ["json", "csv", "string"];
+                                            readonly enum: readonly ["json", "csv", "string", "number"];
                                         };
                                         readonly value: {
                                             readonly description: "The actual value of payload";
@@ -973,9 +973,9 @@ export declare const stateSchema: {
                                     readonly additionalProperties: false;
                                     readonly properties: {
                                         readonly type: {
-                                            readonly description: "The type of the value. Commonly used types are string, json and csv.";
+                                            readonly description: "The type of the value. Commonly used types are string, number, json and csv.";
                                             readonly type: "string";
-                                            readonly enum: readonly ["json", "csv", "string"];
+                                            readonly enum: readonly ["json", "csv", "string", "number"];
                                         };
                                         readonly value: {
                                             readonly description: "The actual value of payload";
@@ -1195,7 +1195,7 @@ export declare const stateSchema: {
                     };
                     readonly mode: {
                         readonly type: "string";
-                        readonly enum: readonly ["open", "protected"];
+                        readonly enum: readonly ["open", "protected", "private"];
                         readonly example: "open";
                         readonly description: "The project's [collaboration mode](https://docs.getunleash.io/reference/project-collaboration-mode). Determines whether non-project members can submit change requests or not.";
                     };
@@ -1362,9 +1362,9 @@ export declare const stateSchema: {
                                     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 description: "The type of the value. Commonly used types are string, number, json and csv.";
                                             readonly type: "string";
-                                            readonly enum: readonly ["json", "csv", "string"];
+                                            readonly enum: readonly ["json", "csv", "string", "number"];
                                         };
                                         readonly value: {
                                             readonly description: "The actual value of payload";
@@ -1417,9 +1417,9 @@ export declare const stateSchema: {
                         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 description: "The type of the value. Commonly used types are string, number, json and csv.";
                                 readonly type: "string";
-                                readonly enum: readonly ["json", "csv", "string"];
+                                readonly enum: readonly ["json", "csv", "string", "number"];
                             };
                             readonly value: {
                                 readonly description: "The actual value of payload";
@@ -1707,9 +1707,9 @@ export declare const stateSchema: {
                                                 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 description: "The type of the value. Commonly used types are string, number, json and csv.";
                                                         readonly type: "string";
-                                                        readonly enum: readonly ["json", "csv", "string"];
+                                                        readonly enum: readonly ["json", "csv", "string", "number"];
                                                     };
                                                     readonly value: {
                                                         readonly description: "The actual value of payload";
@@ -1762,9 +1762,9 @@ export declare const stateSchema: {
                                     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 description: "The type of the value. Commonly used types are string, number, json and csv.";
                                             readonly type: "string";
-                                            readonly enum: readonly ["json", "csv", "string"];
+                                            readonly enum: readonly ["json", "csv", "string", "number"];
                                         };
                                         readonly value: {
                                             readonly description: "The actual value of payload";
@@ -1815,9 +1815,9 @@ export declare const stateSchema: {
                                     readonly additionalProperties: false;
                                     readonly properties: {
                                         readonly type: {
-                                            readonly description: "The type of the value. Commonly used types are string, json and csv.";
+                                            readonly description: "The type of the value. Commonly used types are string, number, json and csv.";
                                             readonly type: "string";
-                                            readonly enum: readonly ["json", "csv", "string"];
+                                            readonly enum: readonly ["json", "csv", "string", "number"];
                                         };
                                         readonly value: {
                                             readonly description: "The actual value of payload";

package/dist/lib/openapi/spec/strategy-variant-schema.d.ts

@@ -34,9 +34,9 @@ export declare const strategyVariantSchema: {
             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 description: "The type of the value. Commonly used types are string, number, json and csv.";
                     readonly type: "string";
-                    readonly enum: readonly ["json", "csv", "string"];
+                    readonly enum: readonly ["json", "csv", "string", "number"];
                 };
                 readonly value: {
                     readonly description: "The actual value of payload";

package/dist/lib/openapi/spec/update-feature-strategy-segments-schema.d.ts

@@ -0,0 +1,35 @@
+import { FromSchema } from 'json-schema-to-ts';
+export declare const updateFeatureStrategySegmentsSchema: {
+    readonly $id: "#/components/schemas/updateFeatureStrategySegmentsSchema";
+    readonly type: "object";
+    readonly required: readonly ["projectId", "strategyId", "environmentId", "segmentIds"];
+    readonly description: "Data required to update segments for a strategy.";
+    readonly properties: {
+        readonly projectId: {
+            readonly type: "string";
+            readonly description: "The ID of the project that the strategy belongs to.";
+            readonly example: "red-vista";
+        };
+        readonly strategyId: {
+            readonly type: "string";
+            readonly description: "The ID of the strategy to update segments for.";
+            readonly example: "15d1e20b-6310-4e17-a0c2-9fb84de3053a";
+        };
+        readonly environmentId: {
+            readonly type: "string";
+            readonly description: "The ID of the strategy environment.";
+            readonly example: "development";
+        };
+        readonly segmentIds: {
+            readonly type: "array";
+            readonly description: "The new list of segments (IDs) to use for this strategy. Any segments not in this list will be removed from the strategy.";
+            readonly example: readonly [1, 5, 6];
+            readonly items: {
+                readonly type: "integer";
+                readonly minimum: 0;
+            };
+        };
+    };
+    readonly components: {};
+};
+export declare type UpdateFeatureStrategySegmentsSchema = FromSchema<typeof updateFeatureStrategySegmentsSchema>;

package/dist/lib/openapi/spec/update-feature-strategy-segments-schema.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateFeatureStrategySegmentsSchema = void 0;
+exports.updateFeatureStrategySegmentsSchema = {
+    $id: '#/components/schemas/updateFeatureStrategySegmentsSchema',
+    type: 'object',
+    required: ['projectId', 'strategyId', 'environmentId', 'segmentIds'],
+    description: 'Data required to update segments for a strategy.',
+    properties: {
+        projectId: {
+            type: 'string',
+            description: 'The ID of the project that the strategy belongs to.',
+            example: 'red-vista',
+        },
+        strategyId: {
+            type: 'string',
+            description: 'The ID of the strategy to update segments for.',
+            example: '15d1e20b-6310-4e17-a0c2-9fb84de3053a',
+        },
+        environmentId: {
+            type: 'string',
+            description: 'The ID of the strategy environment.',
+            example: 'development',
+        },
+        segmentIds: {
+            type: 'array',
+            description: 'The new list of segments (IDs) to use for this strategy. Any segments not in this list will be removed from the strategy.',
+            example: [1, 5, 6],
+            items: {
+                type: 'integer',
+                minimum: 0,
+            },
+        },
+    },
+    components: {},
+};
+//# sourceMappingURL=update-feature-strategy-segments-schema.js.map

package/dist/lib/openapi/spec/update-feature-strategy-segments-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-feature-strategy-segments-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-feature-strategy-segments-schema.ts"],"names":[],"mappings":";;;AAEa,QAAA,mCAAmC,GAAG;IAC/C,GAAG,EAAE,0DAA0D;IAC/D,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,WAAW,EAAE,YAAY,EAAE,eAAe,EAAE,YAAY,CAAC;IACpE,WAAW,EAAE,kDAAkD;IAC/D,UAAU,EAAE;QACR,SAAS,EAAE;YACP,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qDAAqD;YAClE,OAAO,EAAE,WAAW;SACvB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,gDAAgD;YAC7D,OAAO,EAAE,sCAAsC;SAClD;QACD,aAAa,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,qCAAqC;YAClD,OAAO,EAAE,aAAa;SACzB;QACD,UAAU,EAAE;YACR,IAAI,EAAE,OAAO;YACb,WAAW,EACP,2HAA2H;YAC/H,OAAO,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;YAClB,KAAK,EAAE;gBACH,IAAI,EAAE,SAAS;gBACf,OAAO,EAAE,CAAC;aACb;SACJ;KACJ;IACD,UAAU,EAAE,EAAE;CACR,CAAC"}

package/dist/lib/openapi/spec/update-feature-strategy-segments-schema.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/lib/openapi/spec/update-feature-strategy-segments-schema.test.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const validate_1 = require("../validate");
+test('updateFeatureStrategySegmentsSchema schema', () => {
+    const data = {
+        strategyId: '1',
+        segmentIds: [1, 2],
+        projectId: 'default',
+        environmentId: 'default',
+        additional: 'property',
+    };
+    expect((0, validate_1.validateSchema)('#/components/schemas/updateFeatureStrategySegmentsSchema', data)).toBeUndefined();
+    expect((0, validate_1.validateSchema)('#/components/schemas/updateFeatureStrategySegmentsSchema', {})).toMatchSnapshot();
+    expect((0, validate_1.validateSchema)('#/components/schemas/updateFeatureStrategySegmentsSchema', {
+        strategyId: '1',
+        segmentIds: [],
+    })).toMatchSnapshot();
+});
+//# sourceMappingURL=update-feature-strategy-segments-schema.test.js.map

package/dist/lib/openapi/spec/update-feature-strategy-segments-schema.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"update-feature-strategy-segments-schema.test.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/update-feature-strategy-segments-schema.test.ts"],"names":[],"mappings":";;AAAA,0CAA6C;AAG7C,IAAI,CAAC,4CAA4C,EAAE,GAAG,EAAE;IACpD,MAAM,IAAI,GAAwC;QAC9C,UAAU,EAAE,GAAG;QACf,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAClB,SAAS,EAAE,SAAS;QACpB,aAAa,EAAE,SAAS;QACxB,UAAU,EAAE,UAAU;KACzB,CAAC;IAEF,MAAM,CACF,IAAA,yBAAc,EACV,0DAA0D,EAC1D,IAAI,CACP,CACJ,CAAC,aAAa,EAAE,CAAC;IAElB,MAAM,CACF,IAAA,yBAAc,EACV,0DAA0D,EAC1D,EAAE,CACL,CACJ,CAAC,eAAe,EAAE,CAAC;IAEpB,MAAM,CACF,IAAA,yBAAc,EACV,0DAA0D,EAC1D;QACI,UAAU,EAAE,GAAG;QACf,UAAU,EAAE,EAAE;KACjB,CACJ,CACJ,CAAC,eAAe,EAAE,CAAC;AACxB,CAAC,CAAC,CAAC"}

package/dist/lib/openapi/spec/upsert-segment-schema.d.ts

@@ -2,41 +2,34 @@ import { FromSchema } from 'json-schema-to-ts';
 export declare const upsertSegmentSchema: {
     readonly $id: "#/components/schemas/upsertSegmentSchema";
     readonly type: "object";
-    readonly description: "Represents a segment of users defined by a set of constraints.";
+    readonly description: "Data used to create or update a segment";
     readonly required: readonly ["name", "constraints"];
     readonly properties: {
         readonly name: {
+            readonly description: "The name of the segment";
+            readonly example: "beta-users";
             readonly type: "string";
-            readonly description: "The name of the segment.";
         };
         readonly description: {
             readonly type: "string";
             readonly nullable: true;
-            readonly description: "The description of the segment.";
+            readonly description: "A description of what the segment is for";
+            readonly example: "Users willing to help us test and build new features.";
         };
         readonly project: {
             readonly type: "string";
             readonly nullable: true;
-            readonly description: "Project from where this segment will be accessible. If none is defined the segment will be global (i.e. accessible from any project).";
+            readonly description: "The project the segment belongs to if any.";
+            readonly example: "red-vista";
         };
         readonly constraints: {
             readonly type: "array";
-            readonly description: "List of constraints that determine which users will be part of the segment";
+            readonly description: "The list of constraints that make up this segment";
             readonly items: {
                 readonly $ref: "#/components/schemas/constraintSchema";
             };
         };
     };
-    readonly example: {
-        readonly name: "segment name";
-        readonly description: "segment description";
-        readonly project: "optional project id";
-        readonly constraints: readonly [{
-            readonly contextName: "environment";
-            readonly operator: "IN";
-            readonly values: readonly ["production", "staging"];
-        }];
-    };
     readonly components: {
         readonly schemas: {
             readonly constraintSchema: {

package/dist/lib/openapi/spec/upsert-segment-schema.js

@@ -5,43 +5,34 @@ const constraint_schema_1 = require("./constraint-schema");
 exports.upsertSegmentSchema = {
     $id: '#/components/schemas/upsertSegmentSchema',
     type: 'object',
-    description: 'Represents a segment of users defined by a set of constraints.',
+    description: 'Data used to create or update a segment',
     required: ['name', 'constraints'],
     properties: {
         name: {
+            description: 'The name of the segment',
+            example: 'beta-users',
             type: 'string',
-            description: 'The name of the segment.',
         },
         description: {
             type: 'string',
             nullable: true,
-            description: 'The description of the segment.',
+            description: 'A description of what the segment is for',
+            example: 'Users willing to help us test and build new features.',
         },
         project: {
             type: 'string',
             nullable: true,
-            description: 'Project from where this segment will be accessible. If none is defined the segment will be global (i.e. accessible from any project).',
+            description: 'The project the segment belongs to if any.',
+            example: 'red-vista',
         },
         constraints: {
             type: 'array',
-            description: 'List of constraints that determine which users will be part of the segment',
+            description: 'The list of constraints that make up this segment',
             items: {
                 $ref: '#/components/schemas/constraintSchema',
             },
         },
     },
-    example: {
-        name: 'segment name',
-        description: 'segment description',
-        project: 'optional project id',
-        constraints: [
-            {
-                contextName: 'environment',
-                operator: 'IN',
-                values: ['production', 'staging'],
-            },
-        ],
-    },
     components: {
         schemas: {
             constraintSchema: constraint_schema_1.constraintSchema,

package/dist/lib/openapi/spec/upsert-segment-schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"upsert-segment-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/upsert-segment-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AAE1C,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,WAAW,EACP,gEAAgE;IACpE,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC;IACjC,UAAU,EAAE;QACR,IAAI,EAAE;YACF,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,0BAA0B;SAC1C;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,iCAAiC;SACjD;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EACP,uIAAuI;SAC9I;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,WAAW,EACP,4EAA4E;YAChF,KAAK,EAAE;gBACH,IAAI,EAAE,uCAAuC;aAChD;SACJ;KACJ;IACD,OAAO,EAAE;QACL,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,qBAAqB;QAClC,OAAO,EAAE,qBAAqB;QAC9B,WAAW,EAAE;YACT;gBACI,WAAW,EAAE,aAAa;gBAC1B,QAAQ,EAAE,IAAI;gBACd,MAAM,EAAE,CAAC,YAAY,EAAE,SAAS,CAAC;aACpC;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;SACnB;KACJ;CACK,CAAC"}
+{"version":3,"file":"upsert-segment-schema.js","sourceRoot":"","sources":["../../../../src/lib/openapi/spec/upsert-segment-schema.ts"],"names":[],"mappings":";;;AACA,2DAAuD;AAE1C,QAAA,mBAAmB,GAAG;IAC/B,GAAG,EAAE,0CAA0C;IAC/C,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,yCAAyC;IACtD,QAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC;IACjC,UAAU,EAAE;QACR,IAAI,EAAE;YACF,WAAW,EAAE,yBAAyB;YACtC,OAAO,EAAE,YAAY;YACrB,IAAI,EAAE,QAAQ;SACjB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,0CAA0C;YACvD,OAAO,EAAE,uDAAuD;SACnE;QACD,OAAO,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,4CAA4C;YACzD,OAAO,EAAE,WAAW;SACvB;QACD,WAAW,EAAE;YACT,IAAI,EAAE,OAAO;YACb,WAAW,EAAE,mDAAmD;YAChE,KAAK,EAAE;gBACH,IAAI,EAAE,uCAAuC;aAChD;SACJ;KACJ;IACD,UAAU,EAAE;QACR,OAAO,EAAE;YACL,gBAAgB,EAAhB,oCAAgB;SACnB;KACJ;CACK,CAAC"}

package/dist/lib/openapi/spec/upsert-segment-schema.test.d.ts

@@ -0,0 +1 @@
+export {};