search

octokit / octokit.rb

Ruby toolkit for the GitHub API
http://octokit.github.io/octokit.rb/
MIT License
3.83k stars 1.13k forks source link

[FEAT]: Provide response types with Sorbet #1659

Open JamieMagee opened 5 months ago

JamieMagee commented 5 months ago

Describe the need

Currently, the return type of all methods is Sawyer::Resource. This is pretty much a hash/dictionary object of the response body.

It would be more useful to consumers of the Octokit gem to provide type safety and discoverability of the responses by creating models, similar to those provided for the TypeScript and .NET Octokit SDKs.

Using something like Sorbet would allow for strongly typed models, and can be automatically generated from GitHub OpenAPI schema using something like openapi-sorbet.

SDK Version

No response

API Version

No response

Relevant log output

No response

Code of Conduct

github-actions[bot] commented 5 months ago

👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labled with Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀