Skip to content

Commit

Permalink
Docs: Drop inline callout from scroll example (elastic#38340) (elasti…
Browse files Browse the repository at this point in the history
…c#38364)

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 elastic#38335
  • Loading branch information
nik9000 authored Feb 4, 2019
1 parent 0adef95 commit 1ff3a96
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions docs/reference/search/request/scroll.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,21 +57,20 @@ results.

[source,js]
--------------------------------------------------
POST <1> /_search/scroll <2>
POST /_search/scroll <1>
{
"scroll" : "1m", <3>
"scroll_id" : "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==" <4>
"scroll" : "1m", <2>
"scroll_id" : "DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==" <3>
}
--------------------------------------------------
// CONSOLE
// TEST[continued s/DXF1ZXJ5QW5kRmV0Y2gBAAAAAAAAAD4WYm9laVYtZndUQlNsdDcwakFMNjU1QQ==/$body._scroll_id/]

<1> `GET` or `POST` can be used.
<2> The URL should not include the `index` name -- this
is 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`
name -- this is specified in the original `search` request instead.
<2> The `scroll` parameter tells Elasticsearch to keep the search context open
for another `1m`.
<4> The `scroll_id` parameter
<3> The `scroll_id` parameter

The `size` parameter allows you to configure the maximum number of hits to be
returned with each batch of results. Each call to the `scroll` API returns the
Expand Down

0 comments on commit 1ff3a96

Please sign in to comment.