search

github / docs

The open-source repo for docs.github.com
https://docs.github.com
Creative Commons Attribution 4.0 International
16.45k stars 60.09k forks source link

Issue event types documentation lacks details for several event types that can be found in the API #35406

Open Fs00 opened 1 week ago

Fs00 commented 1 week ago

Code of Conduct

What article on docs.github.com is affected?

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

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

There are several issue event types that can be encountered when using the issue/timeline events REST API that are not documented in the aforementioned page. Some examples are added_to_merge_queue, auto_merge_disabled, auto_merge_enabled, auto_squash_enabled, but there are others... As @felicitymay rightly pointed out in #35045, auto-generating the content of the article would be the best way to ensure it stays up-to-date as new events are introduced.

Additional information

No response

nguyenalex836 commented 1 week ago

@Fs00 Thank you for raising this issue! I'll get this triaged for review :sparkles: Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

github-actions[bot] commented 1 week ago

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert :eyes: