-
Notifications
You must be signed in to change notification settings - Fork 730
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Improved the body BC break description in request/response for 8.x documentation #2117
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me, thanks! Except one word
docs/changelog.asciidoc
Outdated
@@ -361,6 +361,9 @@ The client API leaks HTTP-related notions in many places, and removing them woul | |||
|
|||
This could be a rather big breaking change, so a double solution could be used during the 8.x lifecycle. (accepting body keys without them being wrapped in the body as well as the current solution). | |||
|
|||
To convert code from 7.x, you just need to remove the `body` parameter in all the endpoints request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you please eliminate the word just? https://developers.google.com/style/word-list#just
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! LGTM.
…cumentation (#2117) (#2118) * Improved the body bc break in 8.x documentation * Removed just in the sentence (cherry picked from commit 6eabf37) Co-authored-by: Enrico Zimuel <[email protected]>
…cumentation (#2117) (#2119) * Improved the body bc break in 8.x documentation * Removed just in the sentence (cherry picked from commit 6eabf37) Co-authored-by: Enrico Zimuel <[email protected]>
This PR improves the documentation about the
body
breaking changes in 8.x.