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

Improve Issue API documentation #35718

Open
1 task done
beliaev-maksim opened this issue Dec 19, 2024 · 2 comments
Open
1 task done

Improve Issue API documentation #35718

beliaev-maksim opened this issue Dec 19, 2024 · 2 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

@beliaev-maksim
Copy link
Contributor

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/rest/issues/labels?apiVersion=2022-11-28#add-labels-to-an-issue

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

This API endpoint not only assigns existing labels but also creates a new label if it does not already exist. The newly created label will have a null description and a default color of ededed. This is a convenient feature, and I believe it should be clearly documented to ensure users are aware and can take full advantage of it.

Additional information

I believe this should be resolved in the internal repository. Could we use this issue as a tracking issue and keep it open until the internal issue is addressed?

@beliaev-maksim beliaev-maksim added the content This issue or pull request belongs to the Docs Content team label Dec 19, 2024
Copy link

welcome bot commented Dec 19, 2024

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.

@nguyenalex836
Copy link
Contributor

@beliaev-maksim Thank you for raising this issue! I'll get this triaged for review ✨ Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

@nguyenalex836 nguyenalex836 added waiting for review Issue/PR is waiting for a writer's review rest Content related to rest - overview. and removed triage Do not begin working on this issue until triaged by the team labels Dec 19, 2024
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

2 participants