octokit.net
octokit.net copied to clipboard
Add classes corresponding to webhook payloads
Currently, deserialization of webhook payloads into classes is not included in octokit.net. If these were included, it'd make webhooks easier to create because devs wouldn't have to one-off their own classes for handling webhook payloads.
According to this
The payloads for all hooks mirror the payloads for the Event types, with the exception of the original push event, which has a more detailed payload.
So as we build out these event types, we'll end up with most of them except the push event.
I'm interested in contributing to this. I'm confused though on why the push event would be excluded. It's actually the one class I'm interested in using in my app. Why is the push is being excluded?
Below is a screen cap of what's actually being sent for a push. It's a bit different from the documented Push event!
- Would you accept a Push model class along with the other events?
- If so, how should I deal with the difference between the documented push event and the actual data being pushed?
@philoushka We'd accept a contribution. Feel free to fix anything wrong with our PushEvent
class. I honestly haven't looked very closely at it so I'm not sure why it's different from the documentation. What's important to me is a working implementation. So if you're actually using this, then your contribution would be really valuable!
Would you take implementations for the Create and Delete Payloads ?
If so, what else needs to be done for this?
- [ ] implementing the classes in the ActivityPayloads folder.
- [ ] Add serialization tests to https://github.com/octokit/octokit.net/blob/master/Octokit.Tests/Clients/EventsClientTests.cs
Webhook payloads are now supported in the Octokit .NET webhooks package
👋 Hey Friends, this issue has been automatically marked as stale
because it has no recent activity. It will be closed if no further activity occurs. Please add the pinned
label if you feel that this issue needs to remain open/active. Thank you for your contributions and help in keeping things tidy!