Unify language in the API docs for Issues endpoints (#33141)
Co-authored-by: Sarah Edwards <skedwards88@github.com>
This commit is contained in:
@@ -2,7 +2,7 @@
|
|||||||
title: Issue assignees
|
title: Issue assignees
|
||||||
allowTitleToDifferFromFilename: true
|
allowTitleToDifferFromFilename: true
|
||||||
shortTitle: Assignees
|
shortTitle: Assignees
|
||||||
intro: ''
|
intro: 'Use the REST API to manage assignees on issues and pull requests.'
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghes: '*'
|
ghes: '*'
|
||||||
@@ -13,6 +13,6 @@ topics:
|
|||||||
miniTocMaxHeadingLevel: 3
|
miniTocMaxHeadingLevel: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
## About the Issue assignees API
|
## About issue and pull request assignees
|
||||||
|
|
||||||
The Issue assignees API supports managing assignees on issues and pull requests. {% data reusables.pull_requests.issues-pr-shared-api %}
|
You can use the REST API to view, add, and remove assignees on issues and pull requests. {% data reusables.pull_requests.issues-pr-shared-api %}
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Issue comments
|
title: Issue comments
|
||||||
allowTitleToDifferFromFilename: true
|
allowTitleToDifferFromFilename: true
|
||||||
shortTitle: Comments
|
shortTitle: Comments
|
||||||
intro: The Issue comments API supports managing comments on issues and pull requests.
|
intro: Use the REST API to manage comments on issues and pull requests.
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghes: '*'
|
ghes: '*'
|
||||||
@@ -13,8 +13,8 @@ topics:
|
|||||||
miniTocMaxHeadingLevel: 3
|
miniTocMaxHeadingLevel: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
## About the Issue comments API
|
## About issue and pull request comments
|
||||||
|
|
||||||
The Issue comments API supports managing comments on issues and pull requests. {% data reusables.pull_requests.issues-pr-shared-api %} To manage pull request review comments, use the [Pull request review comments API](/rest/pulls/comments) instead.
|
You can use the REST API to create and manage comments on issues and pull requests. {% data reusables.pull_requests.issues-pr-shared-api %} To manage pull request review comments, see "[Pull request review comments](/rest/pulls/comments)."
|
||||||
|
|
||||||
{% data reusables.pull_requests.issues-media-types %}
|
{% data reusables.pull_requests.issues-media-types %}
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Issue events
|
title: Issue events
|
||||||
allowTitleToDifferFromFilename: true
|
allowTitleToDifferFromFilename: true
|
||||||
shortTitle: Events
|
shortTitle: Events
|
||||||
intro: The Issue events API can return different types of events triggered by activity in issues and pull requests.
|
intro: Use the REST API to retrieve events triggered by activity in issues and pull requests.
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghes: '*'
|
ghes: '*'
|
||||||
@@ -13,8 +13,8 @@ topics:
|
|||||||
miniTocMaxHeadingLevel: 3
|
miniTocMaxHeadingLevel: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
## About the Issue events API
|
## About 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](/developers/webhooks-and-events/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](/developers/webhooks-and-events/github-event-types)."
|
You can use the REST API to view different types of events triggered by activity in issues and pull requests. For more information about the specific events that you can receive, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." To view GitHub activity outside of issues and pull requests, you can use the [Events](/developers/webhooks-and-events/github-event-types) endpoints.
|
||||||
|
|
||||||
{% data reusables.pull_requests.issues-pr-shared-api %}
|
{% data reusables.pull_requests.issues-pr-shared-api %}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Issues
|
title: Issues
|
||||||
intro: 'The Issues API enables you to view and manage issues, including issue assignees, comments, labels, and milestones.'
|
intro: 'Use the REST API to view and manage issues, including issue assignees, comments, labels, and milestones.'
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /v3/issues
|
- /v3/issues
|
||||||
- /rest/reference/issues
|
- /rest/reference/issues
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Issues
|
title: Issues
|
||||||
intro: ''
|
intro: 'Use the REST API to manage issues and pull requests.'
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghes: '*'
|
ghes: '*'
|
||||||
@@ -11,6 +11,6 @@ topics:
|
|||||||
miniTocMaxHeadingLevel: 3
|
miniTocMaxHeadingLevel: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
## About the Issues API
|
## About issues
|
||||||
|
|
||||||
{% data reusables.pull_requests.issues-media-types %}
|
{% data reusables.pull_requests.issues-media-types %}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Labels
|
title: Labels
|
||||||
intro: ''
|
intro: 'Use the REST API to manage labels for repositories, issues and pull requests.'
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghes: '*'
|
ghes: '*'
|
||||||
@@ -11,6 +11,6 @@ topics:
|
|||||||
miniTocMaxHeadingLevel: 3
|
miniTocMaxHeadingLevel: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
## About the Labels API
|
## About labels
|
||||||
|
|
||||||
The Labels API supports managing labels for a repository and adding or removing labels to issues and pull requests. {% data reusables.pull_requests.issues-pr-shared-api %}
|
You can use the REST API to manage labels for a repository and add or remove labels to issues and pull requests. {% data reusables.pull_requests.issues-pr-shared-api %}
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Milestones
|
title: Milestones
|
||||||
intro: ''
|
intro: 'Use the REST API to manage milestones.'
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghes: '*'
|
ghes: '*'
|
||||||
|
|||||||
@@ -2,7 +2,7 @@
|
|||||||
title: Timeline events
|
title: Timeline events
|
||||||
allowTitleToDifferFromFilename: true
|
allowTitleToDifferFromFilename: true
|
||||||
shortTitle: Timeline
|
shortTitle: Timeline
|
||||||
intro: The Timeline events API can return different types of events triggered by timeline activity in issues and pull requests.
|
intro: Use the REST API to receive events triggered by timeline activity in issues and pull requests.
|
||||||
versions:
|
versions:
|
||||||
fpt: '*'
|
fpt: '*'
|
||||||
ghes: '*'
|
ghes: '*'
|
||||||
@@ -13,10 +13,10 @@ topics:
|
|||||||
miniTocMaxHeadingLevel: 3
|
miniTocMaxHeadingLevel: 3
|
||||||
---
|
---
|
||||||
|
|
||||||
## About the Timeline events API
|
## About timeline events
|
||||||
|
|
||||||
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](/developers/webhooks-and-events/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](/developers/webhooks-and-events/github-event-types)."
|
You can use the REST API to view different types of events triggered by timeline activity in issues and pull requests. For more information about the specific events that you can receive, see "[Issue event types](/developers/webhooks-and-events/issue-event-types)." To view GitHub activity outside of issues and pull requests, see "[GitHub Events Types](/developers/webhooks-and-events/github-event-types)."
|
||||||
|
|
||||||
You can use this API to display information about issues and pull request or determine who should be notified of issue comments.
|
You can use timeline events to display information about issues and pull requests or determine who should be notified of issue comments.
|
||||||
|
|
||||||
{% data reusables.pull_requests.issues-pr-shared-api %}
|
{% data reusables.pull_requests.issues-pr-shared-api %}
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
Every pull request is an issue, but not every issue is a pull request. For this reason, "shared" actions for both features, like managing assignees, labels, and milestones, are provided within Issues API.
|
Every pull request is an issue, but not every issue is a pull request. For this reason, "shared" actions for both features, like managing assignees, labels, and milestones, are provided within the Issues endpoints.
|
||||||
|
|||||||
Reference in New Issue
Block a user