github / docs

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

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

Open tonglil opened 4 weeks ago

tonglil commented 4 weeks ago

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:

image image

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] commented 4 weeks ago

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 commented 4 weeks ago

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