From 048228c8567d836bc90871ed316074451e142a37 Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 6 Nov 2023 15:28:53 -0800 Subject: [PATCH] [OAS] Add description for has_fields_for_a_a_d in rule APIs --- x-pack/plugins/alerting/docs/openapi/bundled.json | 3 ++- x-pack/plugins/alerting/docs/openapi/bundled.yaml | 2 ++ .../openapi/paths/s@{spaceid}@api@alerting@rule_types.yaml | 4 ++++ 3 files changed, 8 insertions(+), 1 deletion(-) diff --git a/x-pack/plugins/alerting/docs/openapi/bundled.json b/x-pack/plugins/alerting/docs/openapi/bundled.json index 6e09c658ae407..a326ce0b502fa 100644 --- a/x-pack/plugins/alerting/docs/openapi/bundled.json +++ b/x-pack/plugins/alerting/docs/openapi/bundled.json @@ -1017,7 +1017,8 @@ "type": "boolean" }, "has_fields_for_a_a_d": { - "type": "boolean" + "type": "boolean", + "description": "Indicates whether the rule has fields for alerts as data. This property is specific to Observability rule types. It affects whether the rule supports actions that run only when an alert matches a KQL query.\n" }, "id": { "description": "The unique identifier for the rule type.", diff --git a/x-pack/plugins/alerting/docs/openapi/bundled.yaml b/x-pack/plugins/alerting/docs/openapi/bundled.yaml index 424326e12c8f6..17458dd37dfaf 100644 --- a/x-pack/plugins/alerting/docs/openapi/bundled.yaml +++ b/x-pack/plugins/alerting/docs/openapi/bundled.yaml @@ -653,6 +653,8 @@ paths: type: boolean has_fields_for_a_a_d: type: boolean + description: | + Indicates whether the rule has fields for alerts as data. This property is specific to Observability rule types. It affects whether the rule supports actions that run only when an alert matches a KQL query. id: description: The unique identifier for the rule type. type: string diff --git a/x-pack/plugins/alerting/docs/openapi/paths/s@{spaceid}@api@alerting@rule_types.yaml b/x-pack/plugins/alerting/docs/openapi/paths/s@{spaceid}@api@alerting@rule_types.yaml index 1dba3e085e2b7..cc94b9669c1f5 100644 --- a/x-pack/plugins/alerting/docs/openapi/paths/s@{spaceid}@api@alerting@rule_types.yaml +++ b/x-pack/plugins/alerting/docs/openapi/paths/s@{spaceid}@api@alerting@rule_types.yaml @@ -177,6 +177,10 @@ get: type: boolean has_fields_for_a_a_d: type: boolean + description: > + Indicates whether the rule has fields for alerts as data. + This property is specific to Observability rule types. + It affects whether the rule supports actions that run only when an alert matches a KQL query. id: description: The unique identifier for the rule type. type: string