[OAS] Add description for has_fields_for_a_a_d in rule APIs

elastic · Nov 6, 2023 · 048228c · 048228c
1 parent 002e685
commit 048228c
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git 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
@@ -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
@@ -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