Skip to content

[Backport 8.17] [DOCS] Add SQL operation summaries #3231

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

Merged
merged 1 commit into from
Dec 5, 2024
Merged

[Backport 8.17] [DOCS] Add SQL operation summaries #3231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 15 additions & 9 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.

24 changes: 15 additions & 9 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.

38 changes: 19 additions & 19 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.

1 change: 1 addition & 0 deletions specification/sql/clear_cursor/ClearSqlCursorRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import { RequestBase } from '@_types/Base'

/**
* Clear an SQL search cursor.
* @rest_spec_name sql.clear_cursor
* @availability stack since=6.3.0 stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
3 changes: 3 additions & 0 deletions specification/sql/delete_async/SqlDeleteAsyncRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ import { RequestBase } from '@_types/Base'
import { Id } from '@_types/common'

/**
* Delete an async SQL search.
* Delete an async SQL search or a stored synchronous SQL search.
* If the search is still running, the API cancels it.
* @rest_spec_name sql.delete_async
* @availability stack since=7.15.0 stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 2 additions & 0 deletions specification/sql/get_async/SqlGetAsyncRequest.ts
View file
Open in desktop
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'

/**
* Get async SQL search results.
* Get the current status and available results for an async SQL search or stored synchronous SQL search.
* @rest_spec_name sql.get_async
* @availability stack since=7.15.0 stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 2 additions & 0 deletions specification/sql/get_async_status/SqlGetAsyncStatusRequest.ts
View file
Open in desktop
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'

/**
* Get the async SQL search status.
* Get the current status of an async SQL search or a stored synchronous SQL search.
* @rest_spec_name sql.get_async_status
* @availability stack since=7.15.0 stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 2 additions & 0 deletions specification/sql/query/QuerySqlRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ import { QueryContainer } from '@_types/query_dsl/abstractions'
import { Duration, TimeZone } from '@_types/Time'

/**
* Get SQL search results.
* Run an SQL request.
* @rest_spec_name sql.query
* @availability stack since=6.3.0 stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
2 changes: 2 additions & 0 deletions specification/sql/translate/TranslateSqlRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ import { QueryContainer } from '@_types/query_dsl/abstractions'
import { TimeZone } from '@_types/Time'

/**
* Translate SQL into Elasticsearch queries.
* Translate an SQL search into a search API request containing Query DSL.
* @rest_spec_name sql.translate
* @availability stack since=6.3.0 stability=stable
* @availability serverless stability=stable visibility=public
Expand Down
Loading