Module issues_api

Source

Enums§

IssuesSlashAddAssigneesError
struct for typed errors of method issues_slash_add_assignees
IssuesSlashAddLabelsError
struct for typed errors of method issues_slash_add_labels
IssuesSlashCheckUserCanBeAssignedError
struct for typed errors of method issues_slash_check_user_can_be_assigned
IssuesSlashCheckUserCanBeAssignedToIssueError
struct for typed errors of method issues_slash_check_user_can_be_assigned_to_issue
IssuesSlashCreateCommentError
struct for typed errors of method issues_slash_create_comment
IssuesSlashCreateError
struct for typed errors of method issues_slash_create
IssuesSlashCreateLabelError
struct for typed errors of method issues_slash_create_label
IssuesSlashCreateMilestoneError
struct for typed errors of method issues_slash_create_milestone
IssuesSlashDeleteCommentError
struct for typed errors of method issues_slash_delete_comment
IssuesSlashDeleteLabelError
struct for typed errors of method issues_slash_delete_label
IssuesSlashDeleteMilestoneError
struct for typed errors of method issues_slash_delete_milestone
IssuesSlashGetCommentError
struct for typed errors of method issues_slash_get_comment
IssuesSlashGetError
struct for typed errors of method issues_slash_get
IssuesSlashGetEventError
struct for typed errors of method issues_slash_get_event
IssuesSlashGetLabelError
struct for typed errors of method issues_slash_get_label
IssuesSlashGetMilestoneError
struct for typed errors of method issues_slash_get_milestone
IssuesSlashListAssigneesError
struct for typed errors of method issues_slash_list_assignees
IssuesSlashListCommentsError
struct for typed errors of method issues_slash_list_comments
IssuesSlashListCommentsForRepoError
struct for typed errors of method issues_slash_list_comments_for_repo
IssuesSlashListError
struct for typed errors of method issues_slash_list
IssuesSlashListEventsError
struct for typed errors of method issues_slash_list_events
IssuesSlashListEventsForRepoError
struct for typed errors of method issues_slash_list_events_for_repo
IssuesSlashListEventsForTimelineError
struct for typed errors of method issues_slash_list_events_for_timeline
IssuesSlashListForAuthenticatedUserError
struct for typed errors of method issues_slash_list_for_authenticated_user
IssuesSlashListForOrgError
struct for typed errors of method issues_slash_list_for_org
IssuesSlashListForRepoError
struct for typed errors of method issues_slash_list_for_repo
IssuesSlashListLabelsForMilestoneError
struct for typed errors of method issues_slash_list_labels_for_milestone
IssuesSlashListLabelsForRepoError
struct for typed errors of method issues_slash_list_labels_for_repo
IssuesSlashListLabelsOnIssueError
struct for typed errors of method issues_slash_list_labels_on_issue
IssuesSlashListMilestonesError
struct for typed errors of method issues_slash_list_milestones
IssuesSlashLockError
struct for typed errors of method issues_slash_lock
IssuesSlashRemoveAllLabelsError
struct for typed errors of method issues_slash_remove_all_labels
IssuesSlashRemoveAssigneesError
struct for typed errors of method issues_slash_remove_assignees
IssuesSlashRemoveLabelError
struct for typed errors of method issues_slash_remove_label
IssuesSlashSetLabelsError
struct for typed errors of method issues_slash_set_labels
IssuesSlashUnlockError
struct for typed errors of method issues_slash_unlock
IssuesSlashUpdateCommentError
struct for typed errors of method issues_slash_update_comment
IssuesSlashUpdateError
struct for typed errors of method issues_slash_update
IssuesSlashUpdateLabelError
struct for typed errors of method issues_slash_update_label
IssuesSlashUpdateMilestoneError
struct for typed errors of method issues_slash_update_milestone

Functions§

issues_slash_add_assignees
Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.
issues_slash_add_labels
Adds labels to an issue. If you provide an empty array of labels, all labels are removed from the issue.
issues_slash_check_user_can_be_assigned
Checks if a user has permission to be assigned to an issue in this repository. If the assignee can be assigned to issues in the repository, a 204 header with no content is returned. Otherwise a 404 status code is returned.
issues_slash_check_user_can_be_assigned_to_issue
Checks if a user has permission to be assigned to a specific issue. If the assignee can be assigned to this issue, a 204 status code with no content is returned. Otherwise a 404 status code is returned.
issues_slash_create
Any user with pull access to a repository can create an issue. If issues are disabled in the repository, the API returns a 410 Gone status. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API." This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
issues_slash_create_comment
You can use the REST API to create comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API." This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
issues_slash_create_label
Creates a label for the specified repository with the given name and color. The name and color parameters are required. The color must be a valid hexadecimal color code.
issues_slash_create_milestone
Creates a milestone.
issues_slash_delete_comment
You can use the REST API to delete comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
issues_slash_delete_label
Deletes a label using the given label name.
issues_slash_delete_milestone
Deletes a milestone using the given milestone number.
issues_slash_get
The API returns a 301 Moved Permanently status if the issue was transferred to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a 404 Not Found status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a 410 Gone status. To receive webhook events for transferred and deleted issues, subscribe to the issues webhook. Note: GitHub’s REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
issues_slash_get_comment
You can use the REST API to get comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
issues_slash_get_event
Gets a single event by the event id.
issues_slash_get_label
Gets a label using the given name.
issues_slash_get_milestone
Gets a milestone using the given milestone number.
issues_slash_list
List issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories. You can use the filter query parameter to fetch issues that are not necessarily assigned to you. Note: GitHub’s REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
issues_slash_list_assignees
Lists the available assignees for issues in a repository.
issues_slash_list_comments
You can use the REST API to list comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. Issue comments are ordered by ascending ID. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
issues_slash_list_comments_for_repo
You can use the REST API to list comments on issues and pull requests for a repository. Every pull request is an issue, but not every issue is a pull request. By default, issue comments are ordered by ascending ID. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
issues_slash_list_events
Lists all events for an issue.
issues_slash_list_events_for_repo
Lists events for a repository.
issues_slash_list_events_for_timeline
List all timeline events for an issue.
issues_slash_list_for_authenticated_user
List issues across owned and member repositories assigned to the authenticated user. Note: GitHub’s REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
issues_slash_list_for_org
List issues in an organization assigned to the authenticated user. Note: GitHub’s REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
issues_slash_list_for_repo
List issues in a repository. Only open issues will be listed. Note: GitHub’s REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key. Be aware that the id of a pull request returned from "Issues" endpoints will be an issue id. To find out the pull request id, use the "List pull requests" endpoint. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
issues_slash_list_labels_for_milestone
Lists labels for issues in a milestone.
issues_slash_list_labels_for_repo
Lists all labels for a repository.
issues_slash_list_labels_on_issue
Lists all labels for an issue.
issues_slash_list_milestones
Lists milestones for a repository.
issues_slash_lock
Users with push access can lock an issue or pull request’s conversation. Note that, if you choose not to pass any parameters, you’ll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP method."
issues_slash_remove_all_labels
Removes all labels from an issue.
issues_slash_remove_assignees
Removes one or more assignees from an issue.
issues_slash_remove_label
Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a 404 Not Found status if the label does not exist.
issues_slash_set_labels
Removes any previous labels and sets the new labels for an issue.
issues_slash_unlock
Users with push access can unlock an issue’s conversation.
issues_slash_update
Issue owners and users with push access can edit an issue. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
issues_slash_update_comment
You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
issues_slash_update_label
Updates a label using the given label name.
issues_slash_update_milestone