Show the _actual_ permission property name in list of "Permissions for GitHub Apps"

[tonglil]

Code of Conduct

• [X] I have read and agree to the GitHub Docs project's Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/authentication/permissions-required-for-github-apps?apiVersion=2022-11-28#organization-permissions-for-webhooks

And possibly

https://docs.github.com/en/rest/authentication/permissions-required-for-fine-grained-personal-access-tokens?apiVersion=2022-11-28

What changes are you suggesting?

In addition to showing the "pretty name" for permissions, the docs need to also show the actual permission property name slug for each permission so users know which permission to pass when creating an Installation Access Token with permissions.

---

For example:

Repository permissions for "Webhooks"

Fails to describe any where on this page, or in any of the pages related to the webhook docs (example), that the actual permission value is called repository_hooks.

All that is (insufficiently) shown is:

---

To be clear, I want to see repository_hooks somewhere on either one or both of those pages.

Right now the list of permissions are hidden in this endpoint's documentation in a collapsed expandable that is hard to search for and does not pull up on Google search when searching for "permissions available for github apps".

Additional information

Thanks

[welcome[bot]]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[nguyenalex836]

@tonglil Thank you for opening an issue! I'll get this triaged for review ✨

[felicitymay]

@tonglil - many thanks for raising the difficulty with finding the permissions information in its current location of a collapsed section ✨

I can see that this is a problem. These articles are in our REST documentation and are automatically generated, so we'll need to raise an internal issue to investigate how best to improve this situation. I'll trigger the process to create an internal copy of this issue and close this one.

[docs-bot]

Thank you for opening this issue! Updates to this documentation must be made internally. I have copied your issue to an internal issue, so I will close this issue.