Skip to content

[DOCS] Adds descriptions for EQL APIs #2216

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Aug 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions specification/_doc_ids/table.csv
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,8 @@ execute-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/referenc
get-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-enrich-policy-api.html
put-enrich-policy-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-enrich-policy-api.html
enrich-stats-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/enrich-stats-api.html
eql-async-search-api, https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-search-api.html
eql-async-search-status-api, https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-async-eql-status-api.html
eql-search-api,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/eql-search-api.html
docs-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/docs-get.html
search-explain,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/search-explain.html
Expand Down
8 changes: 7 additions & 1 deletion specification/eql/delete/EqlDeleteRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,18 @@ import { RequestBase } from '@_types/Base'
import { Id } from '@_types/common'

/**
* Deletes 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
*/
export interface Request extends RequestBase {
path_parts: {
/** Identifier for the search to delete. */
/**
* Identifier for the search to delete.
* A search ID is provided in the EQL search API's response for an async search.
* A search ID is also provided if the request’s `keep_on_completion` parameter is `true`.
*/
id: Id
}
}
8 changes: 6 additions & 2 deletions specification/eql/get/EqlGetRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +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.
* @doc_id eql-async-search-api
* @rest_spec_name eql.get
* @availability stack since=7.9.0 stability=stable
*/
Expand All @@ -34,11 +36,13 @@ export interface Request extends RequestBase {
}
query_parameters: {
/**
* 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.
* 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.
*/
keep_alive?: Duration
/**
* Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results.
* Timeout duration to wait for the request to finish.
* Defaults to no timeout, meaning the request waits for complete search results.
*/
wait_for_completion_timeout?: Duration
}
Expand Down
2 changes: 2 additions & 0 deletions specification/eql/get_status/EqlGetStatusRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +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.
* @doc_id eql-async-search-status-api
* @rest_spec_name eql.get_status
* @availability stack since=7.9.0 stability=stable
*/
Expand Down