docs
docs copied to clipboard
Clarify state_reason update possibility in issue update API
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/issues?apiVersion=2022-11-28#update-an-issue
What part(s) of the article would you like to see updated?
I have a question regarding the state_reason.
While trying to work on a related issue, I noticed state_reason
cannot be changed alone, and needs an update of state
. Do you think this could be mentioned in the state_reason
description in the update-an-issue REST API documentation? Something like
state_reason
string or null
The reason for the current state. NOTE: Can only be updated alongside with a state
update
Can be one of: completed
, not_planned
, reopened
,
Many thanks in advance
Additional information
As requested by @cmwilson21 in #19593
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.
1ac4d75f599f8a0dbe1450d21fa6b861902ef67d
👋 @chouetz - Thanks so much for opening an issue! I'll triage this for the team to take a look :eyes:
Thank you for opening this issue! Updates to the REST/GraphQL API description must be made internally. I have copied your issue to an internal issue, so I will close this issue.