Skip to content

[8.x] Add back keep_alive to async_search.submit (#3601) #3807

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
Feb 20, 2025
Merged

[8.x] Add back keep_alive to async_search.submit (#3601) #3807

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
16 changes: 16 additions & 0 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.

16 changes: 16 additions & 0 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.

15 changes: 14 additions & 1 deletion output/schema/schema-serverless.json
View file
Open in desktop

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

15 changes: 14 additions & 1 deletion 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 output/schema/validation-errors.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
"endpointErrors": {
"async_search.submit": {
"request": [
"Request: query parameter 'keep_alive' does not exist in the json spec",
"Request: query parameter 'min_compatible_shard_node' does not exist in the json spec",
"interface definition _types:QueryVectorBuilder - Property text_embedding is a single-variant and must be required"
],
Expand Down
1 change: 1 addition & 0 deletions output/typescript/types.ts
View file
Open in desktop

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

8 changes: 7 additions & 1 deletion specification/async_search/submit/AsyncSearchSubmitRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ import { Duration } from '@_types/Time'
* @doc_tag search
*/
// NOTE: this is a SearchRequest with:
// * 2 added parameters: wait_for_completion_timeout, keep_on_completion
// * 2 added parameters: wait_for_completion_timeout, keep_on_completion and keep_alive
// * 2 removed parameters: scroll, pre_filter_shard_size
export interface Request extends RequestBase {
urls: [
Expand All @@ -91,6 +91,12 @@ export interface Request extends RequestBase {
* @server_default 1s
*/
wait_for_completion_timeout?: Duration
/**
* Specifies how long the async search needs to be available.
* Ongoing async searches and any saved search results are deleted after this period.
* @server_default 5d
*/
keep_alive?: Duration
/**
* If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`.
* @server_default false
Expand Down