1
0
mirror of synced 2025-12-22 03:16:52 -05:00
Files
docs/content/rest/reference/issues.md
Laura Coursen 8f964ea2cb GHEC version (#20947)
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
Co-authored-by: Grace Park <gracepark@github.com>
Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com>
Co-authored-by: Robert Sese <sese@github.com>
Co-authored-by: Peter Bengtsson <peterbe@github.com>
Co-authored-by: Rachael Sewell <rachmari@github.com>
2021-10-15 15:41:33 -05:00

3.0 KiB

title, intro, redirect_from, versions, topics, miniTocMaxHeadingLevel
title intro redirect_from versions topics miniTocMaxHeadingLevel
Issues The Issues API enables you to view and manage issues, including issue assignees, comments, labels, and milestones.
/v3/issues
fpt ghes ghae ghec
* * * *
API
3

Custom media types for issues

These are the supported media types for issues.

application/vnd.github.VERSION.raw+json
application/vnd.github.VERSION.text+json
application/vnd.github.VERSION.html+json
application/vnd.github.VERSION.full+json

For more information about media types, see "Custom media types."

{% for operation in currentRestOperations %} {% unless operation.subcategory %}{% include rest_operation %}{% endunless %} {% endfor %}

Assignees

{% for operation in currentRestOperations %} {% if operation.subcategory == 'assignees' %}{% include rest_operation %}{% endif %} {% endfor %}

Comments

The Issue Comments API supports listing, viewing, editing, and creating comments on issues and pull requests.

Issue Comments use these custom media types. You can read more about the use of media types in the API here.

{% for operation in currentRestOperations %} {% if operation.subcategory == 'comments' %}{% include rest_operation %}{% endif %} {% endfor %}

Events

The Issue Events API can return different types of events triggered by activity in issues and pull requests. For more information about the specific events that you can receive from the Issue Events API, see "Issue event types." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "Events API."

{% for operation in currentRestOperations %} {% if operation.subcategory == 'events' %}{% include rest_operation %}{% endif %} {% endfor %}

Labels

{% for operation in currentRestOperations %} {% if operation.subcategory == 'labels' %}{% include rest_operation %}{% endif %} {% endfor %}

Milestones

{% for operation in currentRestOperations %} {% if operation.subcategory == 'milestones' %}{% include rest_operation %}{% endif %} {% endfor %}

Timeline

The Timeline Events API can return different types of events triggered by timeline activity in issues and pull requests. For more information about the specific events that you can receive from the Issue Events API, see "Issue event types." An events API for GitHub activity outside of issues and pull requests is also available. For more information, see the "GitHub Events API."

You can use this API to display information about issues and pull request or determine who should be notified of issue comments.

{% for operation in currentRestOperations %} {% if operation.subcategory == 'timeline' %}{% include rest_operation %}{% endif %} {% endfor %}