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

Timeline events #364

Closed
Hixie opened this issue Mar 31, 2023 · 7 comments
Closed

Timeline events #364

Hixie opened this issue Mar 31, 2023 · 7 comments

Comments

@Hixie
Copy link
Contributor

Hixie commented Mar 31, 2023

I would like to make use of this API: https://docs.github.com/en/rest/issues/timeline

If I were to implement support for this and submit a PR, is this something that would be considered? (I'm happy to look into adding support, but I'd rather not start if it won't be used 😅.)

@github-actions
Copy link

👋 Thanks for reporting! @robrbecker will take a look.

@robrbecker
Copy link
Member

robrbecker commented Apr 1, 2023 via email

@Hixie
Copy link
Contributor Author

Hixie commented Apr 1, 2023

Cool, I'll see what I can do.

@Hixie
Copy link
Contributor Author

Hixie commented Apr 3, 2023

@robrbecker Couple of questions.

  • Some of the Timeline APIs sometimes return a Team. The package already has a Team class, but it has a different (overlapping) set of properties. Should I augment Team with the properties that this API might return when it returns a team, or should I have two different classes for the different contexts?

  • I've been using the response schema found on https://docs.github.com/en/rest/issues/timeline?apiVersion=2022-11-28 to autogenerate the model classes as a starting point (I'll include the script that does it in case it helps for the future), but I find that this documentation contradicts some of the other GitHub docs, e.g. the prose on https://docs.github.com/en/webhooks-and-events/events/issue-event-types . Do you have any experience with such problems or any suggestions on dealing with it? Obviously at the end of the day I'll try to test these endpoints with real data and make it consistent with reality that way, but there's a good chance I won't be able to test every single part of the API with real data.

@Hixie
Copy link
Contributor Author

Hixie commented Apr 3, 2023

  • I notice none of the models have the url property which seems to be a self-reference for the REST API call itself. Is that intentional? Are there other properties that I should be explicitly not including? (edit: looks like some of the model objects do have this one; some call this apiUrl, and others just url)

@robrbecker
Copy link
Member

fixed in #366

@robrbecker
Copy link
Member

released in https://github.com/SpinlockLabs/github.dart/releases/tag/9.12.0

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

No branches or pull requests

2 participants