[DOCS] revise high level client Search Scroll API docs #25599
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Moved the full example at the end of the page, reduced the number of bullet points for it, and added smaller examples at the beginning of the page.
javanna
added
:Java High Level REST Client
>docs
nik9000
approved these changes
Jul 7, 2017
| Finally, the last scroll identifier can be deleted using the <<java-rest-high-clear-scroll>> | ||
| in order to release the search context. This happens automatically when the | ||
| scroll expires, but it's good practice to do it as soon as the scroll session | ||
| is completed. |
There was a problem hiding this comment.
Should this have an example call?
There was a problem hiding this comment.
good point. I didn't add that because it felt like repeating the clear scroll docs, so I thought the link is enough, and the clear scroll code is already in the full example at the end. Do you think that's ok?
There was a problem hiding this comment.
Fine with me, though I wonder why we have clear scroll docs outside of the scroll docs. I think they'd make more sense right here.
There was a problem hiding this comment.
just because every API is rendered in its own page.
|
thanks @nik9000 |
javanna
added a commit
that referenced
this pull request
Jul 7, 2017
Moved the full example at the end of the page, reduced the number of bullet points for it, and added smaller examples at the beginning of the page.
jasontedor
added a commit
to jasontedor/elasticsearch
that referenced
this pull request
Jul 7, 2017
* master: Remove deprecated created and found from index, delete and bulk (elastic#25516) fix testEnsureVersionCompatibility for 5.5.0 release fix Version.v6_0_0 min compatibility version to 5.5.0 Add bwc indices for 5.5.0 Add v5_5_1 constant [DOCS] revise high level client Search Scroll API docs (elastic#25599) Improve REST error handling when endpoint does not support HTTP verb, add OPTIONS support (elastic#24437) Avoid SecurityException in repository-S3 on DefaultS3OutputStream.flush() (elastic#25254) [Tests] Add tests for CompletionSuggestionBuilder#build() (elastic#25575)
jasontedor
added a commit
to jasontedor/elasticsearch
that referenced
this pull request
Jul 7, 2017
* master: (42 commits) Harden global checkpoint tracker Remove deprecated created and found from index, delete and bulk (elastic#25516) fix testEnsureVersionCompatibility for 5.5.0 release fix Version.v6_0_0 min compatibility version to 5.5.0 Add bwc indices for 5.5.0 Add v5_5_1 constant [DOCS] revise high level client Search Scroll API docs (elastic#25599) Improve REST error handling when endpoint does not support HTTP verb, add OPTIONS support (elastic#24437) Avoid SecurityException in repository-S3 on DefaultS3OutputStream.flush() (elastic#25254) [Tests] Add tests for CompletionSuggestionBuilder#build() (elastic#25575) Enable cross-setting validation [Docs] Fix typo in bootstrap-checks.asciidoc (elastic#25597) Index ids in binary form. (elastic#25352) bwc checkout should fetch from all remotes IndexingIT should check for global checkpoints regardless of master version [Tests] Add tests for PhraseSuggestionBuilder#build() (elastic#25571) Remove unused class MinimalMap (elastic#25590) [Docs] Document Scroll API for Java High Level REST Client (elastic#25554) Disable date field mapping changing (elastic#25285) Allow BWC Testing against a specific branch (elastic#25510) ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Moved the full example at the end of the page, reduced the number of bullet points for it, and added smaller examples at the beginning of the page.