jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-08 12:01:53 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' into pnsk/update-migrated-data-table

Browse Source
This commit is contained in:
Jules
2022-08-10 13:11:43 +02:00
committed by GitHub
parent cd754d46c6 819c68effb
commit af7a2cf93e
14 changed files with 140 additions and 893 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -445018,7 +445018,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -445028,7 +445028,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The relative path to the file that necessitates a comment.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -445066,7 +445066,7 @@
"in": "body",
"rawType": "integer",
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -458464,7 +458464,7 @@
},
{
"type": "string",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -458473,7 +458473,7 @@
"name": "event",
"in": "body",
"rawType": "string",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"isRequired": false,
"childParamsGroups": []
},
@@ -459027,7 +459027,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 do not include the <code>submitted_at</code> property in the response.</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>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -461808,8 +461808,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -186889,19 +186889,7 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
"example": [
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
}
],
"example": {},
"schema": {
"type": "array",
"items": {
@@ -186929,18 +186917,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -187054,9 +187030,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
},
"schema": {
"title": "Deploy Key",
@@ -187083,18 +187057,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -187184,9 +187146,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
},
"schema": {
"title": "Deploy Key",
@@ -187213,18 +187173,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -203170,19 +203118,6 @@
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
@@ -342378,7 +342313,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -342388,7 +342323,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The relative path to the file that necessitates a comment.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -342426,7 +342361,7 @@
"in": "body",
"rawType": "integer",
"rawDescription": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -355750,7 +355685,7 @@
},
{
"type": "string",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.2/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -355759,7 +355694,7 @@
"name": "event",
"in": "body",
"rawType": "string",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.2/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"isRequired": false,
"childParamsGroups": []
},
@@ -356313,7 +356248,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 do not include the <code>submitted_at</code> property in the response.</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>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -359094,8 +359029,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.2/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -187702,19 +187702,7 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
"example": [
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
}
],
"example": {},
"schema": {
"type": "array",
"items": {
@@ -187742,18 +187730,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -187867,9 +187843,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
},
"schema": {
"title": "Deploy Key",
@@ -187896,18 +187870,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -187997,9 +187959,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
},
"schema": {
"title": "Deploy Key",
@@ -188026,18 +187986,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -204282,19 +204230,6 @@
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
@@ -343937,7 +343872,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -343947,7 +343882,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The relative path to the file that necessitates a comment.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -343985,7 +343920,7 @@
"in": "body",
"rawType": "integer",
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -357351,7 +357286,7 @@
},
{
"type": "string",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.3/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -357360,7 +357295,7 @@
"name": "event",
"in": "body",
"rawType": "string",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.3/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"isRequired": false,
"childParamsGroups": []
},
@@ -357914,7 +357849,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 do not include the <code>submitted_at</code> property in the response.</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>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -360695,8 +360630,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.3/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -195501,19 +195501,7 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
"example": [
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
}
],
"example": {},
"schema": {
"type": "array",
"items": {
@@ -195541,18 +195529,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -195666,9 +195642,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
},
"schema": {
"title": "Deploy Key",
@@ -195695,18 +195669,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -195796,9 +195758,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
},
"schema": {
"title": "Deploy Key",
@@ -195825,18 +195785,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -212261,19 +212209,6 @@
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
@@ -363918,7 +363853,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -363928,7 +363863,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The relative path to the file that necessitates a comment.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -363966,7 +363901,7 @@
"in": "body",
"rawType": "integer",
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -377332,7 +377267,7 @@
},
{
"type": "string",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.4/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -377341,7 +377276,7 @@
"name": "event",
"in": "body",
"rawType": "string",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.4/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"isRequired": false,
"childParamsGroups": []
},
@@ -377895,7 +377830,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 do not include the <code>submitted_at</code> property in the response.</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>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -380676,8 +380611,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.4/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -205492,19 +205492,7 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
"example": [
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
}
],
"example": {},
"schema": {
"type": "array",
"items": {
@@ -205532,18 +205520,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -205657,9 +205633,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
},
"schema": {
"title": "Deploy Key",
@@ -205686,18 +205660,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -205787,9 +205749,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
},
"schema": {
"title": "Deploy Key",
@@ -205816,18 +205776,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -222252,19 +222200,6 @@
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
@@ -373915,7 +373850,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -373925,7 +373860,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The relative path to the file that necessitates a comment.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -373963,7 +373898,7 @@
"in": "body",
"rawType": "integer",
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -387329,7 +387264,7 @@
},
{
"type": "string",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.5/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -387338,7 +387273,7 @@
"name": "event",
"in": "body",
"rawType": "string",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.5/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"isRequired": false,
"childParamsGroups": []
},
@@ -387892,7 +387827,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 do not include the <code>submitted_at</code> property in the response.</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>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -390673,8 +390608,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.5/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -206770,19 +206770,7 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
"example": [
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
}
],
"example": {},
"schema": {
"type": "array",
"items": {
@@ -206810,18 +206798,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -206935,9 +206911,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
},
"schema": {
"title": "Deploy Key",
@@ -206964,18 +206938,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -207065,9 +207027,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
},
"schema": {
"title": "Deploy Key",
@@ -207094,18 +207054,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -223530,19 +223478,6 @@
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
@@ -375353,7 +375288,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -375363,7 +375298,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The relative path to the file that necessitates a comment.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -375401,7 +375336,7 @@
"in": "body",
"rawType": "integer",
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -388799,7 +388734,7 @@
},
{
"type": "string",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -388808,7 +388743,7 @@
"name": "event",
"in": "body",
"rawType": "string",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.6/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"isRequired": false,
"childParamsGroups": []
},
@@ -389362,7 +389297,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 do not include the <code>submitted_at</code> property in the response.</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>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -392143,8 +392078,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/enterprise-server@3.6/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -164137,19 +164137,7 @@
"statusCode": "200",
"contentType": "application/json",
"description": "<p>Response</p>",
"example": [
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
}
],
"example": {},
"schema": {
"type": "array",
"items": {
@@ -164177,18 +164165,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -164302,9 +164278,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
},
"schema": {
"title": "Deploy Key",
@@ -164331,18 +164305,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -164432,9 +164394,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
},
"schema": {
"title": "Deploy Key",
@@ -164461,18 +164421,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -178146,19 +178094,6 @@
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
@@ -321309,7 +321244,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -321319,7 +321254,7 @@
"in": "body",
"rawType": "string",
"rawDescription": "The relative path to the file that necessitates a comment.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -321357,7 +321292,7 @@
"in": "body",
"rawType": "integer",
"rawDescription": "The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.",
"isRequired": false,
"isRequired": true,
"childParamsGroups": []
},
{
@@ -334723,7 +334658,7 @@
},
{
"type": "string",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/github-ae@latest/rest/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"description": "<p>The review action you want to perform. The review actions include: <code>APPROVE</code>, <code>REQUEST_CHANGES</code>, or <code>COMMENT</code>. By leaving this blank, you set the review action state to <code>PENDING</code>, which means you will need to <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#submit-a-review-for-a-pull-request\">submit the pull request review</a> when you are ready.</p>",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -334732,7 +334667,7 @@
"name": "event",
"in": "body",
"rawType": "string",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/github-ae@latest/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"rawDescription": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/github-ae@latest/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"isRequired": false,
"childParamsGroups": []
},
@@ -335286,7 +335221,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 do not include the <code>submitted_at</code> property in the response.</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>",
"statusCodes": [
{
"httpStatusCode": "200",
@@ -338067,8 +338002,8 @@
}
}
],
"descriptionHTML": "",
"previews": [],
"descriptionHTML": "<p>Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"<a href=\"https://docs.github.com/github-ae@latest/rest/pulls#create-a-review-for-a-pull-request\">Create a review for a pull request</a>.\"</p>",
"statusCodes": [
{
"httpStatusCode": "200",

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

@@ -416257,7 +416257,10 @@
}
},
"required": [
"body"
"body",
"commit_id",
"path",
"line"
]
},
"examples": {
@@ -431310,7 +431313,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 do not include the `submitted_at` property in the response.\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.",
"tags": [
"pulls"
],
@@ -431365,7 +431368,7 @@
},
"event": {
"type": "string",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -434351,7 +434354,7 @@
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": {
"post": {
"summary": "Submit a review for a pull request",
"description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/rest/pulls#create-a-review-for-a-pull-request).\"",
"description": "",
"tags": [
"pulls"
],

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

@@ -1267,19 +1267,6 @@
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
@@ -323034,18 +323021,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -323061,19 +323036,8 @@
},
"examples": {
"default": {
"value": [
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
}
]
"value": {
}
}
}
}
@@ -323192,18 +323156,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -323225,9 +323177,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
}
}
}
@@ -323397,18 +323347,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -323430,9 +323368,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
}
}
}
@@ -355342,7 +355278,10 @@
}
},
"required": [
"body"
"body",
"commit_id",
"path",
"line"
]
},
"examples": {
@@ -370325,7 +370264,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 do not include the `submitted_at` property in the response.\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.",
"tags": [
"pulls"
],
@@ -370380,7 +370319,7 @@
},
"event": {
"type": "string",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.2/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.2/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -373366,7 +373305,7 @@
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": {
"post": {
"summary": "Submit a review for a pull request",
"description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-server@3.2/rest/pulls#create-a-review-for-a-pull-request).\"",
"description": "",
"tags": [
"pulls"
],

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

@@ -1199,19 +1199,6 @@
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
@@ -325223,18 +325210,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -325250,19 +325225,8 @@
},
"examples": {
"default": {
"value": [
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
}
]
"value": {
}
}
}
}
@@ -325381,18 +325345,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -325414,9 +325366,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
}
}
}
@@ -325586,18 +325536,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -325619,9 +325557,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
}
}
}
@@ -357676,7 +357612,10 @@
}
},
"required": [
"body"
"body",
"commit_id",
"path",
"line"
]
},
"examples": {
@@ -372697,7 +372636,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 do not include the `submitted_at` property in the response.\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.",
"tags": [
"pulls"
],
@@ -372752,7 +372691,7 @@
},
"event": {
"type": "string",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.3/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.3/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -375738,7 +375677,7 @@
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": {
"post": {
"summary": "Submit a review for a pull request",
"description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-server@3.3/rest/pulls#create-a-review-for-a-pull-request).\"",
"description": "",
"tags": [
"pulls"
],

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

@@ -1199,19 +1199,6 @@
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
@@ -341771,18 +341758,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -341798,19 +341773,8 @@
},
"examples": {
"default": {
"value": [
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
}
]
"value": {
}
}
}
}
@@ -341929,18 +341893,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -341962,9 +341914,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
}
}
}
@@ -342134,18 +342084,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -342167,9 +342105,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
}
}
}
@@ -374224,7 +374160,10 @@
}
},
"required": [
"body"
"body",
"commit_id",
"path",
"line"
]
},
"examples": {
@@ -389245,7 +389184,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 do not include the `submitted_at` property in the response.\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.",
"tags": [
"pulls"
],
@@ -389300,7 +389239,7 @@
},
"event": {
"type": "string",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.4/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.4/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -392286,7 +392225,7 @@
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": {
"post": {
"summary": "Submit a review for a pull request",
"description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-server@3.4/rest/pulls#create-a-review-for-a-pull-request).\"",
"description": "",
"tags": [
"pulls"
],

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

@@ -1199,19 +1199,6 @@
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
@@ -351904,18 +351891,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -351931,19 +351906,8 @@
},
"examples": {
"default": {
"value": [
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
}
]
"value": {
}
}
}
}
@@ -352062,18 +352026,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -352095,9 +352047,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
}
}
}
@@ -352267,18 +352217,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -352300,9 +352238,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
}
}
}
@@ -384363,7 +384299,10 @@
}
},
"required": [
"body"
"body",
"commit_id",
"path",
"line"
]
},
"examples": {
@@ -399384,7 +399323,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 do not include the `submitted_at` property in the response.\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.",
"tags": [
"pulls"
],
@@ -399439,7 +399378,7 @@
},
"event": {
"type": "string",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.5/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.5/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -402425,7 +402364,7 @@
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": {
"post": {
"summary": "Submit a review for a pull request",
"description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-server@3.5/rest/pulls#create-a-review-for-a-pull-request).\"",
"description": "",
"tags": [
"pulls"
],

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

@@ -1199,19 +1199,6 @@
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
@@ -353790,18 +353777,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -353817,19 +353792,8 @@
},
"examples": {
"default": {
"value": [
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
}
]
"value": {
}
}
}
}
@@ -353948,18 +353912,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -353981,9 +353933,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
}
}
}
@@ -354153,18 +354103,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -354186,9 +354124,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
}
}
}
@@ -386273,7 +386209,10 @@
}
},
"required": [
"body"
"body",
"commit_id",
"path",
"line"
]
},
"examples": {
@@ -401326,7 +401265,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 do not include the `submitted_at` property in the response.\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.",
"tags": [
"pulls"
],
@@ -401381,7 +401320,7 @@
},
"event": {
"type": "string",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.6/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/enterprise-server@3.6/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -404367,7 +404306,7 @@
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": {
"post": {
"summary": "Submit a review for a pull request",
"description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/enterprise-server@3.6/rest/pulls#create-a-review-for-a-pull-request).\"",
"description": "",
"tags": [
"pulls"
],

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

@@ -1195,19 +1195,6 @@
"created_at": {
"type": "string",
"format": "date-time"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
],
"format": "date-time"
}
},
"required": [
@@ -309895,18 +309882,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -309922,19 +309897,8 @@
},
"examples": {
"default": {
"value": [
{
"id": 1,
"key": "ssh-rsa AAA...",
"url": "https://api.github.com/repos/octocat/Hello-World/keys/1",
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
}
]
"value": {
}
}
}
}
@@ -310053,18 +310017,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -310086,9 +310038,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
}
}
}
@@ -310258,18 +310208,6 @@
},
"read_only": {
"type": "boolean"
},
"added_by": {
"type": [
"string",
"null"
]
},
"last_used": {
"type": [
"string",
"null"
]
}
},
"required": [
@@ -310291,9 +310229,7 @@
"title": "octocat@octomac",
"verified": true,
"created_at": "2014-12-10T15:53:42Z",
"read_only": true,
"added_by": "octocat",
"last_used": "2022-01-10T15:53:42Z"
"read_only": true
}
}
}
@@ -341964,7 +341900,10 @@
}
},
"required": [
"body"
"body",
"commit_id",
"path",
"line"
]
},
"examples": {
@@ -356985,7 +356924,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 do not include the `submitted_at` property in the response.\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.",
"tags": [
"pulls"
],
@@ -357040,7 +356979,7 @@
},
"event": {
"type": "string",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/github-ae@latest/rest/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://docs.github.com/github-ae@latest/rest/reference/pulls#submit-a-review-for-a-pull-request) when you are ready.",
"enum": [
"APPROVE",
"REQUEST_CHANGES",
@@ -360026,7 +359965,7 @@
"/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": {
"post": {
"summary": "Submit a review for a pull request",
"description": "Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see \"[Create a review for a pull request](https://docs.github.com/github-ae@latest/rest/pulls#create-a-review-for-a-pull-request).\"",
"description": "",
"tags": [
"pulls"
],