Skip to content

Commit 176acb8

Browse files
authored
Merge pull request #1636 from github/openapi-update-4577bb796b334a101d9970d23a23d3118fa1f7d65118339f7e41b3ee88d7bc15
Update OpenAPI 3.1 Descriptions
2 parents 4b8e654 + 3471e8e commit 176acb8

32 files changed

Lines changed: 74 additions & 74 deletions

descriptions-next/api.github.com/api.github.com.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29842,7 +29842,7 @@
2984229842
"/repos/{owner}/{repo}/commits/{commit_sha}/pulls": {
2984329843
"get": {
2984429844
"summary": "List pull requests associated with a commit",
29845-
"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.",
29845+
"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 only include open pull requests.",
2984629846
"tags": [
2984729847
"repos"
2984829848
],
@@ -35940,7 +35940,7 @@
3594035940
"/repos/{owner}/{repo}/issues": {
3594135941
"get": {
3594235942
"summary": "List repository issues",
35943-
"description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
35943+
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
3594435944
"tags": [
3594535945
"issues"
3594635946
],

descriptions-next/api.github.com/api.github.com.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21616,8 +21616,8 @@ paths:
2161621616
summary: List pull requests associated with a commit
2161721617
description: Lists the merged pull request that introduced the commit to the
2161821618
repository. If the commit is not present in the default branch, additionally
21619-
returns open pull requests associated with the commit. The results may include
21620-
open and closed pull requests.
21619+
returns open pull requests associated with the commit. The results only include
21620+
open pull requests.
2162121621
tags:
2162221622
- repos
2162321623
operationId: repos/list-pull-requests-associated-with-commit
@@ -26207,7 +26207,7 @@ paths:
2620726207
get:
2620826208
summary: List repository issues
2620926209
description: |-
26210-
List issues in a repository.
26210+
List issues in a repository. Only open issues will be listed.
2621126211

2621226212
**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
2621326213
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by

descriptions-next/api.github.com/dereferenced/api.github.com.deref.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226880,7 +226880,7 @@
226880226880
"/repos/{owner}/{repo}/commits/{commit_sha}/pulls": {
226881226881
"get": {
226882226882
"summary": "List pull requests associated with a commit",
226883-
"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.",
226883+
"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 only include open pull requests.",
226884226884
"tags": [
226885226885
"repos"
226886226886
],
@@ -279467,7 +279467,7 @@
279467279467
"/repos/{owner}/{repo}/issues": {
279468279468
"get": {
279469279469
"summary": "List repository issues",
279470-
"description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
279470+
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/rest/reference/pulls#list-pull-requests)\" endpoint.",
279471279471
"tags": [
279472279472
"issues"
279473279473
],

descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45575,8 +45575,8 @@ paths:
4557545575
summary: List pull requests associated with a commit
4557645576
description: Lists the merged pull request that introduced the commit to the
4557745577
repository. If the commit is not present in the default branch, additionally
45578-
returns open pull requests associated with the commit. The results may include
45579-
open and closed pull requests.
45578+
returns open pull requests associated with the commit. The results only include
45579+
open pull requests.
4558045580
tags:
4558145581
- repos
4558245582
operationId: repos/list-pull-requests-associated-with-commit
@@ -55352,7 +55352,7 @@ paths:
5535255352
get:
5535355353
summary: List repository issues
5535455354
description: |-
55355-
List issues in a repository.
55355+
List issues in a repository. Only open issues will be listed.
5535655356

5535755357
**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
5535855358
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by

descriptions-next/ghec/dereferenced/ghec.deref.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230339,7 +230339,7 @@
230339230339
"/repos/{owner}/{repo}/commits/{commit_sha}/pulls": {
230340230340
"get": {
230341230341
"summary": "List pull requests associated with a commit",
230342-
"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.",
230342+
"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 only include open pull requests.",
230343230343
"tags": [
230344230344
"repos"
230345230345
],
@@ -282926,7 +282926,7 @@
282926282926
"/repos/{owner}/{repo}/issues": {
282927282927
"get": {
282928282928
"summary": "List repository issues",
282929-
"description": "List issues in a repository.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests)\" endpoint.",
282929+
"description": "List issues in a repository. Only open issues will be listed.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/enterprise-cloud@latest//rest/reference/pulls#list-pull-requests)\" endpoint.",
282930282930
"tags": [
282931282931
"issues"
282932282932
],

descriptions-next/ghec/dereferenced/ghec.deref.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47098,8 +47098,8 @@ paths:
4709847098
summary: List pull requests associated with a commit
4709947099
description: Lists the merged pull request that introduced the commit to the
4710047100
repository. If the commit is not present in the default branch, additionally
47101-
returns open pull requests associated with the commit. The results may include
47102-
open and closed pull requests.
47101+
returns open pull requests associated with the commit. The results only include
47102+
open pull requests.
4710347103
tags:
4710447104
- repos
4710547105
operationId: repos/list-pull-requests-associated-with-commit
@@ -56876,7 +56876,7 @@ paths:
5687656876
get:
5687756877
summary: List repository issues
5687856878
description: |-
56879-
List issues in a repository.
56879+
List issues in a repository. Only open issues will be listed.
5688056880

5688156881
**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this
5688256882
reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by

0 commit comments

Comments
 (0)