From 3a68f92b6f67239aa5dcb96034eab30681ec0084 Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 5 Dec 2024 10:56:28 -0800 Subject: [PATCH] [DOCS] Adds EQL operation summaries (#3207) (#3253) (cherry picked from commit 9f6c82cd8292e7d8701e3297be14de48bd9b2536) --- output/openapi/elasticsearch-openapi.json | 22 +++++++++++----- .../elasticsearch-serverless-openapi.json | 22 +++++++++++----- output/schema/schema.json | 26 ++++++++++--------- specification/eql/delete/EqlDeleteRequest.ts | 3 ++- specification/eql/get/EqlGetRequest.ts | 3 ++- .../eql/get_status/EqlGetStatusRequest.ts | 3 ++- specification/eql/search/EqlSearchRequest.ts | 4 +++ 7 files changed, 56 insertions(+), 27 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 3e158f92a4..314555fec3 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -7495,7 +7495,8 @@ "tags": [ "eql" ], - "summary": "Returns the current status and available results for an async EQL search or a stored synchronous EQL search", + "summary": "Get async EQL search results", + "description": "Get the current status and available results for an async EQL search or a stored synchronous EQL search.", "operationId": "eql-get", "parameters": [ { @@ -7548,8 +7549,8 @@ "tags": [ "eql" ], - "summary": "Deletes an async EQL search or a stored synchronous EQL search", - "description": "The API also deletes results for the search.", + "summary": "Delete an async EQL search", + "description": "Delete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", "operationId": "eql-delete", "parameters": [ { @@ -7584,7 +7585,8 @@ "tags": [ "eql" ], - "summary": "Returns the current status for an async EQL search or a stored synchronous EQL search without returning results", + "summary": "Get the async EQL status", + "description": "Get the current status for an async EQL search or a stored synchronous EQL search without returning results.", "operationId": "eql-get-status", "parameters": [ { @@ -7647,7 +7649,11 @@ "tags": [ "eql" ], - "summary": "Returns results matching a query expressed in Event Query Language (EQL)", + "summary": "Get EQL search results", + "description": "Returns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html" + }, "operationId": "eql-search", "parameters": [ { @@ -7686,7 +7692,11 @@ "tags": [ "eql" ], - "summary": "Returns results matching a query expressed in Event Query Language (EQL)", + "summary": "Get EQL search results", + "description": "Returns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html" + }, "operationId": "eql-search-1", "parameters": [ { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index c8ef4cfb0b..b12af8b18a 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -4795,7 +4795,8 @@ "tags": [ "eql" ], - "summary": "Returns the current status and available results for an async EQL search or a stored synchronous EQL search", + "summary": "Get async EQL search results", + "description": "Get the current status and available results for an async EQL search or a stored synchronous EQL search.", "operationId": "eql-get", "parameters": [ { @@ -4848,8 +4849,8 @@ "tags": [ "eql" ], - "summary": "Deletes an async EQL search or a stored synchronous EQL search", - "description": "The API also deletes results for the search.", + "summary": "Delete an async EQL search", + "description": "Delete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", "operationId": "eql-delete", "parameters": [ { @@ -4884,7 +4885,8 @@ "tags": [ "eql" ], - "summary": "Returns the current status for an async EQL search or a stored synchronous EQL search without returning results", + "summary": "Get the async EQL status", + "description": "Get the current status for an async EQL search or a stored synchronous EQL search without returning results.", "operationId": "eql-get-status", "parameters": [ { @@ -4947,7 +4949,11 @@ "tags": [ "eql" ], - "summary": "Returns results matching a query expressed in Event Query Language (EQL)", + "summary": "Get EQL search results", + "description": "Returns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html" + }, "operationId": "eql-search", "parameters": [ { @@ -4986,7 +4992,11 @@ "tags": [ "eql" ], - "summary": "Returns results matching a query expressed in Event Query Language (EQL)", + "summary": "Get EQL search results", + "description": "Returns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", + "externalDocs": { + "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql.html" + }, "operationId": "eql-search-1", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index 2939998cb2..78d82a1bb5 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -4606,7 +4606,7 @@ "stability": "stable" } }, - "description": "Deletes an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", + "description": "Delete an async EQL search.\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", "name": "eql.delete", "request": { @@ -4641,7 +4641,7 @@ "stability": "stable" } }, - "description": "Returns the current status and available results for an async EQL search or a stored synchronous EQL search.", + "description": "Get async EQL search results.\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", "docId": "eql-async-search-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html", "name": "eql.get", @@ -4677,7 +4677,7 @@ "stability": "stable" } }, - "description": "Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.", + "description": "Get the async EQL status.\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", "docId": "eql-async-search-status-api", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html", "name": "eql.get_status", @@ -4713,8 +4713,10 @@ "stability": "stable" } }, - "description": "Returns results matching a query expressed in Event Query Language (EQL)", + "description": "Get EQL search results.\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html", + "extDocId": "eql", + "extDocUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql.html", "name": "eql.search", "request": { "name": "Request", @@ -117110,7 +117112,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", + "description": "Delete an async EQL search.\nDelete an async EQL search or a stored synchronous EQL search.\nThe API also deletes results for the search.", "inherits": { "type": { "name": "RequestBase", @@ -117136,7 +117138,7 @@ } ], "query": [], - "specLocation": "eql/delete/EqlDeleteRequest.ts#L23-L39" + "specLocation": "eql/delete/EqlDeleteRequest.ts#L23-L40" }, { "kind": "response", @@ -117164,7 +117166,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the current status and available results for an async EQL search or a stored synchronous EQL search.", + "description": "Get async EQL search results.\nGet the current status and available results for an async EQL search or a stored synchronous EQL search.", "inherits": { "type": { "name": "RequestBase", @@ -117215,7 +117217,7 @@ } } ], - "specLocation": "eql/get/EqlGetRequest.ts#L24-L50" + "specLocation": "eql/get/EqlGetRequest.ts#L24-L51" }, { "kind": "response", @@ -117258,7 +117260,7 @@ "body": { "kind": "no_body" }, - "description": "Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.", + "description": "Get the async EQL status.\nGet the current status for an async EQL search or a stored synchronous EQL search without returning results.", "inherits": { "type": { "name": "RequestBase", @@ -117284,7 +117286,7 @@ } ], "query": [], - "specLocation": "eql/get_status/EqlGetStatusRequest.ts#L23-L35" + "specLocation": "eql/get_status/EqlGetStatusRequest.ts#L23-L36" }, { "kind": "response", @@ -117606,7 +117608,7 @@ } ] }, - "description": "Returns results matching a query expressed in Event Query Language (EQL)", + "description": "Get EQL search results.\nReturns search results for an Event Query Language (EQL) query.\nEQL assumes each document in a data stream or index corresponds to an event.", "inherits": { "type": { "name": "RequestBase", @@ -117708,7 +117710,7 @@ } } ], - "specLocation": "eql/search/EqlSearchRequest.ts#L28-L118" + "specLocation": "eql/search/EqlSearchRequest.ts#L28-L122" }, { "kind": "response", diff --git a/specification/eql/delete/EqlDeleteRequest.ts b/specification/eql/delete/EqlDeleteRequest.ts index a25a673f7b..98178c64d2 100644 --- a/specification/eql/delete/EqlDeleteRequest.ts +++ b/specification/eql/delete/EqlDeleteRequest.ts @@ -21,7 +21,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Deletes an async EQL search or a stored synchronous EQL search. + * Delete an async EQL search. + * Delete an async EQL search or a stored synchronous EQL search. * The API also deletes results for the search. * @rest_spec_name eql.delete * @availability stack since=7.9.0 stability=stable diff --git a/specification/eql/get/EqlGetRequest.ts b/specification/eql/get/EqlGetRequest.ts index 9e492feeff..40210d77bf 100644 --- a/specification/eql/get/EqlGetRequest.ts +++ b/specification/eql/get/EqlGetRequest.ts @@ -22,7 +22,8 @@ import { Id } from '@_types/common' import { Duration } from '@_types/Time' /** - * Returns the current status and available results for an async EQL search or a stored synchronous EQL search. + * Get async EQL search results. + * Get the current status and available results for an async EQL search or a stored synchronous EQL search. * @doc_id eql-async-search-api * @rest_spec_name eql.get * @availability stack since=7.9.0 stability=stable diff --git a/specification/eql/get_status/EqlGetStatusRequest.ts b/specification/eql/get_status/EqlGetStatusRequest.ts index 8195defc13..2510f61214 100644 --- a/specification/eql/get_status/EqlGetStatusRequest.ts +++ b/specification/eql/get_status/EqlGetStatusRequest.ts @@ -21,7 +21,8 @@ import { RequestBase } from '@_types/Base' import { Id } from '@_types/common' /** - * Returns the current status for an async EQL search or a stored synchronous EQL search without returning results. + * Get the async EQL status. + * Get the current status for an async EQL search or a stored synchronous EQL search without returning results. * @doc_id eql-async-search-status-api * @rest_spec_name eql.get_status * @availability stack since=7.9.0 stability=stable diff --git a/specification/eql/search/EqlSearchRequest.ts b/specification/eql/search/EqlSearchRequest.ts index 99d661d673..87c5c3293f 100644 --- a/specification/eql/search/EqlSearchRequest.ts +++ b/specification/eql/search/EqlSearchRequest.ts @@ -26,9 +26,13 @@ import { Duration } from '@_types/Time' import { ResultPosition } from './types' /** + * Get EQL search results. + * Returns search results for an Event Query Language (EQL) query. + * EQL assumes each document in a data stream or index corresponds to an event. * @rest_spec_name eql.search * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public + * @ext_doc_id eql */ export interface Request extends RequestBase { path_parts: {