[OAS] Add alert_delay alerting rule option for Stack and Observabilit…

…y rules (elastic#176941)
fkanout · Mar 4, 2024 · 9f41012 · 9f41012
1 parent 6e17a8d
commit 9f41012
Show file tree

Hide file tree

Showing 26 changed files with 194 additions and 0 deletions.
diff --git a/x-pack/plugins/alerting/docs/openapi/bundled.json b/x-pack/plugins/alerting/docs/openapi/bundled.json
@@ -2592,6 +2592,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -2642,6 +2645,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -2692,6 +2698,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -2740,6 +2749,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -2788,6 +2800,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -2836,6 +2851,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -2884,6 +2902,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -2932,6 +2953,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -2982,6 +3006,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -3030,6 +3057,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -3077,6 +3107,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -3127,6 +3160,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -3225,6 +3261,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -4322,6 +4361,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -4370,6 +4412,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -4420,6 +4465,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -4517,6 +4565,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -4567,6 +4618,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -4617,6 +4671,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "consumer": {
             "$ref": "#/components/schemas/consumer"
           },
@@ -4872,6 +4929,20 @@
           }
         }
       },
+      "alert_delay": {
+        "type": "object",
+        "description": "Indicates that an alert occurs only when the specified number of consecutive runs met the rule conditions.",
+        "required": [
+          "active"
+        ],
+        "properties": {
+          "active": {
+            "type": "number",
+            "description": "The number of consecutive runs that must meet the rule conditions.",
+            "example": 3
+          }
+        }
+      },
       "consumer": {
         "type": "string",
         "description": "The name of the application or feature that owns the rule. For example: `alerts`, `apm`, `discover`, `infrastructure`, `logs`, `metrics`, `ml`, `monitoring`, `securitySolution`, `siem`, `stackAlerts`, or `uptime`.\n"
@@ -6566,6 +6637,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "api_key_created_by_user": {
             "type": "boolean",
             "description": "Indicates whether the API key that is associated with the rule was created by the user.",
@@ -6857,6 +6931,9 @@
           "actions": {
             "$ref": "#/components/schemas/actions"
           },
+          "alert_delay": {
+            "$ref": "#/components/schemas/alert_delay"
+          },
           "name": {
             "type": "string",
             "description": "The name of the rule.",
@@ -7254,6 +7331,9 @@
               }
             }
           ],
+          "alert_delay": {
+            "active": 3
+          },
           "consumer": "alerts",
           "name": "my rule",
           "params": {
@@ -7500,6 +7580,9 @@
               }
             }
           ],
+          "alert_delay": {
+            "active": 3
+          },
           "api_key_created_by_user": false,
           "api_key_owner": "elastic",
           "consumer": "alerts",