Skip to content
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.

Sign up for GitHub

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

[DOCS] Adds EQL operation summaries #3207

Merged
merged 2 commits into from
Dec 4, 2024
Merged

[DOCS] Adds EQL operation summaries #3207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e817a4
[DOCS] Add EQL operation summaries
lcawl Dec 3, 2024
2dede75
Generate output
lcawl Dec 3, 2024
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
22 changes: 16 additions & 6 deletions output/openapi/elasticsearch-openapi.json
View file
Open in desktop

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

22 changes: 16 additions & 6 deletions output/openapi/elasticsearch-serverless-openapi.json
View file
Open in desktop

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

26 changes: 14 additions & 12 deletions output/schema/schema.json
View file
Open in desktop

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

3 changes: 2 additions & 1 deletion specification/eql/delete/EqlDeleteRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion specification/eql/get/EqlGetRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion specification/eql/get_status/EqlGetStatusRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 4 additions & 0 deletions specification/eql/search/EqlSearchRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: {
Expand Down
Loading