Replace the API will return an error message that states the scopes or permissions your token needs

[jsoref]

Code of Conduct

• 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/graphql/guides/forming-calls-with-graphql#authenticating-with-a-personal-access-token

What part(s) of the article would you like to see updated?

If your token does not have the required scopes or permissions to access a resource, the API will return an error message that states the scopes or permissions your token needs.

Additional information

https://github.com/orgs/community/discussions/67181#discussion-5630868

When I try to run gh pr checks --watch and gh pr merge --merge --auto in a step using run:, I get the following error:

GraphQL: Resource not accessible by integration (node.statusCheckRollup.nodes.0.commit.statusCheckRollup.contexts.nodes.0.checkSuite.workflowRun)
Error: Process completed with exit code 1.

This clearly violates the documentation's assertion that the api will tell users what they need.

If you need to provide an extra flags to gh, then the documentation should provide them.

[nguyenalex836]

@jsoref Thanks for opening this issue! I'll get this triaged for review ✨

[skedwards88]

Thanks for this issue. I think that it would be better addressed by opening an issue in https://github.com/cli/cli/issues, so I am going to close the docs issue here.