Browse Source

Correct description for mget API request URI index (#52305)

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 aa4926ed7f91dfbf7973a01b1e4682e91dda11a9)
Russ Cam 5 years ago
parent
commit
0671092323
1 changed files with 4 additions and 2 deletions
  1. 4 2
      docs/reference/docs/multi-get.asciidoc

+ 4 - 2
docs/reference/docs/multi-get.asciidoc

@@ -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}
@@ -264,4 +266,4 @@ GET /_mget?routing=key1
         }
     ]
 }
---------------------------------------------------
+--------------------------------------------------