Add Issue Timeline API #389
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The timeline API added in the next commits uses the issue event types. These were incomplete. Also adding documentation to the event types based on: https://docs.github.com/en/webhooks-and-events/events/issue-event-types However, this also includes some event types that aren't documented: - "line-comment" - "cross-referenced" - "comment_deleted" - "base_ref_force_pushed"
|
May have to run |
This would result in failing deserialization
|
Thank you for your PR! |
Merged
0xB10C
commented
Jun 2, 2023
| #[serde(skip_serializing_if = "Option::is_none")] | ||
| pub pull_request_url: Option<Url>, | ||
| #[serde(skip_serializing_if = "Option::is_none")] | ||
| pub requested_reviewers: Option<Vec<Author>>, |
There was a problem hiding this comment.
This should have been pub requested_reviewers: Option<Author>. It's only a single reviewer that's requested per event and not multiple.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds the Timeline Events API for issues along with previously missing Issue Event Types. A
ListTimelineEventsBuilderis implemented forIssue(though as "each pull is also an issue" this works for requesting a Pull-Request timeline too).I've extensively tested this against the issues and pulls in the bitcoin/bitcoin repo. This resulted in nearly every
TimelineEventfield besides the actualeventneeding to beOption<>s as the API sometimes returns null values for fields it normally sets. Also, some of the added event types aren't listed in the API documentation. I hope I got all of them, but there might be some that don't appear in bitcoin/bitcoin.