From 1e817a49b88073799a80ca80cd04dc8b04ca20cb Mon Sep 17 00:00:00 2001 From: lcawl Date: Mon, 2 Dec 2024 18:43:04 -0800 Subject: [PATCH] [DOCS] Add EQL operation summaries --- specification/eql/delete/EqlDeleteRequest.ts | 3 ++- specification/eql/get/EqlGetRequest.ts | 3 ++- specification/eql/get_status/EqlGetStatusRequest.ts | 3 ++- specification/eql/search/EqlSearchRequest.ts | 4 ++++ 4 files changed, 10 insertions(+), 3 deletions(-) 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 efb4fea993..325db1fdb1 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: {