-
Notifications
You must be signed in to change notification settings - Fork 60.9k
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
State correct permissions for requesting a reviewer via the API #35057
Comments
@NovemberTang 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! 💛 |
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀 |
This comment was marked as spam.
This comment was marked as spam.
@NovemberTang Hello! 👋 Thank you so much for your patience while our SME team reviewed. They agree with your assessment, and that logically it makes sense Would you be open to raising a PR to amend our docs? If not, no problem at all - we can open this to the community ✨ |
I've gone ahead and added the |
This comment was marked as spam.
This comment was marked as spam.
Hop IPLatency IP Location |
Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/rest/pulls/review-requests?apiVersion=2022-11-28#request-reviewers-for-a-pull-request
What part(s) of the article would you like to see updated?
The docs for this request say that the only required permission for this request is
pull-requests:write
. When I tried to request a review from a team using an app with this permission scope, I got the following error message, which was quite obscure, only vaguely hinting that it might be trying to validate a team slug."errorMessage": "Validation Failed: \"Could not resolve to a node with the global id of 'BUNCH_OF_RANDOM_CHARACTERS'
.I fixed this by applying the permission
members:read
to the GitHub App making the request, and I think it would be helpful to amend the docs to state that this permission is required for the request to succeed. I think it also might be be useful to indicate that the object that has failed to validate is the team slug, if that is the source of the error (which is just an educated guess)Additional information
Please see the following screenshot
The text was updated successfully, but these errors were encountered: