Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add URL of documentation on docs.github.com/webhooks #12

Open
gr2m opened this issue Dec 12, 2018 · 2 comments
Open

Add URL of documentation on docs.github.com/webhooks #12

gr2m opened this issue Dec 12, 2018 · 2 comments
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR

Comments

@gr2m
Copy link
Contributor

gr2m commented Dec 12, 2018

It would be useful for when generating docs such as https://github.com/octokit/webhooks.js#webhook-events. Not all events are listed on https://developer.github.com/v3/activity/events/types/#checkrunevent, ping and repository_dispatch are documented in other places

@gr2m gr2m added the Type: Feature New feature or request label May 5, 2020
@gr2m
Copy link
Contributor Author

gr2m commented Apr 22, 2021

@wolfy1339 I think this can be closed? The schemas all seem to contain a URL in the description, e.g.

"description": "The [check_run](https://docs.github.com/en/rest/reference/checks#get-a-check-run).",

@gr2m gr2m added Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR and removed Type: Feature New feature or request labels Apr 22, 2021
@wolfy1339
Copy link
Member

That would be the description for the check_run object within the payload.
They don't all contain links at their root to the docs

@gr2m gr2m changed the title Add URL of documentation on developer.github.com Add URL of documentation on docs.github.com/webhooks Jun 11, 2021
@wolfy1339 wolfy1339 added the Status: Up for grabs Issues that are ready to be worked on by anyone label Nov 18, 2021
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Status: Up for grabs Issues that are ready to be worked on by anyone Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR
Projects
None yet
Development

No branches or pull requests

2 participants