unleash-server 7.2.3 → 7.4.0

package/dist/lib/openapi/spec/release-plan-schema.d.ts

@@ -72,6 +72,13 @@ export declare const releasePlanSchema: {
             readonly example: "01JB9GGTGQYEQ9D40R17T3YVW2";
             readonly nullable: false;
         };
+        readonly safeguards: {
+            readonly type: "array";
+            readonly description: "An array of safeguards configured for this release plan.";
+            readonly items: {
+                readonly $ref: "#/components/schemas/safeguardSchema";
+            };
+        };
     };
     readonly components: {
         readonly schemas: {
@@ -111,8 +118,19 @@ export declare const releasePlanSchema: {
                         readonly nullable: true;
                     };
                     readonly transitionCondition: {
+                        readonly type: "object";
+                        readonly additionalProperties: false;
+                        readonly required: readonly ["intervalMinutes"];
+                        readonly properties: {
+                            readonly intervalMinutes: {
+                                readonly type: "integer";
+                                readonly minimum: 1;
+                                readonly description: "The interval in minutes before transitioning";
+                                readonly example: 30;
+                            };
+                        };
                         readonly description: "The condition configuration for the transition";
-                        readonly $ref: "#/components/schemas/transitionConditionSchema";
+                        readonly nullable: true;
                     };
                     readonly progressionExecutedAt: {
                         readonly type: "string";
@@ -121,6 +139,13 @@ export declare const releasePlanSchema: {
                         readonly example: "2024-01-01T00:00:00.000Z";
                         readonly nullable: true;
                     };
+                    readonly pausedAt: {
+                        readonly type: "string";
+                        readonly format: "date-time";
+                        readonly description: "The date and time when the milestone was paused.";
+                        readonly example: "2024-01-01T00:00:00.000Z";
+                        readonly nullable: true;
+                    };
                     readonly strategies: {
                         readonly type: "array";
                         readonly description: "A list of strategies that are attached to this milestone.";
@@ -176,7 +201,7 @@ export declare const releasePlanSchema: {
                                 };
                                 readonly constraints: {
                                     readonly type: "array";
-                                    readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/activation-strategies#constraints";
+                                    readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/concepts/activation-strategies#constraints";
                                     readonly example: readonly [{
                                         readonly values: readonly ["1", "2"];
                                         readonly inverted: false;
@@ -236,7 +261,7 @@ export declare const releasePlanSchema: {
                                             };
                                             readonly constraints: {
                                                 readonly type: "array";
-                                                readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/activation-strategies#constraints";
+                                                readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/concepts/activation-strategies#constraints";
                                                 readonly example: readonly [{
                                                     readonly values: readonly ["1", "2"];
                                                     readonly inverted: false;
@@ -278,7 +303,7 @@ export declare const releasePlanSchema: {
                                                 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/activation-strategies#constraints)";
+                                                    readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/concepts/activation-strategies#constraints)";
                                                     readonly properties: {
                                                         readonly contextName: {
                                                             readonly description: "The name of the context field that this constraint should apply to.";
@@ -286,7 +311,7 @@ export declare const releasePlanSchema: {
                                                             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/activation-strategies#constraint-operators).";
+                                                            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/concepts/activation-strategies#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";
@@ -341,19 +366,19 @@ export declare const releasePlanSchema: {
                                                         };
                                                         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 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/concepts/feature-flag-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 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/concepts/feature-flag-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 description: "The [stickiness](https://docs.getunleash.io/concepts/feature-flag-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: {
@@ -394,7 +419,7 @@ export declare const releasePlanSchema: {
                                     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/activation-strategies#constraints)";
+                                        readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/concepts/activation-strategies#constraints)";
                                         readonly properties: {
                                             readonly contextName: {
                                                 readonly description: "The name of the context field that this constraint should apply to.";
@@ -402,7 +427,7 @@ export declare const releasePlanSchema: {
                                                 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/activation-strategies#constraint-operators).";
+                                                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/concepts/activation-strategies#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";
@@ -448,19 +473,19 @@ export declare const releasePlanSchema: {
                                             };
                                             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 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/concepts/feature-flag-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 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/concepts/feature-flag-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 description: "The [stickiness](https://docs.getunleash.io/concepts/feature-flag-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: {
@@ -519,7 +544,7 @@ export declare const releasePlanSchema: {
                                 };
                                 readonly constraints: {
                                     readonly type: "array";
-                                    readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/activation-strategies#constraints";
+                                    readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/concepts/activation-strategies#constraints";
                                     readonly example: readonly [{
                                         readonly values: readonly ["1", "2"];
                                         readonly inverted: false;
@@ -561,7 +586,7 @@ export declare const releasePlanSchema: {
                                     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/activation-strategies#constraints)";
+                                        readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/concepts/activation-strategies#constraints)";
                                         readonly properties: {
                                             readonly contextName: {
                                                 readonly description: "The name of the context field that this constraint should apply to.";
@@ -569,7 +594,7 @@ export declare const releasePlanSchema: {
                                                 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/activation-strategies#constraint-operators).";
+                                                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/concepts/activation-strategies#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";
@@ -624,19 +649,19 @@ export declare const releasePlanSchema: {
                                             };
                                             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 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/concepts/feature-flag-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 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/concepts/feature-flag-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 description: "The [stickiness](https://docs.getunleash.io/concepts/feature-flag-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: {
@@ -677,7 +702,7 @@ export declare const releasePlanSchema: {
                         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/activation-strategies#constraints)";
+                            readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/concepts/activation-strategies#constraints)";
                             readonly properties: {
                                 readonly contextName: {
                                     readonly description: "The name of the context field that this constraint should apply to.";
@@ -685,7 +710,7 @@ export declare const releasePlanSchema: {
                                     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/activation-strategies#constraint-operators).";
+                                    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/concepts/activation-strategies#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";
@@ -731,19 +756,19 @@ export declare const releasePlanSchema: {
                                 };
                                 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 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/concepts/feature-flag-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 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/concepts/feature-flag-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 description: "The [stickiness](https://docs.getunleash.io/concepts/feature-flag-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: {
@@ -833,7 +858,7 @@ export declare const releasePlanSchema: {
                     };
                     readonly constraints: {
                         readonly type: "array";
-                        readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/activation-strategies#constraints";
+                        readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/concepts/activation-strategies#constraints";
                         readonly example: readonly [{
                             readonly values: readonly ["1", "2"];
                             readonly inverted: false;
@@ -893,7 +918,7 @@ export declare const releasePlanSchema: {
                                 };
                                 readonly constraints: {
                                     readonly type: "array";
-                                    readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/activation-strategies#constraints";
+                                    readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/concepts/activation-strategies#constraints";
                                     readonly example: readonly [{
                                         readonly values: readonly ["1", "2"];
                                         readonly inverted: false;
@@ -935,7 +960,7 @@ export declare const releasePlanSchema: {
                                     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/activation-strategies#constraints)";
+                                        readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/concepts/activation-strategies#constraints)";
                                         readonly properties: {
                                             readonly contextName: {
                                                 readonly description: "The name of the context field that this constraint should apply to.";
@@ -943,7 +968,7 @@ export declare const releasePlanSchema: {
                                                 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/activation-strategies#constraint-operators).";
+                                                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/concepts/activation-strategies#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";
@@ -998,19 +1023,19 @@ export declare const releasePlanSchema: {
                                             };
                                             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 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/concepts/feature-flag-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 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/concepts/feature-flag-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 description: "The [stickiness](https://docs.getunleash.io/concepts/feature-flag-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: {
@@ -1051,7 +1076,7 @@ export declare const releasePlanSchema: {
                         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/activation-strategies#constraints)";
+                            readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/concepts/activation-strategies#constraints)";
                             readonly properties: {
                                 readonly contextName: {
                                     readonly description: "The name of the context field that this constraint should apply to.";
@@ -1059,7 +1084,7 @@ export declare const releasePlanSchema: {
                                     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/activation-strategies#constraint-operators).";
+                                    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/concepts/activation-strategies#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";
@@ -1105,19 +1130,19 @@ export declare const releasePlanSchema: {
                                 };
                                 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 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/concepts/feature-flag-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 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/concepts/feature-flag-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 description: "The [stickiness](https://docs.getunleash.io/concepts/feature-flag-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: {
@@ -1176,7 +1201,7 @@ export declare const releasePlanSchema: {
                     };
                     readonly constraints: {
                         readonly type: "array";
-                        readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/reference/activation-strategies#constraints";
+                        readonly description: "A list of the constraints attached to the strategy. See https://docs.getunleash.io/concepts/activation-strategies#constraints";
                         readonly example: readonly [{
                             readonly values: readonly ["1", "2"];
                             readonly inverted: false;
@@ -1218,7 +1243,7 @@ export declare const releasePlanSchema: {
                         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/activation-strategies#constraints)";
+                            readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/concepts/activation-strategies#constraints)";
                             readonly properties: {
                                 readonly contextName: {
                                     readonly description: "The name of the context field that this constraint should apply to.";
@@ -1226,7 +1251,7 @@ export declare const releasePlanSchema: {
                                     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/activation-strategies#constraint-operators).";
+                                    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/concepts/activation-strategies#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";
@@ -1281,19 +1306,19 @@ export declare const releasePlanSchema: {
                                 };
                                 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 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/concepts/feature-flag-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 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/concepts/feature-flag-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 description: "The [stickiness](https://docs.getunleash.io/concepts/feature-flag-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: {
@@ -1334,7 +1359,7 @@ export declare const releasePlanSchema: {
             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/activation-strategies#constraints)";
+                readonly description: "A strategy constraint. For more information, refer to [the strategy constraint reference documentation](https://docs.getunleash.io/concepts/activation-strategies#constraints)";
                 readonly properties: {
                     readonly contextName: {
                         readonly description: "The name of the context field that this constraint should apply to.";
@@ -1342,7 +1367,7 @@ export declare const releasePlanSchema: {
                         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/activation-strategies#constraint-operators).";
+                        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/concepts/activation-strategies#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";
@@ -1388,19 +1413,19 @@ export declare const releasePlanSchema: {
                     };
                     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 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/concepts/feature-flag-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 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/concepts/feature-flag-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 description: "The [stickiness](https://docs.getunleash.io/concepts/feature-flag-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: {
@@ -1442,8 +1467,218 @@ export declare const releasePlanSchema: {
                 };
                 readonly components: {};
             };
+            readonly safeguardSchema: {
+                readonly $id: "#/components/schemas/safeguardSchema";
+                readonly type: "object";
+                readonly required: readonly ["id", "action", "triggerCondition", "impactMetric"];
+                readonly description: "A safeguard configuration for a release plan.";
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly id: {
+                        readonly type: "string";
+                        readonly description: "The unique ULID identifier for this safeguard";
+                        readonly example: "01JB9GGTGQYEQ9D40R17T3YVW1";
+                    };
+                    readonly action: {
+                        readonly type: "object";
+                        readonly required: readonly ["type", "id"];
+                        readonly additionalProperties: false;
+                        readonly description: "The action to take when the safeguard is triggered.";
+                        readonly properties: {
+                            readonly type: {
+                                readonly type: "string";
+                                readonly description: "The type of action to perform.";
+                                readonly example: "pauseReleasePlanProgressions";
+                            };
+                            readonly id: {
+                                readonly type: "string";
+                                readonly description: "The ID of the release plan this safeguard applies to.";
+                                readonly example: "01JB9GGTGQYEQ9D40R17T3YVW2";
+                            };
+                        };
+                    };
+                    readonly triggerCondition: {
+                        readonly $ref: "#/components/schemas/safeguardTriggerConditionSchema";
+                        readonly description: "The condition that triggers the safeguard.";
+                    };
+                    readonly impactMetric: {
+                        readonly type: "object";
+                        readonly required: readonly ["id", "metricName", "timeRange", "aggregationMode", "labelSelectors"];
+                        readonly additionalProperties: false;
+                        readonly properties: {
+                            readonly metricName: {
+                                readonly type: "string";
+                                readonly description: "The Prometheus metric series to query. It includes both unleash prefix and metric type and display name";
+                                readonly example: "unleash_counter_feature_toggle_usage_total";
+                            };
+                            readonly timeRange: {
+                                readonly type: "string";
+                                readonly enum: readonly ["hour", "day", "week", "month"];
+                                readonly description: "The time range for the metric data.";
+                                readonly example: "day";
+                            };
+                            readonly aggregationMode: {
+                                readonly type: "string";
+                                readonly description: "The aggregation mode for the metric data.";
+                                readonly enum: readonly ["rps", "count", "avg", "sum", "p95", "p99", "p50"];
+                                readonly example: "rps";
+                            };
+                            readonly labelSelectors: {
+                                readonly type: "object";
+                                readonly additionalProperties: {
+                                    readonly type: "array";
+                                    readonly items: {
+                                        readonly type: "string";
+                                    };
+                                };
+                                readonly description: "The selected labels and their values for filtering the metric data.";
+                                readonly example: {
+                                    readonly environment: readonly ["development"];
+                                    readonly project: readonly ["default"];
+                                };
+                            };
+                            readonly id: {
+                                readonly type: "string";
+                                readonly description: "The unique identifier for this impact metric";
+                                readonly example: "01JB9GGTGQYEQ9D40R17T3YVW1";
+                            };
+                        };
+                        readonly description: "The metric configuration used to evaluate the safeguard condition.";
+                    };
+                };
+                readonly components: {
+                    readonly schemas: {
+                        readonly metricQuerySchema: {
+                            readonly $id: "#/components/schemas/metricQuerySchema";
+                            readonly type: "object";
+                            readonly required: readonly ["metricName", "timeRange", "aggregationMode", "labelSelectors"];
+                            readonly description: "Common metric query configuration for selecting and filtering metric data.";
+                            readonly additionalProperties: false;
+                            readonly properties: {
+                                readonly metricName: {
+                                    readonly type: "string";
+                                    readonly description: "The Prometheus metric series to query. It includes both unleash prefix and metric type and display name";
+                                    readonly example: "unleash_counter_feature_toggle_usage_total";
+                                };
+                                readonly timeRange: {
+                                    readonly type: "string";
+                                    readonly enum: readonly ["hour", "day", "week", "month"];
+                                    readonly description: "The time range for the metric data.";
+                                    readonly example: "day";
+                                };
+                                readonly aggregationMode: {
+                                    readonly type: "string";
+                                    readonly description: "The aggregation mode for the metric data.";
+                                    readonly enum: readonly ["rps", "count", "avg", "sum", "p95", "p99", "p50"];
+                                    readonly example: "rps";
+                                };
+                                readonly labelSelectors: {
+                                    readonly type: "object";
+                                    readonly additionalProperties: {
+                                        readonly type: "array";
+                                        readonly items: {
+                                            readonly type: "string";
+                                        };
+                                    };
+                                    readonly description: "The selected labels and their values for filtering the metric data.";
+                                    readonly example: {
+                                        readonly environment: readonly ["development"];
+                                        readonly project: readonly ["default"];
+                                    };
+                                };
+                            };
+                            readonly components: {};
+                        };
+                        readonly safeguardTriggerConditionSchema: {
+                            readonly $id: "#/components/schemas/safeguardTriggerConditionSchema";
+                            readonly type: "object";
+                            readonly required: readonly ["operator", "threshold"];
+                            readonly additionalProperties: false;
+                            readonly description: "The condition that triggers the safeguard.";
+                            readonly properties: {
+                                readonly operator: {
+                                    readonly type: "string";
+                                    readonly enum: readonly [">", "<"];
+                                    readonly description: "The comparison operator for the threshold check.";
+                                    readonly example: ">";
+                                };
+                                readonly threshold: {
+                                    readonly type: "number";
+                                    readonly description: "The threshold value to compare against.";
+                                    readonly example: 100;
+                                };
+                            };
+                            readonly components: {};
+                        };
+                    };
+                };
+            };
+            readonly metricQuerySchema: {
+                readonly $id: "#/components/schemas/metricQuerySchema";
+                readonly type: "object";
+                readonly required: readonly ["metricName", "timeRange", "aggregationMode", "labelSelectors"];
+                readonly description: "Common metric query configuration for selecting and filtering metric data.";
+                readonly additionalProperties: false;
+                readonly properties: {
+                    readonly metricName: {
+                        readonly type: "string";
+                        readonly description: "The Prometheus metric series to query. It includes both unleash prefix and metric type and display name";
+                        readonly example: "unleash_counter_feature_toggle_usage_total";
+                    };
+                    readonly timeRange: {
+                        readonly type: "string";
+                        readonly enum: readonly ["hour", "day", "week", "month"];
+                        readonly description: "The time range for the metric data.";
+                        readonly example: "day";
+                    };
+                    readonly aggregationMode: {
+                        readonly type: "string";
+                        readonly description: "The aggregation mode for the metric data.";
+                        readonly enum: readonly ["rps", "count", "avg", "sum", "p95", "p99", "p50"];
+                        readonly example: "rps";
+                    };
+                    readonly labelSelectors: {
+                        readonly type: "object";
+                        readonly additionalProperties: {
+                            readonly type: "array";
+                            readonly items: {
+                                readonly type: "string";
+                            };
+                        };
+                        readonly description: "The selected labels and their values for filtering the metric data.";
+                        readonly example: {
+                            readonly environment: readonly ["development"];
+                            readonly project: readonly ["default"];
+                        };
+                    };
+                };
+                readonly components: {};
+            };
+            readonly safeguardTriggerConditionSchema: {
+                readonly $id: "#/components/schemas/safeguardTriggerConditionSchema";
+                readonly type: "object";
+                readonly required: readonly ["operator", "threshold"];
+                readonly additionalProperties: false;
+                readonly description: "The condition that triggers the safeguard.";
+                readonly properties: {
+                    readonly operator: {
+                        readonly type: "string";
+                        readonly enum: readonly [">", "<"];
+                        readonly description: "The comparison operator for the threshold check.";
+                        readonly example: ">";
+                    };
+                    readonly threshold: {
+                        readonly type: "number";
+                        readonly description: "The threshold value to compare against.";
+                        readonly example: 100;
+                    };
+                };
+                readonly components: {};
+            };
         };
     };
 };
-export type ReleasePlanSchema = FromSchema<typeof releasePlanSchema>;
+export type ReleasePlanSchema = FromSchema<typeof releasePlanSchema, {
+    keepDefaultedPropertiesOptional: true;
+}>;
 //# sourceMappingURL=release-plan-schema.d.ts.map