Missing field in Event API docs for DeleteEvent

[wayofthepie]

What article on docs.github.com is affected?

https://docs.github.com/en/developers/webhooks-and-events/github-event-types#deleteevent

What part(s) of the article would you like to see updated?

The docs for DeleteEvent mention two fields, ref, and ref_type. However, there is a third field which appears in API calls, pusher_type. It seems pusher_type should also appear in the docs. Thanks!

Additional information

Example payload for DeleteEvent, calling /events:

{
  "id": "14950205875",
  "type": "DeleteEvent",
  
  "payload": {
    "ref": "dependabot/npm_and_yarn/examples/electron-react/faker-5.2.0",
    "ref_type": "branch",
    "pusher_type": "user"
  },
}

[janiceilene]

@wayofthepie Thanks for opening an issue! I'll triage this for the team to take a look 👀

[skedwards88]

Thanks for pointing this out! I have asked our support team for more information about this property. It looks like it is present in other events as well (e.g. CreateEvent).

[skedwards88]

More info about this:

• pusher_type is in the payload for DeleteEvent and CreateEvent
• The value can be user or a deploy key

You or anyone else is welcome to open a PR to add this info to the docs.

[atharvashirdhankar]

Can I contribute to this issue #3192