Skip to content

Commit e142f34

Browse files
SarenCurriecolings86
authored andcommitted
Clarify documentation of scroll_id (#29424)
* Clarify documentation of scroll_id The Scroll API may return the same scroll ID for multiple requests due to server side state. This is not clear from the current documentation. * Further clarify scroll ID return behaviour
1 parent 626e3a5 commit e142f34

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

docs/reference/search/request/scroll.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,9 @@ returned with each batch of results. Each call to the `scroll` API returns the
7878
next batch of results until there are no more results left to return, ie the
7979
`hits` array is empty.
8080

81-
IMPORTANT: The initial search request and each subsequent scroll request
82-
returns a new `_scroll_id` -- only the most recent `_scroll_id` should be
83-
used.
81+
IMPORTANT: The initial search request and each subsequent scroll request each
82+
return a `_scroll_id`, which may change with each request -- only the most
83+
recent `_scroll_id` should be used.
8484

8585
NOTE: If the request specifies aggregations, only the initial search response
8686
will contain the aggregations results.

0 commit comments

Comments
 (0)