REST API: allow issue Type management

[jeherve]

Select Topic Area

Product Feedback

Body

GitHub recently introduced "Issue Types", a new way to categorize and filter issues per type.

The change was announced in this blog post, and is detailed in https://github.com/orgs/community/discussions/139933

It is already possible to add a type to an issue via the GraphQL API: there is an IssueType object to manage issue types at the organization level to create, update, and delete them.

It would be nice if a similar option was added to the REST API, as part of issues.

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐

[cilerler]

Thank you for the great features introduced recently! However, the lack of REST API support for certain functionalities is a bit disappointing.
Specifically, IssueType is a critical element and should be treated as a first-class field. It would be great to see it prioritized and exposed through the REST API in future updates.

CC:@rileybroughten

[rileybroughten]

We're actively working on a REST API for issue types so will have an update for you all soon!

[maxwxyz]

any news on this issue?

[RutvikGhaskataEalf]

@rileybroughten Any update on issue types for a REST API ?

[rileybroughten]

We expect to release this to you all within the next couple weeks 😁

[cpanato]

glad that is happening!

[rileybroughten]

We're starting to roll out support for the REST API, if you'd like to test this early please provide the name of your organization(s) and we can get you access this week. Thank you!

[flovogt]

Awesome! We would like to test it. Feel free to enable it in https://github.com/SAP/.

[maxwxyz]

https://github.com/FreeCAD/ too, please.

[ghawes85]

That is fantastic. If you could add: https://github.com/Pontem-Innovations/

Thank you!

[rileybroughten]

Great you've all been added. There are details below for samples, please let us know if you encounter any issues 👍

[adnankussair]

@rileybroughten Can we also be added please https://github.com/transformstudios

[rileybroughten]

Searching for issues by issue type in a repository and organization

List repository issues by type

Fine-grained tokens require "Issues" repository permissions (read)

curl --request GET \
  --url 'https://api.github.com/repos/{owner}/{repo}/issues?type=bug' \
  --header 'authorization: <YOUR-TOKEN>'

List organization issues assigned to the authenticated user by type

Fine-grained token does not require any permissions.

curl --request GET \
  --url 'https://api.github.com/orgs/{owner}/issues?type=bug' \
  --header 'authorization: <YOUR-TOKEN>'

Adding issue types to issues

Create issue with type

Fine-grained tokens require "Issues" repository permissions (write)

curl --request POST \
  --url https://api.github.com/repos/{owner}/{repo}/issues \
  --header 'authorization: <YOUR-TOKEN>' \
  --header 'content-type: application/json' \
  --data '{
	  "title": "Unexpected error when reloading page",
	  "type": "bug"
	}'

Update issue type for issue

Fine-grained tokens require "Issues" repository permissions (write)

curl --request PATCH \
  --url https://api.github.com/repos/{owner}/{repo}/issues/{issue_number} \
  --header 'authorization: <YOUR-TOKEN>' \
  --header 'content-type: application/json' \
  --data '{
	  "type": "bug"
	}'

Managing issue types for an organization

List organization issue types

Fine-grained tokens require "Issue types" organization permissions (read)

curl --request GET \
  --url https://api.github.com/orgs/{org}/issue-types \
  --header 'authorization: <YOUR-TOKEN>'

Create organization issue type

Fine-grained tokens require "Issue types" organization permissions (write)

curl --request POST \
  --url https://api.github.com/orgs/{org}/issue-types \
  --header 'authorization: token <YOUR-TOKEN>' \
  --header 'content-type: application/json' \
  --data '{
	  "name": "Initiative",
	  "description": "Quarterly goals for department",
	  "color": "orange",
	  "is_enabled": true
	}'

Update organization issue type

Fine-grained tokens require "Issue types" organization permissions (write)

curl --request PUT \
  --url https://api.github.com/orgs/{org}/issue-types/{issue_type_id} \
  --header 'authorization: <YOUR-TOKEN>' \
  --header 'content-type: application/json' \
  --data '{
	  "name": "Initiative",
	  "description": "Quarterly goals for department",
	  "color": "blue",
	  "is_enabled": true
	}'

Delete organization issue type

Fine-grained tokens require "Issue types" organization permissions (write)

curl --request DELETE \
  --url https://api.github.com/orgs/{org/issue-types/{issue_type_id} \
  --header 'authorization: token <YOUR-TOKEN>'