Remove a label from an issue: Clarify 404 status code - Githubissues

github / docs

The open-source repo for docs.github.com

https://docs.github.com

Creative Commons Attribution 4.0 International

16.45k stars 60.09k forks source link

Remove a label from an issue: Clarify 404 status code #35553

Open david-allison opened 6 hours ago

david-allison commented 6 hours ago

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/issues/labels?apiVersion=2022-11-28#remove-a-label-from-an-issue

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

It is unclear whether a 404 is generated because:

1) The label does not exist on the Pull Request/Issue

Expected error most people will want to handle 2) The label is not defined on the repo
Catastrophic logic error

Additional information

Relevant docs

This endpoint returns a 404 Not Found status if the label does not exist.

404 Resource not found

welcome[bot] commented 6 hours 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.