Skip to content

Fix msearch rest-api-spec #130627

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.

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 3 commits into from
Jul 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 32 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/api/msearch.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,38 @@
"type":"boolean",
"description":"Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution",
"default":"true"
},
"index":{
"type":"list",
"description":"A comma-separated list of index names to use as default"
},
"ignore_unavailable":{
"type":"boolean",
"description":"Whether specified concrete indices should be ignored when unavailable (missing or closed)"
},
"ignore_throttled":{
"type":"boolean",
"description":"Whether specified concrete, expanded or aliased indices should be ignored when throttled",
"deprecated":true
},
"allow_no_indices":{
"type":"boolean",
"description":"Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"
},
"expand_wildcards":{
"type":"enum",
"options": ["open", "closed", "hidden", "none", "all"],
"default":"open",
"description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
},
"routing":{
"type":"list",
"description":"A comma-separated list of specific routing values"
},
"include_named_queries_score":{
"type":"boolean",
"description":"Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false)",
"default": false
}
},
"body":{
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
setup:
- requires:
test_runner_features: allowed_warnings

- do:
index:
Expand Down Expand Up @@ -67,6 +69,12 @@ setup:
rest_total_hits_as_int: true
max_concurrent_shard_requests: 1
max_concurrent_searches: 1
ignore_unavailable: false
ignore_throttled: false
allow_no_indices: false
expand_wildcards: open
include_named_queries_score: false
index: index_*
body:
- index: index_*
- query:
Expand All @@ -83,6 +91,8 @@ setup:
- {}
- query:
match_all: {}
allowed_warnings:
- "[ignore_throttled] parameter is deprecated because frozen indices have been deprecated. Consider cold or frozen tiers in place of frozen indices."

- match: { responses.0.hits.total: 2 }
- match: { responses.1.hits.total: 1 }
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
setup:
- do:
index:
index: index_1
routing: "1"
id: "1"
body: { foo: bar }

- do:
indices.refresh: {}

---
"Routing":

- do:
msearch:
rest_total_hits_as_int: true
routing: "1"
body:
- {}
- query:
match_all: {}

- match: { responses.0.hits.total: 1 }