Clarify state_reason update possibility in issue update API #22914
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
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 ofstate
. Do you think this could be mentioned in thestate_reason
description in the update-an-issue REST API documentation? Something likestate_reason
string or nullThe reason for the current state. NOTE: Can only be updated alongside with a
state
updateCan be one of:
completed
,not_planned
,reopened
,Many thanks in advance
Additional information
As requested by @cmwilson21 in #19593
The text was updated successfully, but these errors were encountered: