jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-05 21:04:17 -05:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI Descriptions (#31467)

Browse Source 
Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com>
This commit is contained in:
github-openapi-bot
2022-10-06 08:53:22 -07:00
committed by GitHub
parent b2e7f1eeb9
commit e4f7dad219
16 changed files with 112 additions and 112 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
lib/rest/static/decorated/api.github.com.json
View File

@@ -245507,7 +245507,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -249019,7 +249019,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -252449,7 +252449,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -259149,7 +259149,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -266234,7 +266234,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -400824,7 +400824,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -434553,7 +434553,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

14
lib/rest/static/decorated/ghec.json
View File

@@ -246869,7 +246869,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -250381,7 +250381,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -253811,7 +253811,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -260511,7 +260511,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -267596,7 +267596,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -402759,7 +402759,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-cloud@latest//rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -436488,7 +436488,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

14
lib/rest/static/decorated/ghes-3.2.json
View File

@@ -194763,7 +194763,7 @@
}
}
],
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -198185,7 +198185,7 @@
}
}
],
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -201525,7 +201525,7 @@
}
}
],
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -208042,7 +208042,7 @@
}
}
],
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -214943,7 +214943,7 @@
}
}
],
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -325587,7 +325587,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.2/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -363880,7 +363880,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

14
lib/rest/static/decorated/ghes-3.3.json
View File

@@ -195631,7 +195631,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -199061,7 +199061,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -202409,7 +202409,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -208945,7 +208945,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -215866,7 +215866,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -326932,7 +326932,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.3/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.3/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -359660,7 +359660,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

14
lib/rest/static/decorated/ghes-3.4.json
View File

@@ -203316,7 +203316,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -206746,7 +206746,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -210094,7 +210094,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -216630,7 +216630,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -223551,7 +223551,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -345133,7 +345133,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.4/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.4/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -377861,7 +377861,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

14
lib/rest/static/decorated/ghes-3.5.json
View File

@@ -210472,7 +210472,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -213902,7 +213902,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -217250,7 +217250,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -223786,7 +223786,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -230707,7 +230707,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -352295,7 +352295,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.5/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.5/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -385136,7 +385136,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

14
lib/rest/static/decorated/ghes-3.6.json
View File

@@ -215807,7 +215807,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -219319,7 +219319,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -222749,7 +222749,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -229449,7 +229449,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -236534,7 +236534,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -359477,7 +359477,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/enterprise-server@3.6/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -393022,7 +393022,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

14
lib/rest/static/decorated/github.ae.json
View File

@@ -168669,7 +168669,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the <code>filter</code> query parameter to fetch issues that are not\nnecessarily assigned to you.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -172104,7 +172104,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in an organization assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -175457,7 +175457,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues in a repository. Only open issues will be listed.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -182003,7 +182003,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/github-ae@latest/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>The API returns a <a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-redirects-redirects\"><code>301 Moved Permanently</code> status</a> if the issue was\n<a href=\"https://docs.github.com/articles/transferring-an-issue-to-another-repository/\">transferred</a> to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a <code>404 Not Found</code> status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a <code>410 Gone</code> status. To receive webhook events for transferred and deleted issues, subscribe\nto the <a href=\"https://docs.github.com/github-ae@latest/webhooks/event-payloads/#issues\"><code>issues</code></a> webhook.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -188934,7 +188934,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"descriptionHTML": "<p>List issues across owned and member repositories assigned to the authenticated user.</p>\n<p><strong>Note</strong>: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe <code>pull_request</code> key. Be aware that the <code>id</code> of a pull request returned from \"Issues\" endpoints will be an <em>issue id</em>. To find out the pull\nrequest id, use the \"<a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a>\" endpoint.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -302818,7 +302818,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API v3 offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"descriptionHTML": "<p>This endpoint triggers <a href=\"https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications\">notifications</a>. Creating content too quickly using this endpoint may result in secondary rate limiting. See \"<a href=\"https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits\">Secondary rate limits</a>\" and \"<a href=\"https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits\">Dealing with secondary rate limits</a>\" for details.</p>\n<p>Pull request reviews created in the <code>PENDING</code> state are not submitted and therefore do not include the <code>submitted_at</code> property in the response. To create a pending review for a pull request, leave the <code>event</code> parameter blank. For more information about submitting a <code>PENDING</code> review, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/pulls#submit-a-review-for-a-pull-request\">Submit a review for a pull request</a>.\"</p>\n<p><strong>Note:</strong> To comment on a specific line in a file, you need to first determine the <em>position</em> of that line in the diff. The GitHub REST API offers the <code>application/vnd.github.v3.diff</code> <a href=\"https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests\">media type</a>. To see a pull request diff, add this media type to the <code>Accept</code> header of a call to the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request\">single pull request</a> endpoint.</p>\n<p>The <code>position</code> value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.</p>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -334337,7 +334337,7 @@
}
],
"previews": [],
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"descriptionHTML": "<p>Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.</p>\n<p>GitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.</p>",
"statusCodes": [
{
"httpStatusCode": "200",

14
lib/rest/static/dereferenced/api.github.com.deref.json
View File

@@ -42022,7 +42022,7 @@
"/issues": {
"get": {
"summary": "List issues assigned to the authenticated user",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -87896,7 +87896,7 @@
"/orgs/{org}/issues": {
"get": {
"summary": "List organization issues assigned to the authenticated user",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -243036,7 +243036,7 @@
"/repos/{owner}/{repo}/contributors": {
"get": {
"summary": "List repository contributors",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"tags": [
"repos"
],
@@ -279467,7 +279467,7 @@
"/repos/{owner}/{repo}/issues": {
"get": {
"summary": "List repository issues",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -300285,7 +300285,7 @@
"/repos/{owner}/{repo}/issues/{issue_number}": {
"get": {
"summary": "Get an issue",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -395228,7 +395228,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"tags": [
"pulls"
],
@@ -464383,7 +464383,7 @@
"/user/issues": {
"get": {
"summary": "List user account issues assigned to the authenticated user",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],

14
lib/rest/static/dereferenced/ghec.deref.json
View File

@@ -43033,7 +43033,7 @@
"/issues": {
"get": {
"summary": "List issues assigned to the authenticated user",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -90099,7 +90099,7 @@
"/orgs/{org}/issues": {
"get": {
"summary": "List organization issues assigned to the authenticated user",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -246495,7 +246495,7 @@
"/repos/{owner}/{repo}/contributors": {
"get": {
"summary": "List repository contributors",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"tags": [
"repos"
],
@@ -282926,7 +282926,7 @@
"/repos/{owner}/{repo}/issues": {
"get": {
"summary": "List repository issues",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -303744,7 +303744,7 @@
"/repos/{owner}/{repo}/issues/{issue_number}": {
"get": {
"summary": "Get an issue",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-cloud@latest//webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -398687,7 +398687,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-cloud@latest//rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-cloud@latest//rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-cloud@latest//rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"tags": [
"pulls"
],
@@ -472019,7 +472019,7 @@
"/user/issues": {
"get": {
"summary": "List user account issues assigned to the authenticated user",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],

14
lib/rest/static/dereferenced/ghes-3.2.deref.json
View File

@@ -54823,7 +54823,7 @@
"/issues": {
"get": {
"summary": "List issues assigned to the authenticated user",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -84960,7 +84960,7 @@
"/orgs/{org}/issues": {
"get": {
"summary": "List organization issues assigned to the authenticated user",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -201547,7 +201547,7 @@
"/repos/{owner}/{repo}/contributors": {
"get": {
"summary": "List repository contributors",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"tags": [
"repos"
],
@@ -231219,7 +231219,7 @@
"/repos/{owner}/{repo}/issues": {
"get": {
"summary": "List repository issues",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -251717,7 +251717,7 @@
"/repos/{owner}/{repo}/issues/{issue_number}": {
"get": {
"summary": "Get an issue",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.2/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -341736,7 +341736,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.2/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.2/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.2/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"tags": [
"pulls"
],
@@ -392371,7 +392371,7 @@
"/user/issues": {
"get": {
"summary": "List user account issues assigned to the authenticated user",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],

14
lib/rest/static/dereferenced/ghes-3.3.deref.json
View File

@@ -55122,7 +55122,7 @@
"/issues": {
"get": {
"summary": "List issues assigned to the authenticated user",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -85702,7 +85702,7 @@
"/orgs/{org}/issues": {
"get": {
"summary": "List organization issues assigned to the authenticated user",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -203513,7 +203513,7 @@
"/repos/{owner}/{repo}/contributors": {
"get": {
"summary": "List repository contributors",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"tags": [
"repos"
],
@@ -233190,7 +233190,7 @@
"/repos/{owner}/{repo}/issues": {
"get": {
"summary": "List repository issues",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -253680,7 +253680,7 @@
"/repos/{owner}/{repo}/issues/{issue_number}": {
"get": {
"summary": "Get an issue",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.3/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -343884,7 +343884,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.3/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.3/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.3/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.3/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.3/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"tags": [
"pulls"
],
@@ -394743,7 +394743,7 @@
"/user/issues": {
"get": {
"summary": "List user account issues assigned to the authenticated user",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],

14
lib/rest/static/dereferenced/ghes-3.4.deref.json
View File

@@ -55389,7 +55389,7 @@
"/issues": {
"get": {
"summary": "List issues assigned to the authenticated user",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -88528,7 +88528,7 @@
"/orgs/{org}/issues": {
"get": {
"summary": "List organization issues assigned to the authenticated user",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -218275,7 +218275,7 @@
"/repos/{owner}/{repo}/contributors": {
"get": {
"summary": "List repository contributors",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"tags": [
"repos"
],
@@ -248409,7 +248409,7 @@
"/repos/{owner}/{repo}/issues": {
"get": {
"summary": "List repository issues",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -268899,7 +268899,7 @@
"/repos/{owner}/{repo}/issues/{issue_number}": {
"get": {
"summary": "Get an issue",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.4/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -359103,7 +359103,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.4/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.4/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.4/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.4/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.4/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"tags": [
"pulls"
],
@@ -410180,7 +410180,7 @@
"/user/issues": {
"get": {
"summary": "List user account issues assigned to the authenticated user",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],

14
lib/rest/static/dereferenced/ghes-3.5.deref.json
View File

@@ -55759,7 +55759,7 @@
"/issues": {
"get": {
"summary": "List issues assigned to the authenticated user",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -90888,7 +90888,7 @@
"/orgs/{org}/issues": {
"get": {
"summary": "List organization issues assigned to the authenticated user",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -225658,7 +225658,7 @@
"/repos/{owner}/{repo}/contributors": {
"get": {
"summary": "List repository contributors",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"tags": [
"repos"
],
@@ -255810,7 +255810,7 @@
"/repos/{owner}/{repo}/issues": {
"get": {
"summary": "List repository issues",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -276300,7 +276300,7 @@
"/repos/{owner}/{repo}/issues/{issue_number}": {
"get": {
"summary": "Get an issue",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.5/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -366510,7 +366510,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.5/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.5/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.5/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.5/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.5/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"tags": [
"pulls"
],
@@ -418071,7 +418071,7 @@
"/user/issues": {
"get": {
"summary": "List user account issues assigned to the authenticated user",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],

14
lib/rest/static/dereferenced/ghes-3.6.deref.json
View File

@@ -56526,7 +56526,7 @@
"/issues": {
"get": {
"summary": "List issues assigned to the authenticated user",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -92569,7 +92569,7 @@
"/orgs/{org}/issues": {
"get": {
"summary": "List organization issues assigned to the authenticated user",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -229936,7 +229936,7 @@
"/repos/{owner}/{repo}/contributors": {
"get": {
"summary": "List repository contributors",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"tags": [
"repos"
],
@@ -260787,7 +260787,7 @@
"/repos/{owner}/{repo}/issues": {
"get": {
"summary": "List repository issues",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -281605,7 +281605,7 @@
"/repos/{owner}/{repo}/issues/{issue_number}": {
"get": {
"summary": "Get an issue",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/enterprise-server@3.6/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -372741,7 +372741,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.6/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.6/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/enterprise-server@3.6/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/enterprise-server@3.6/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/enterprise-server@3.6/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"tags": [
"pulls"
],
@@ -427587,7 +427587,7 @@
"/user/issues": {
"get": {
"summary": "List user account issues assigned to the authenticated user",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],

14
lib/rest/static/dereferenced/github.ae.deref.json
View File

@@ -38074,7 +38074,7 @@
"/issues": {
"get": {
"summary": "List issues assigned to the authenticated user",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -59737,7 +59737,7 @@
"/orgs/{org}/issues": {
"get": {
"summary": "List organization issues assigned to the authenticated user",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -187201,7 +187201,7 @@
"/repos/{owner}/{repo}/contributors": {
"get": {
"summary": "List repository contributors",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
"tags": [
"repos"
],
@@ -216939,7 +216939,7 @@
"/repos/{owner}/{repo}/issues": {
"get": {
"summary": "List repository issues",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -237464,7 +237464,7 @@
"/repos/{owner}/{repo}/issues/{issue_number}": {
"get": {
"summary": "Get an issue",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "The API returns a [`301 Moved Permanently` status](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-redirects-redirects) if the issue was\n[transferred](https://docs.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If\nthe issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API\nreturns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read\naccess, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe\nto the [`issues`](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#issues) webhook.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],
@@ -327378,7 +327378,7 @@
},
"post": {
"summary": "Create a review for a pull request",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/github-ae@latest/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"description": "This endpoint triggers [notifications](https://docs.github.com/en/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.\n\nPull request reviews created in the `PENDING` state are not submitted and therefore do not include the `submitted_at` property in the response. To create a pending review for a pull request, leave the `event` parameter blank. For more information about submitting a `PENDING` review, see \"[Submit a review for a pull request](https://docs.github.com/github-ae@latest/rest/pulls#submit-a-review-for-a-pull-request).\"\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API offers the `application/vnd.github.v3.diff` [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://docs.github.com/github-ae@latest/rest/reference/pulls#get-a-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
"tags": [
"pulls"
],
@@ -372947,7 +372947,7 @@
"/user/issues": {
"get": {
"summary": "List user account issues assigned to the authenticated user",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.",
"description": "List issues across owned and member repositories assigned to the authenticated user.\n\n**Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `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\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.",
"tags": [
"issues"
],