Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify state_reason update possibility in issue update API #22914

Closed
1 task done
chouetz opened this issue Dec 31, 2022 · 5 comments
Closed
1 task done

Clarify state_reason update possibility in issue update API #22914

chouetz opened this issue Dec 31, 2022 · 5 comments
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

Comments

@chouetz
Copy link

chouetz commented Dec 31, 2022

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

@chouetz chouetz added the content This issue or pull request belongs to the Docs Content team label Dec 31, 2022
@welcome
Copy link

welcome bot commented Dec 31, 2022

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Dec 31, 2022
@Marodero56

This comment was marked as spam.

@cmwilson21
Copy link
Contributor

👋 @chouetz - Thanks so much for opening an issue! I'll triage this for the team to take a look 👀

@cmwilson21 cmwilson21 added waiting for review Issue/PR is waiting for a writer's review rest Content related to rest - overview. rest-description and removed triage Do not begin working on this issue until triaged by the team labels Jan 3, 2023
@docubot
Copy link
Contributor

docubot commented Jan 3, 2023

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.

@docubot docubot closed this as completed Jan 3, 2023
@Bendelk

This comment was marked as spam.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

5 participants