Skip to content

Commit 1552e85

Browse files
Update rest-api-spec main (#3199)
* Update rest-api-spec * Remove two rejected parameters from async_search.submit --------- Co-authored-by: pquentin <42327+pquentin@users.noreply.github.com> Co-authored-by: Quentin Pradet <quentin.pradet@elastic.co>
1 parent a6b4919 commit 1552e85

File tree

7 files changed

+4
-143
lines changed

7 files changed

+4
-143
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 0 additions & 32 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/openapi/elasticsearch-serverless-openapi.json

Lines changed: 0 additions & 32 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema-serverless.json

Lines changed: 1 addition & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 1 addition & 27 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/typescript/types.ts

Lines changed: 0 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_json_spec/async_search.submit.json

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,6 @@
3939
"description": "Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false)",
4040
"default": false
4141
},
42-
"keep_alive": {
43-
"type": "time",
44-
"description": "Update the time interval in which the results (partial or final) for this search will be available",
45-
"default": "5d"
46-
},
4742
"batched_reduce_size": {
4843
"type": "number",
4944
"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.",
@@ -118,11 +113,6 @@
118113
"type": "string",
119114
"description": "Specify the node or shard the operation should be performed on (default: random)"
120115
},
121-
"pre_filter_shard_size": {
122-
"type": "number",
123-
"default": 1,
124-
"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."
125-
},
126116
"rest_total_hits_as_int": {
127117
"type": "boolean",
128118
"description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response",

specification/async_search/submit/AsyncSearchSubmitRequest.ts

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,8 @@ import { Duration } from '@_types/Time'
6767
* @doc_tag search
6868
*/
6969
// NOTE: this is a SearchRequest with:
70-
// * 3 added parameters: wait_for_completion_timeout, keep_on_completion and keep_alive
71-
// * 1 removed parameters: scroll
70+
// * 2 added parameters: wait_for_completion_timeout, keep_on_completion
71+
// * 2 removed parameters: scroll, pre_filter_shard_size
7272
export interface Request extends RequestBase {
7373
path_parts: {
7474
index?: Indices
@@ -85,12 +85,6 @@ export interface Request extends RequestBase {
8585
* @server_default false
8686
*/
8787
keep_on_completion?: boolean
88-
/**
89-
* Specifies how long the async search needs to be available.
90-
* Ongoing async searches and any saved search results are deleted after this period.
91-
* @server_default 5d
92-
*/
93-
keep_alive?: Duration
9488
allow_no_indices?: boolean
9589
allow_partial_search_results?: boolean
9690
analyzer?: string
@@ -116,11 +110,6 @@ export interface Request extends RequestBase {
116110
lenient?: boolean
117111
max_concurrent_shard_requests?: long
118112
preference?: string
119-
/**
120-
* 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.
121-
* @server_default 1
122-
*/
123-
pre_filter_shard_size?: long
124113
/** @server_default true */
125114
request_cache?: boolean
126115
routing?: Routing

0 commit comments

Comments
 (0)