Docs: DRY up CRUD docs #34203
Merged
Docs: DRY up CRUD docs #34203
Conversation
This file contains 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
This further applies the pattern set in elastic#34125 to reduce copy-and-paste in the single document CRUD portion of the High Level REST Client docs. It also adds line wraps to snippets that are too wide to fit into the box when rendered in the docs, following up on the work started in elastic#34163.
nik9000
added
>docs
|
Pinging @elastic/es-core-infra |
nik9000
commented
Oct 1, 2018
| @@ -38,7 +38,7 @@ completed the `ActionListener` is called back using the `onResponse` method | |||
| if the execution successfully completed or using the `onFailure` method if | |||
| it failed. | |||
|
|
|||
| A typical listener for +{response}+ looks like: | |||
| A typical listener for +{api}+ looks like: | |||
There was a problem hiding this comment.
This wording sounds better for the exists API.
| @@ -11,6 +11,7 @@ The Java High Level REST Client supports the following Document APIs: | |||
| Single document APIs:: | |||
| * <<{upid}-index>> | |||
| * <<{upid}-get>> | |||
| * <<{upid}-exists>> | |||
| @@ -548,12 +557,13 @@ public void testDelete() throws Exception { | |||
| // tag::delete-request | |||
| DeleteRequest request = new DeleteRequest( | |||
| "posts", // <1> | |||
| "doc", // <2> | |||
| "1"); // <3> | |||
| "doc", // <2> | |||
There was a problem hiding this comment.
These didn't line up and they made me uncomfortable.
jasontedor
added a commit
to martijnvg/elasticsearch
that referenced
this pull request
Oct 5, 2018
* master: (63 commits) [Build] randomizedtesting: Allow property values to be closures (elastic#34319) Feature/hlrc ml docs cleanup (elastic#34316) Docs: DRY up CRUD docs (elastic#34203) Minor corrections in geo-queries.asciidoc (elastic#34314) [DOCS] Remove beta label from normalizers (elastic#34326) Adjust size of BigArrays in circuit breaker test Adapt bwc version after backport Follow stats structure (elastic#34301) Rename CCR stats implementation (elastic#34300) Add max_children limit to nested sort (elastic#33587) MINOR: Remove Dead Code from Netty4Transport (elastic#34134) Rename clsuterformation -> testclusters (elastic#34299) [Build] make sure there are no duplicate classes in third party audit (elastic#34213) BWC Build: Read CI properties to determine java version (elastic#34295) [DOCS] Fix typo and add [float] Allow User/Password realms to disable authc (elastic#34033) Enable security automaton caching (elastic#34028) Preserve thread context during authentication. (elastic#34290) [ML] Allow asynchronous job deletion (elastic#34058) HLRC: ML Adding get datafeed stats API (elastic#34271) ...
|
Thanks for reviewing @hub-cap! |
This was referenced Oct 15, 2018
Merged
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.
This further applies the pattern set in #34125 to reduce copy-and-paste
in the single document CRUD portion of the High Level REST Client docs.
It also adds line wraps to snippets that are too wide to fit into the box
when rendered in the docs, following up on the work started in #34163.