Add update documentation (#281) #427
Closed
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
swallez
requested changes
Nov 7, 2022
| @@ -500,7 +499,7 @@ public final Builder<TDocument, TPartialDocument> detectNoop(@Nullable Boolean v | |||
| * <p> | |||
| * API name: {@code doc} | |||
| */ | |||
| public final Builder<TDocument, TPartialDocument> doc(@Nullable TPartialDocument value) { | |||
| public final Builder<TDocument, TPartialDocument> document(@Nullable TPartialDocument value) { | |||
There was a problem hiding this comment.
This code is generated from the Elasticsearch API specification and doc is the name used in the request's body.
The Java API client is generated from this API specification, and except for some rare cases we use the names used in the JSON API so that users can easily map the extensive Elasticsearch documentation to Java methods.
So please revert this change and the other ones in this file. They would be overridden at the next code generation anyway, breaking the documentation examples.
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.
Just played around with the java-client today and saw, that the update documentation is missing, but already noted as TODO in #281. Played around with the update API and thought it could be helpful to add it directly to the repo.