Skip to content

Clarify state_reason update possibility in issue update API #22914

@chouetz

Description

@chouetz

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamrestContent related to rest - overview.waiting for reviewIssue/PR is waiting for a writer's review

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions