Skip to content

Commit 71e3fa5

Browse files
Update rest-api-spec main (#3175)
Co-authored-by: pquentin <[email protected]> Co-authored-by: Quentin Pradet <[email protected]>
1 parent 7dc96a3 commit 71e3fa5

File tree

6 files changed

+19
-3
lines changed

6 files changed

+19
-3
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 1 addition & 0 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: 1 addition & 0 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 & 0 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 & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/validation-errors.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,7 @@
5757
},
5858
"async_search.submit": {
5959
"request": [
60-
"Request: query parameter 'ccs_minimize_roundtrips' does not exist in the json spec",
61-
"Request: query parameter 'pre_filter_shard_size' does not exist in the json spec",
6260
"Request: query parameter 'scroll' does not exist in the json spec",
63-
"Request: query parameter 'rest_total_hits_as_int' does not exist in the json spec",
6461
"interface definition _types:QueryVectorBuilder - Property text_embedding is a single-variant and must be required",
6562
"type_alias definition _spec_utils:PipeSeparatedFlags / union_of / instance_of - No type definition for '_spec_utils.PipeSeparatedFlags:T'"
6663
],

specification/_json_spec/async_search.submit.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,11 @@
6161
"type": "boolean",
6262
"description": "Specify whether wildcard and prefix queries should be analyzed (default: false)"
6363
},
64+
"ccs_minimize_roundtrips": {
65+
"type": "boolean",
66+
"default": false,
67+
"description": "When doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. However, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters."
68+
},
6469
"default_operator": {
6570
"type": "enum",
6671
"options": ["AND", "OR"],
@@ -113,6 +118,16 @@
113118
"type": "string",
114119
"description": "Specify the node or shard the operation should be performed on (default: random)"
115120
},
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+
},
126+
"rest_total_hits_as_int": {
127+
"type": "boolean",
128+
"description": "Indicates whether hits.total should be rendered as an integer or an object in the rest search response",
129+
"default": false
130+
},
116131
"q": {
117132
"type": "string",
118133
"description": "Query in the Lucene query string syntax"

0 commit comments

Comments
 (0)