Skip to content
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

Merged
merged 2 commits into from
Jan 4, 2024

Conversation

ezimuel
Copy link
Contributor

@ezimuel ezimuel commented Jan 3, 2024

This PR improves the documentation about the body breaking changes in 8.x.

pquentin
pquentin previously approved these changes Jan 4, 2024
Copy link
Member

@pquentin pquentin left a 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

@@ -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.
Copy link
Member

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

Copy link
Member

@pquentin pquentin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! LGTM.

@ezimuel ezimuel merged commit 6eabf37 into main Jan 4, 2024
6 checks passed
@ezimuel ezimuel deleted the docs/improve-body-bc-break branch January 4, 2024 12:13
github-actions bot pushed a commit that referenced this pull request Jan 4, 2024
…cumentation (#2117)

* Improved the body bc break in 8.x documentation

* Removed just in the sentence

(cherry picked from commit 6eabf37)
github-actions bot pushed a commit that referenced this pull request Jan 4, 2024
…cumentation (#2117)

* Improved the body bc break in 8.x documentation

* Removed just in the sentence

(cherry picked from commit 6eabf37)
ezimuel added a commit that referenced this pull request Jan 4, 2024
…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]>
ezimuel added a commit that referenced this pull request Jan 4, 2024
…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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants