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

Update rest-api-spec main #3199

Merged
merged 2 commits into from
Dec 2, 2024
Merged

Update rest-api-spec main #3199

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
79cf17d
Update rest-api-spec
pquentin Nov 30, 2024
a559d44
Remove two rejected parameters from async_search.submit
pquentin Dec 2, 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
32 changes: 0 additions & 32 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.

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

28 changes: 1 addition & 27 deletions 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.

28 changes: 1 addition & 27 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.

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

10 changes: 0 additions & 10 deletions specification/_json_spec/async_search.submit.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,6 @@
"description": "Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)",
"default": false
},
"keep_alive": {
"type": "time",
"description": "Update the time interval in which the results (partial or final) for this search will be available",
"default": "5d"
},
"batched_reduce_size": {
"type": "number",
"description": "The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available.",
Expand Down Expand Up @@ -118,11 +113,6 @@
"type": "string",
"description": "Specify the node or shard the operation should be performed on (default: random)"
},
"pre_filter_shard_size": {
"type": "number",
"default": 1,
"description": "Cannot be changed: this is to enforce the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped."
},
"rest_total_hits_as_int": {
"type": "boolean",
"description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response",
Expand Down
15 changes: 2 additions & 13 deletions specification/async_search/submit/AsyncSearchSubmitRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ import { Duration } from '@_types/Time'
* @doc_tag search
*/
// NOTE: this is a SearchRequest with:
// * 3 added parameters: wait_for_completion_timeout, keep_on_completion and keep_alive
// * 1 removed parameters: scroll
// * 2 added parameters: wait_for_completion_timeout, keep_on_completion
// * 2 removed parameters: scroll, pre_filter_shard_size
export interface Request extends RequestBase {
path_parts: {
index?: Indices
Expand All @@ -85,12 +85,6 @@ export interface Request extends RequestBase {
* @server_default false
*/
keep_on_completion?: boolean
/**
* 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
allow_no_indices?: boolean
allow_partial_search_results?: boolean
analyzer?: string
Expand All @@ -116,11 +110,6 @@ export interface Request extends RequestBase {
lenient?: boolean
max_concurrent_shard_requests?: long
preference?: string
/**
* The default value cannot be changed, which enforces the execution of a pre-filter roundtrip to retrieve statistics from each shard so that the ones that surely don’t hold any document matching the query get skipped.
* @server_default 1
*/
pre_filter_shard_size?: long
/** @server_default true */
request_cache?: boolean
routing?: Routing
Expand Down