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.

Sign up for GitHub

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

Jump to bottom

rename body to data in request options #296

Open
gr2m opened this issue Sep 16, 2021 · 0 comments
Open

rename body to data in request options #296

gr2m opened this issue Sep 16, 2021 · 0 comments
Labels
Type: Breaking change Used to note any change that requires a major version bump Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR

Comments

@gr2m
Copy link
Contributor

gr2m commented Sep 16, 2021

The endpoint() method currently returns body as the key holding the request body. We should rename it to data to align with data parameter in @octokit/request: https://github.com/octokit/request.js/#the-data-parameter--set-request-body-directly

We can start by setting both .data and .body and then logging a deprecation message when .body is accessed.
@gr2m gr2m added the Type: Breaking change Used to note any change that requires a major version bump label Sep 16, 2021
@wolfy1339 wolfy1339 added the Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR label Dec 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Breaking change Used to note any change that requires a major version bump Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gr2m @wolfy1339