Skip to content

Commit e69151f

Browse files
github-openapi-botshati-pateljmarlena
authored
Update OpenAPI Descriptions (#18613)
* Update OpenAPI Descriptions * Add decorated OpenAPI schema files Co-authored-by: github-openapi-bot <github-openapi-bot@users.noreply.github.com> Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com> Co-authored-by: jmarlena <6732600+jmarlena@users.noreply.github.com>
1 parent 3276517 commit e69151f

16 files changed

Lines changed: 27 additions & 27 deletions

lib/rest/static/decorated/api.github.com.json

Lines changed: 4 additions & 4 deletions
Large diffs are not rendered by default.

lib/rest/static/decorated/ghes-2.18.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30805,7 +30805,7 @@
3080530805
}
3080630806
],
3080730807
"summary": "List pull requests associated with a commit",
30808-
"description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests) endpoint.",
30808+
"description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests) endpoint.",
3080930809
"tags": [
3081030810
"repos"
3081130811
],
@@ -30835,7 +30835,7 @@
3083530835
"subcategoryLabel": "Commits",
3083630836
"notes": [],
3083730837
"bodyParameters": [],
30838-
"descriptionHTML": "<p>Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
30838+
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@2.18/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
3083930839
"responses": [
3084030840
{
3084130841
"httpStatusCode": "200",

lib/rest/static/decorated/ghes-2.19.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31372,7 +31372,7 @@
3137231372
}
3137331373
],
3137431374
"summary": "List pull requests associated with a commit",
31375-
"description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-pull-requests) endpoint.",
31375+
"description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-pull-requests) endpoint.",
3137631376
"tags": [
3137731377
"repos"
3137831378
],
@@ -31402,7 +31402,7 @@
3140231402
"subcategoryLabel": "Commits",
3140331403
"notes": [],
3140431404
"bodyParameters": [],
31405-
"descriptionHTML": "<p>Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
31405+
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@2.19/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
3140631406
"responses": [
3140731407
{
3140831408
"httpStatusCode": "200",

lib/rest/static/decorated/ghes-2.20.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31846,7 +31846,7 @@
3184631846
}
3184731847
],
3184831848
"summary": "List pull requests associated with a commit",
31849-
"description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#list-pull-requests) endpoint.",
31849+
"description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#list-pull-requests) endpoint.",
3185031850
"tags": [
3185131851
"repos"
3185231852
],
@@ -31876,7 +31876,7 @@
3187631876
"subcategoryLabel": "Commits",
3187731877
"notes": [],
3187831878
"bodyParameters": [],
31879-
"descriptionHTML": "<p>Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
31879+
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@2.20/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
3188031880
"responses": [
3188131881
{
3188231882
"httpStatusCode": "200",

lib/rest/static/decorated/ghes-2.21.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35397,7 +35397,7 @@
3539735397
}
3539835398
],
3539935399
"summary": "List pull requests associated with a commit",
35400-
"description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#list-pull-requests) endpoint.",
35400+
"description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#list-pull-requests) endpoint.",
3540135401
"tags": [
3540235402
"repos"
3540335403
],
@@ -35427,7 +35427,7 @@
3542735427
"subcategoryLabel": "Commits",
3542835428
"notes": [],
3542935429
"bodyParameters": [],
35430-
"descriptionHTML": "<p>Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
35430+
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@2.21/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
3543135431
"responses": [
3543235432
{
3543335433
"httpStatusCode": "200",

lib/rest/static/decorated/ghes-2.22.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43196,7 +43196,7 @@
4319643196
}
4319743197
],
4319843198
"summary": "List pull requests associated with a commit",
43199-
"description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#list-pull-requests) endpoint.",
43199+
"description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#list-pull-requests) endpoint.",
4320043200
"tags": [
4320143201
"repos"
4320243202
],
@@ -43226,7 +43226,7 @@
4322643226
"subcategoryLabel": "Commits",
4322743227
"notes": [],
4322843228
"bodyParameters": [],
43229-
"descriptionHTML": "<p>Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
43229+
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@2.22/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
4323043230
"responses": [
4323143231
{
4323243232
"httpStatusCode": "200",

lib/rest/static/decorated/ghes-3.0.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47648,7 +47648,7 @@
4764847648
}
4764947649
],
4765047650
"summary": "List pull requests associated with a commit",
47651-
"description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-pull-requests) endpoint.",
47651+
"description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-pull-requests) endpoint.",
4765247652
"tags": [
4765347653
"repos"
4765447654
],
@@ -47678,7 +47678,7 @@
4767847678
"subcategoryLabel": "Commits",
4767947679
"notes": [],
4768047680
"bodyParameters": [],
47681-
"descriptionHTML": "<p>Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
47681+
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/enterprise-server@3.0/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
4768247682
"responses": [
4768347683
{
4768447684
"httpStatusCode": "200",

lib/rest/static/decorated/github.ae.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41658,7 +41658,7 @@
4165841658
}
4165941659
],
4166041660
"summary": "List pull requests associated with a commit",
41661-
"description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests) endpoint.",
41661+
"description": "Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests) endpoint.",
4166241662
"tags": [
4166341663
"repos"
4166441664
],
@@ -41688,7 +41688,7 @@
4168841688
"subcategoryLabel": "Commits",
4168941689
"notes": [],
4169041690
"bodyParameters": [],
41691-
"descriptionHTML": "<p>Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
41691+
"descriptionHTML": "<p>Lists the merged pull request that introduced the commit to the repository. If the commit is not present in the default branch, additionally returns open pull requests associated with the commit. The results may include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the <a href=\"https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests\">List pull requests</a> endpoint.</p>",
4169241692
"responses": [
4169341693
{
4169441694
"httpStatusCode": "200",

0 commit comments

Comments
 (0)