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

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

Open
1 task done
tonglil opened this issue Jun 20, 2024 · 3 comments
Open
1 task done
Labels
content This issue or pull request belongs to the Docs Content team rest Content related to rest - overview. waiting for review Issue/PR is waiting for a writer's review

Comments

@tonglil
Copy link

tonglil commented Jun 20, 2024

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

@tonglil tonglil added the content This issue or pull request belongs to the Docs Content team label Jun 20, 2024
Copy link

welcome bot commented Jun 20, 2024

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jun 20, 2024
@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review rest Content related to rest - overview. and removed triage Do not begin working on this issue until triaged by the team labels Jun 20, 2024
@nguyenalex836
Copy link
Contributor

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

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 rest Content related to rest - overview. waiting for review Issue/PR is waiting for a writer's review
3 participants
@tonglil @nguyenalex836 and others