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

Octokit requests vs. plugin rest endpoint methods #11

Open

pflorek opened this issue Oct 31, 2022 · 0 comments

Labels

Member

pflorek commented Oct 31, 2022

Document the decision for rest over requests

There are two ways of using the GitHub REST API, the octokit.rest.* endpoint methods and octokit.request. Both act the same way, the octokit.rest.* methods are just added for convenience, they use octokit.request internally.

https://github.com/octokit/octokit.js#rest-api

With https://github.com/octokit/plugin-rest-endpoint-methods.js/ one can send all the request parameters as a single object, no matter if it's a route, query or body parameter

pflorek added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment