Skip to content

Commit 9f2b8c6

Browse files
authored
Add missing async_search query parameters to rest-api-spec (#117312) (#117477)
(cherry picked from commit 2f8bb0b)
1 parent 29bd274 commit 9f2b8c6

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

docs/changelog/117312.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
pr: 117312
2+
summary: Add missing `async_search` query parameters to rest-api-spec
3+
area: Search
4+
type: bug
5+
issues: []

rest-api-spec/src/main/resources/rest-api-spec/api/async_search.submit.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@
6565
"type":"boolean",
6666
"description":"Specify whether wildcard and prefix queries should be analyzed (default: false)"
6767
},
68+
"ccs_minimize_roundtrips":{
69+
"type":"boolean",
70+
"default":false,
71+
"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."
72+
},
6873
"default_operator":{
6974
"type":"enum",
7075
"options":[
@@ -126,6 +131,16 @@
126131
"type":"string",
127132
"description":"Specify the node or shard the operation should be performed on (default: random)"
128133
},
134+
"pre_filter_shard_size":{
135+
"type":"number",
136+
"default": 1,
137+
"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."
138+
},
139+
"rest_total_hits_as_int":{
140+
"type":"boolean",
141+
"description":"Indicates whether hits.total should be rendered as an integer or an object in the rest search response",
142+
"default":false
143+
},
129144
"q":{
130145
"type":"string",
131146
"description":"Query in the Lucene query string syntax"

0 commit comments

Comments
 (0)