From cccafc772e3488e75d008921e1c6454b9f7fe64a Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Mon, 4 Feb 2019 14:57:38 -0500 Subject: [PATCH] Docs: Drop inline callout from scroll example (#38340) Coalesces two calls into one in a scroll example so all callouts are at the end of the line. This is the only sort of callouts that are supported by asciidoctor and we'd like to start building our docs with asciidoctor. At present we don't have any mechanism to stop folks adding more inline callouts but we ought to be able to have one in a few weeks. For now, though, removing these inline callouts is a step in the right direction. Relates to #38335 --- docs/reference/search/request/scroll.asciidoc | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/reference/search/request/scroll.asciidoc b/docs/reference/search/request/scroll.asciidoc index 3eebe884255b3..e4b0c31948632 100644 --- a/docs/reference/search/request/scroll.asciidoc +++ b/docs/reference/search/request/scroll.asciidoc @@ -55,16 +55,15 @@ results. [source,js] -------------------------------------------------- -curl -XGET <1> 'localhost:9200/_search/scroll?scroll=1m' <2> <3> \ - -d 'c2Nhbjs2OzM0NDg1ODpzRlBLc0FXNlNyNm5JWUc1' <4> +curl -XGET 'localhost:9200/_search/scroll?scroll=1m' \ <1> + -d 'c2Nhbjs2OzM0NDg1ODpzRlBLc0FXNlNyNm5JWUc1' <2> -------------------------------------------------- -<1> `GET` or `POST` can be used. -<2> The URL should not include the `index` or `type` name -- these - are specified in the original `search` request instead. -<3> The `scroll` parameter tells Elasticsearch to keep the search context open +<1> `GET` or `POST` can be used and the URL should not include the `index` + or `type` name -- this is specified in the original `search` request instead. + The `scroll` parameter tells Elasticsearch to keep the search context open for another `1m`. -<4> The returned `_scroll_id` attribute can be passed in the request body or in the - query string as `?scroll_id=....` +<2> The returned `_scroll_id` attribute can be passed in the request body or in + the query string as `?scroll_id=....` Each call to the `scroll` API returns the next batch of results until there are no more results left to return, ie the `hits` array is empty.