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

[FEAT]: Provide response types with Sorbet #1659

Open
1 task done
JamieMagee opened this issue Jan 16, 2024 · 1 comment
Open
1 task done

[FEAT]: Provide response types with Sorbet #1659

JamieMagee opened this issue Jan 16, 2024 · 1 comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Feature New feature or request

Comments

@JamieMagee
Copy link

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

  • I agree to follow this project's Code of Conduct
@JamieMagee JamieMagee added Status: Triage This is being looked at and prioritized Type: Feature New feature or request labels Jan 16, 2024
Copy link

👋 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! 🚀

@kfcampbell kfcampbell added Status: Up for grabs Issues that are ready to be worked on by anyone and removed Status: Triage This is being looked at and prioritized labels Jan 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Feature New feature or request
Projects
Status: 🔥 Backlog
Development

No branches or pull requests

2 participants