Skip to content

Commit 9f6c82c

Browse files
authored
[DOCS] Adds EQL operation summaries (#3207)
1 parent 2d220a5 commit 9f6c82c

File tree

7 files changed

+56
-27
lines changed

7 files changed

+56
-27
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 16 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 16 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 14 additions & 12 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/eql/delete/EqlDeleteRequest.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ import { RequestBase } from '@_types/Base'
2121
import { Id } from '@_types/common'
2222

2323
/**
24-
* Deletes an async EQL search or a stored synchronous EQL search.
24+
* Delete an async EQL search.
25+
* Delete an async EQL search or a stored synchronous EQL search.
2526
* The API also deletes results for the search.
2627
* @rest_spec_name eql.delete
2728
* @availability stack since=7.9.0 stability=stable

specification/eql/get/EqlGetRequest.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ import { Id } from '@_types/common'
2222
import { Duration } from '@_types/Time'
2323

2424
/**
25-
* Returns the current status and available results for an async EQL search or a stored synchronous EQL search.
25+
* Get async EQL search results.
26+
* Get the current status and available results for an async EQL search or a stored synchronous EQL search.
2627
* @doc_id eql-async-search-api
2728
* @rest_spec_name eql.get
2829
* @availability stack since=7.9.0 stability=stable

specification/eql/get_status/EqlGetStatusRequest.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ import { RequestBase } from '@_types/Base'
2121
import { Id } from '@_types/common'
2222

2323
/**
24-
* Returns the current status for an async EQL search or a stored synchronous EQL search without returning results.
24+
* Get the async EQL status.
25+
* Get the current status for an async EQL search or a stored synchronous EQL search without returning results.
2526
* @doc_id eql-async-search-status-api
2627
* @rest_spec_name eql.get_status
2728
* @availability stack since=7.9.0 stability=stable

specification/eql/search/EqlSearchRequest.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,13 @@ import { Duration } from '@_types/Time'
2626
import { ResultPosition } from './types'
2727

2828
/**
29+
* Get EQL search results.
30+
* Returns search results for an Event Query Language (EQL) query.
31+
* EQL assumes each document in a data stream or index corresponds to an event.
2932
* @rest_spec_name eql.search
3033
* @availability stack since=7.9.0 stability=stable
3134
* @availability serverless stability=stable visibility=public
35+
* @ext_doc_id eql
3236
*/
3337
export interface Request extends RequestBase {
3438
path_parts: {

0 commit comments

Comments
 (0)