jprdonnelly/docs
1
0
Fork 0
mirror of synced 2026-01-07 09:01:31 -05:00
Code Issues Projects Releases Wiki Activity

Merge branch 'main' into repo-sync

Browse Source
This commit is contained in:
Octomerger Bot
2022-04-20 16:25:04 -07:00
committed by GitHub
parent 7191f6a5d1 78ebd2e483
commit f7b8c0bbc1
14 changed files with 9233 additions and 9173 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
data/features/README.md
View File

@@ -45,7 +45,7 @@ versions:
## Schema enforcement
The schema for validating the feature versioning lives in [`tests/helpers/schemas/feature-versions.js`](tests/helpers/schemas/feature-versions.js) and is exercised by [`tests/content/lint-files.js`](tests/content/lint-files.js).
The schema for validating the feature versioning lives in [`tests/helpers/schemas/feature-versions-schema.js`](/tests/helpers/schemas/feature-versions-schema.js) and is exercised by [`tests/linting/lint-files.js`](/tests/linting/lint-files.js).
## Script to remove feature tags

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

File diff suppressed because it is too large Load Diff

2836
lib/rest/static/decorated/ghes-3.1.json
View File

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

File diff suppressed because it is too large Load Diff

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

@@ -366371,14 +366371,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -389968,14 +389968,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -390590,14 +390590,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -391251,14 +391251,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -406869,14 +406869,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -407397,7 +407397,7 @@
},
"post": {
"summary": "Create a review comment for a pull request",
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The 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.\n\nThis 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.",
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The 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.\n\nThis 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.",
"tags": [
"pulls"
],
@@ -407453,7 +407453,11 @@
},
"position": {
"type": "integer",
"description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above."
"description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
}
},
"side": {
"type": "string",
@@ -407565,14 +407569,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -408320,14 +408324,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4

34
lib/rest/static/dereferenced/ghes-3.1.deref.json
View File

@@ -306189,14 +306189,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -329539,14 +329539,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -330171,14 +330171,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -330842,14 +330842,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -340506,14 +340506,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -341100,7 +341100,11 @@
},
"position": {
"type": "integer",
"description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above."
"description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
}
},
"side": {
"type": "string",
@@ -341212,14 +341216,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -341973,14 +341977,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4

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

@@ -314207,14 +314207,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -337592,14 +337592,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -338224,14 +338224,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -338895,14 +338895,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -348559,14 +348559,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -349153,7 +349153,11 @@
},
"position": {
"type": "integer",
"description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above."
"description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
}
},
"side": {
"type": "string",
@@ -349265,14 +349269,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -350026,14 +350030,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4

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

@@ -317558,14 +317558,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -341090,14 +341090,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -341712,14 +341712,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -342373,14 +342373,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -352016,14 +352016,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -352544,7 +352544,7 @@
},
"post": {
"summary": "Create a review comment for a pull request",
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.3/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The 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.\n\nThis 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.",
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.3/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The 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.\n\nThis 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.",
"tags": [
"pulls"
],
@@ -352600,7 +352600,11 @@
},
"position": {
"type": "integer",
"description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above."
"description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
}
},
"side": {
"type": "string",
@@ -352712,14 +352716,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -353467,14 +353471,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4

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

@@ -333487,14 +333487,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -357019,14 +357019,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -357641,14 +357641,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -358302,14 +358302,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -367945,14 +367945,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -368473,7 +368473,7 @@
},
"post": {
"summary": "Create a review comment for a pull request",
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.4/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The 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.\n\nThis 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.",
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/enterprise-server@3.4/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The 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.\n\nThis 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.",
"tags": [
"pulls"
],
@@ -368529,7 +368529,11 @@
},
"position": {
"type": "integer",
"description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above."
"description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
}
},
"side": {
"type": "string",
@@ -368641,14 +368645,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -369396,14 +369400,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4

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

@@ -297949,14 +297949,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -321102,14 +321102,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -321724,14 +321724,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -322385,14 +322385,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -332043,14 +332043,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -332571,7 +332571,7 @@
},
"post": {
"summary": "Create a review comment for a pull request",
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/github-ae@latest/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The 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.\n\nThis 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.",
"description": "\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Create an issue comment](https://docs.github.com/github-ae@latest/rest/reference/issues#create-an-issue-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nThe `position` parameter is deprecated. If you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required.\n\n**Note:** The 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.\n\nThis 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.",
"tags": [
"pulls"
],
@@ -332627,7 +332627,11 @@
},
"position": {
"type": "integer",
"description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above."
"description": "**This paramter is deprecated. Use `line` instead**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.",
"deprecated": true,
"x-github": {
"deprecationDate": "2022-11-01"
}
},
"side": {
"type": "string",
@@ -332739,14 +332743,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4
@@ -333494,14 +333498,14 @@
]
},
"position": {
"description": "The line index in the diff to which the comment applies.",
"description": "The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.",
"type": "integer",
"examples": [
1
]
},
"original_position": {
"description": "The index of the original line in the diff to which the comment applies.",
"description": "The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.",
"type": "integer",
"examples": [
4

12
script/rest/utils/operation.js
View File

@@ -98,6 +98,7 @@ export default class Operation {
this.renderStatusCodes(),
this.renderParameterDescriptions(),
this.renderBodyParameterDescriptions(),
this.renderExampleRequestResponseDescriptions(),
this.renderPreviewNotes(),
])
@@ -118,6 +119,17 @@ export default class Operation {
return this
}
async renderExampleRequestResponseDescriptions() {
return Promise.all(
this.codeExamples.map(async (codeExample) => {
codeExample.response.description = await renderContent(codeExample.response.description)
codeExample.request.description = await renderContent(codeExample.request.description)
return codeExample
})
)
}
async renderStatusCodes() {
const responses = this.#operation.responses
const responseKeys = Object.keys(responses)