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

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

Open
1 task done
Fs00 opened this issue Nov 24, 2024 · 2 comments
Open
1 task done
Labels
content This issue or pull request belongs to the Docs Content team developers Content related to developers needs SME This proposal needs review from a subject matter expert rest Content related to rest - overview. waiting for review Issue/PR is waiting for a writer's review

Comments

@Fs00
Copy link
Contributor

Fs00 commented Nov 24, 2024

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

@Fs00 Fs00 added the content This issue or pull request belongs to the Docs Content team label Nov 24, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Nov 24, 2024
@nguyenalex836 nguyenalex836 added rest Content related to rest - overview. developers Content related to developers waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Nov 25, 2024
@nguyenalex836
Copy link
Contributor

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

@subatoi subatoi added the needs SME This proposal needs review from a subject matter expert label Nov 25, 2024
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team developers Content related to developers needs SME This proposal needs review from a subject matter expert rest Content related to rest - overview. waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

No branches or pull requests

3 participants