From 876ab80667c01f8766e6cb7d4466049edece8b13 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 25 Sep 2024 16:36:58 -0700 Subject: [PATCH] Edit descriptions for alerting rule API examples --- oas_docs/examples/create_es_query_esql_rule_request.yaml | 4 +++- oas_docs/examples/create_es_query_esql_rule_response.yaml | 3 ++- oas_docs/examples/create_es_query_kql_rule_request.yaml | 3 ++- oas_docs/examples/create_es_query_kql_rule_response.yaml | 3 ++- oas_docs/examples/create_es_query_rule_request.yaml | 4 +++- oas_docs/examples/create_es_query_rule_response.yaml | 3 ++- oas_docs/examples/create_index_threshold_rule_request.yaml | 4 +++- oas_docs/examples/create_index_threshold_rule_response.yaml | 3 ++- .../examples/create_tracking_containment_rule_request.yaml | 4 +++- .../examples/create_tracking_containment_rule_response.yaml | 3 ++- oas_docs/examples/find_rules_response.yaml | 3 ++- oas_docs/examples/find_rules_response_conditional_action.yaml | 3 ++- oas_docs/examples/update_rule_request.yaml | 3 ++- oas_docs/examples/update_rule_response.yaml | 3 ++- 14 files changed, 32 insertions(+), 14 deletions(-) diff --git a/oas_docs/examples/create_es_query_esql_rule_request.yaml b/oas_docs/examples/create_es_query_esql_rule_request.yaml index 874f5f96b1f8d..0646699e8a41a 100644 --- a/oas_docs/examples/create_es_query_esql_rule_request.yaml +++ b/oas_docs/examples/create_es_query_esql_rule_request.yaml @@ -1,4 +1,6 @@ -summary: Create an Elasticsearch query rule that uses Elasticsearch Query Language (ES|QL). +summary: Elasticsearch query rule (ES|QL) +description: > + Create an Elasticsearch query rule that uses Elasticsearch Query Language (ES|QL) to define its query and a server log connector to send notifications. value: name: my Elasticsearch query ESQL rule params: diff --git a/oas_docs/examples/create_es_query_esql_rule_response.yaml b/oas_docs/examples/create_es_query_esql_rule_response.yaml index 2a0e786d5f52b..fa4ebd0977674 100644 --- a/oas_docs/examples/create_es_query_esql_rule_response.yaml +++ b/oas_docs/examples/create_es_query_esql_rule_response.yaml @@ -1,4 +1,5 @@ -summary: The create rule API returns a JSON object that contains details about the rule. +summary: Elasticsearch query rule (ES|QL) +description: The response for successfully creating an Elasticsearch query rule that uses Elasticsearch Query Language (ES|QL). value: id: e0d62360-78e8-11ee-9177-f7d404c8c945 enabled: true diff --git a/oas_docs/examples/create_es_query_kql_rule_request.yaml b/oas_docs/examples/create_es_query_kql_rule_request.yaml index e505fd8964463..8b9af0129912e 100644 --- a/oas_docs/examples/create_es_query_kql_rule_request.yaml +++ b/oas_docs/examples/create_es_query_kql_rule_request.yaml @@ -1,4 +1,5 @@ -summary: Create an Elasticsearch query rule that uses Kibana query language (KQL). +summary: Elasticsearch query rule (KQL) +description: Create an Elasticsearch query rule that uses Kibana query language (KQL). value: consumer: alerts name: my Elasticsearch query KQL rule diff --git a/oas_docs/examples/create_es_query_kql_rule_response.yaml b/oas_docs/examples/create_es_query_kql_rule_response.yaml index 0a30c4e6dd41e..4ecaf503e082c 100644 --- a/oas_docs/examples/create_es_query_kql_rule_response.yaml +++ b/oas_docs/examples/create_es_query_kql_rule_response.yaml @@ -1,4 +1,5 @@ -summary: The create rule API returns a JSON object that contains details about the rule. +summary: Elasticsearch query rule (KQL) +description: The response for successfully creating an Elasticsearch query rule that uses Kibana query language (KQL). value: id: 7bd506d0-2284-11ee-8fad-6101956ced88 enabled: true diff --git a/oas_docs/examples/create_es_query_rule_request.yaml b/oas_docs/examples/create_es_query_rule_request.yaml index bff7a8f0bd8f6..d021245ed7dff 100644 --- a/oas_docs/examples/create_es_query_rule_request.yaml +++ b/oas_docs/examples/create_es_query_rule_request.yaml @@ -1,4 +1,6 @@ -summary: Create an Elasticsearch query rule that uses Elasticsearch query domain specific language (DSL) to define its query and a server log connector to send notifications. +summary: Elasticsearch query rule (DSL) +description: > + Create an Elasticsearch query rule that uses Elasticsearch query domain specific language (DSL) to define its query and a server log connector to send notifications. value: actions: - group: query matched diff --git a/oas_docs/examples/create_es_query_rule_response.yaml b/oas_docs/examples/create_es_query_rule_response.yaml index 9601843a42e3b..81a634959ca3c 100644 --- a/oas_docs/examples/create_es_query_rule_response.yaml +++ b/oas_docs/examples/create_es_query_rule_response.yaml @@ -1,4 +1,5 @@ -summary: The create rule API returns a JSON object that contains details about the rule. +summary: Elasticsearch query rule (DSL) +description: The response for successfully creating an Elasticsearch query rule that uses Elasticsearch query domain specific language (DSL). value: id: 58148c70-407f-11ee-850e-c71febc4ca7f enabled: true diff --git a/oas_docs/examples/create_index_threshold_rule_request.yaml b/oas_docs/examples/create_index_threshold_rule_request.yaml index 53859628f57a1..146b0cff7d32b 100644 --- a/oas_docs/examples/create_index_threshold_rule_request.yaml +++ b/oas_docs/examples/create_index_threshold_rule_request.yaml @@ -1,4 +1,6 @@ -summary: Create an index threshold rule. +summary: Index threshold rule +description: > + Create an index threshold rule that uses a server log connector to send notifications when the threshold is met. value: actions: - id: 48de3460-f401-11ed-9f8e-399c75a2deeb diff --git a/oas_docs/examples/create_index_threshold_rule_response.yaml b/oas_docs/examples/create_index_threshold_rule_response.yaml index da172f5df9ff7..00de25aa06763 100644 --- a/oas_docs/examples/create_index_threshold_rule_response.yaml +++ b/oas_docs/examples/create_index_threshold_rule_response.yaml @@ -1,4 +1,5 @@ -summary: The create rule API returns a JSON object that contains details about the rule. +summary: Index threshold rule +description: The response for successfully creating an index threshold rule. value: actions: - group: threshold met diff --git a/oas_docs/examples/create_tracking_containment_rule_request.yaml b/oas_docs/examples/create_tracking_containment_rule_request.yaml index 2e474b59bbb1b..3a20a0bbe804a 100644 --- a/oas_docs/examples/create_tracking_containment_rule_request.yaml +++ b/oas_docs/examples/create_tracking_containment_rule_request.yaml @@ -1,4 +1,6 @@ -summary: Create a tracking containment rule. +summary: Tracking containment rule +description: > + Create a tracking containment rule that checks when an entity is contained or no longer contained within a boundary. value: consumer: alerts name: my tracking rule diff --git a/oas_docs/examples/create_tracking_containment_rule_response.yaml b/oas_docs/examples/create_tracking_containment_rule_response.yaml index c7d927ab2f1e4..e68d2a484afc7 100644 --- a/oas_docs/examples/create_tracking_containment_rule_response.yaml +++ b/oas_docs/examples/create_tracking_containment_rule_response.yaml @@ -1,4 +1,5 @@ -summary: The create rule API returns a JSON object that contains details about the rule. +summary: Tracking containment rule +description: The response for successfully creating a tracking containment rule. value: id: b6883f9d-5f70-4758-a66e-369d7c26012f name: my tracking rule diff --git a/oas_docs/examples/find_rules_response.yaml b/oas_docs/examples/find_rules_response.yaml index b6af1580d8e40..81ba04239d22a 100644 --- a/oas_docs/examples/find_rules_response.yaml +++ b/oas_docs/examples/find_rules_response.yaml @@ -1,4 +1,5 @@ -summary: Retrieve information about a rule. +summary: Index threshold rule +description: A response that contains information about an index threshold rule. value: page: 1 total: 1 diff --git a/oas_docs/examples/find_rules_response_conditional_action.yaml b/oas_docs/examples/find_rules_response_conditional_action.yaml index 857153be8fa38..cdbab5693e781 100644 --- a/oas_docs/examples/find_rules_response_conditional_action.yaml +++ b/oas_docs/examples/find_rules_response_conditional_action.yaml @@ -1,4 +1,5 @@ -summary: Retrieve information about a rule that has conditional actions. +summary: Security rule +description: A response that contains information about a security rule that has conditional actions. value: page: 1 total: 1 diff --git a/oas_docs/examples/update_rule_request.yaml b/oas_docs/examples/update_rule_request.yaml index bc5411bdaf023..0dcb976af993b 100644 --- a/oas_docs/examples/update_rule_request.yaml +++ b/oas_docs/examples/update_rule_request.yaml @@ -1,4 +1,5 @@ -summary: Update an index threshold rule. +summary: Index threshold rule +description: Update an index threshold rule that uses a server log connector to send notifications when the threshold is met. value: actions: - frequency: diff --git a/oas_docs/examples/update_rule_response.yaml b/oas_docs/examples/update_rule_response.yaml index e9d103bbd5495..b2a95ab870003 100644 --- a/oas_docs/examples/update_rule_response.yaml +++ b/oas_docs/examples/update_rule_response.yaml @@ -1,4 +1,5 @@ -summary: The update rule API returns a JSON object that contains details about the rule. +summary: Index threshold rule +description: The response for successfully updating an index threshold rule. value: id: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74 consumer: alerts