Skip to content

Commit

Permalink
Correct description for mget API request URI index (#52305)
Browse files Browse the repository at this point in the history
This commit corrects the description for the request URI index for the Multi Get (mget) API.
The index can only be a single index name (multiple or wildcard expressions not supported),
and acts as the index to use when "ids" are specified, or a document in the "docs" array does
not specify an index.

(cherry picked from commit aa4926e)
  • Loading branch information
russcam committed Apr 1, 2020
1 parent 581b8cd commit 0671092
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/reference/docs/multi-get.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,9 @@ See <<shard-failures, Shard failures>> for more information.
[[docs-multi-get-api-path-params]]
==== {api-path-parms-title}

include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
`<index>`::
(Optional, string) Name of the index to retrieve documents from when `ids` are specified,
or when a document in the `docs` array does not specify an index.

[[docs-multi-get-api-query-params]]
==== {api-query-parms-title}
Expand Down Expand Up @@ -264,4 +266,4 @@ GET /_mget?routing=key1
}
]
}
--------------------------------------------------
--------------------------------------------------

0 comments on commit 0671092

Please sign in to comment.