Skip to content

Commit b5e901e

Browse files
authored
[DOCS] Adds descriptions for EQL APIs (#2216)
1 parent e4cbd9f commit b5e901e

File tree

5 files changed

+30
-14
lines changed

5 files changed

+30
-14
lines changed

output/schema/schema.json

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

specification/_doc_ids/table.csv

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ execute-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/referenc
7272
get-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-enrich-policy-api.html
7373
put-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-enrich-policy-api.html
7474
enrich-stats-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/enrich-stats-api.html
75+
eql-async-search-api, https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html
76+
eql-async-search-status-api, https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html
7577
eql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-search-api.html
7678
docs-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html
7779
search-explain,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-explain.html

specification/eql/delete/EqlDeleteRequest.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,18 @@ 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.
25+
* The API also deletes results for the search.
2426
* @rest_spec_name eql.delete
2527
* @availability stack since=7.9.0 stability=stable
2628
*/
2729
export interface Request extends RequestBase {
2830
path_parts: {
29-
/** Identifier for the search to delete. */
31+
/**
32+
* Identifier for the search to delete.
33+
* A search ID is provided in the EQL search API's response for an async search.
34+
* A search ID is also provided if the request’s `keep_on_completion` parameter is `true`.
35+
*/
3036
id: Id
3137
}
3238
}

specification/eql/get/EqlGetRequest.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +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.
26+
* @doc_id eql-async-search-api
2527
* @rest_spec_name eql.get
2628
* @availability stack since=7.9.0 stability=stable
2729
*/
@@ -34,11 +36,13 @@ export interface Request extends RequestBase {
3436
}
3537
query_parameters: {
3638
/**
37-
* Period for which the search and its results are stored on the cluster. Defaults to the keep_alive value set by the search’s EQL search API request.
39+
* Period for which the search and its results are stored on the cluster.
40+
* Defaults to the keep_alive value set by the search’s EQL search API request.
3841
*/
3942
keep_alive?: Duration
4043
/**
41-
* Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.
44+
* Timeout duration to wait for the request to finish.
45+
* Defaults to no timeout, meaning the request waits for complete search results.
4246
*/
4347
wait_for_completion_timeout?: Duration
4448
}

specification/eql/get_status/EqlGetStatusRequest.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +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.
25+
* @doc_id eql-async-search-status-api
2426
* @rest_spec_name eql.get_status
2527
* @availability stack since=7.9.0 stability=stable
2628
*/

0 commit comments

Comments
 (0)