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

converted_to_discussion event type incorrectly marked as unavailable in timeline events REST API #35045

Closed
1 task done
Fs00 opened this issue Oct 22, 2024 · 3 comments · Fixed by #35065
Closed
1 task done
Labels
content This issue or pull request belongs to the Docs Content team developers Content related to developers

Comments

@Fs00
Copy link
Contributor

Fs00 commented Oct 22, 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?

The converted_to_discussion event type is flagged as unavailable for the timeline events API in the docs. However, this doesn't appear to be the case in practice, since the event can be seen in timeline API responses such as https://api.github.com/repos/servo/servo/issues/30494/timeline.
If this is confirmed to be the intended behavior (I would be surprised if it wasn't, at this point), I can open a PR to fix the article.

Additional information

The documentation for the converted_to_discussion event type was added in PR #21028 by an external contributor. It is possible that the inconsistency above was introduced accidentally and slipped through the review.

@Fs00 Fs00 added the content This issue or pull request belongs to the Docs Content team label Oct 22, 2024
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 22, 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! 💛

@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review developers Content related to developers and removed triage Do not begin working on this issue until triaged by the team labels Oct 22, 2024
@felicitymay
Copy link
Contributor

@Fs00 - many thanks for highlighting this apparent bug in the docs and giving such a clear explanation.

Rather than thinking that the original contribution in 2022 might have been wrong, it seems possible that the event was added to the timeline more recently.

We've been steadily automating the generation of articles like this one because they are so difficult to maintain, but clearly this one has not yet been automated. For an example of a similar, automated file, see: Webhook events and payloads, see source: https://github.com/github/docs/blob/main/content/webhooks/webhook-events-and-payloads.md?plain=1.

I checked the definition of the event in an internal repository to confirm your experience is correct ✅

If you have time to create a PR to fix this bug, that would be great.

@felicitymay felicitymay removed the waiting for review Issue/PR is waiting for a writer's review label Oct 23, 2024
@Fs00
Copy link
Contributor Author

Fs00 commented Oct 23, 2024

Thank you @felicitymay for your quick answer. I'll try to open a PR in the next few days to address the issue.
I agree with you that automatically generating that article's content should be the way to go. I've noticed that there are many issue event types that are returned by the API but aren't documented. When I find the time, I'll open another issue so that you don't lose track of the problem.

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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants