Skip to content

Commit af51318

Browse files
committed
Add note to docs regarding multi-get ordering
The implementation maintains the order of the original requests yet this functionality is not documented. This commit adds a note to the docs regarding the ordering of responses to an multi-get request. Relates elastic#28356
1 parent 1435768 commit af51318

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/reference/docs/multi-get.asciidoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22
== Multi Get API
33

44
Multi GET API allows to get multiple documents based on an index, type
5-
(optional) and id (and possibly routing). The response includes a `docs`
6-
array with all the fetched documents, each element similar in structure
7-
to a document provided by the <<docs-get,get>>
8-
API. Here is an example:
5+
(optional) and id (and possibly routing). The response includes a `docs` array
6+
with all the fetched documents in order corresponding to the original multi-get
7+
request (if there was a failure for a specific get, an object containing this
8+
error is included in place in the response instead). The structure of a
9+
successful get is similar in structure to a document provided by the
10+
<<docs-get,get>> API.
11+
12+
Here is an example:
913

1014
[source,js]
1115
--------------------------------------------------

0 commit comments

Comments
 (0)