Skip to content

Commit 4b8e654

Browse files
authored
Merge pull request #1635 from github/openapi-update-2fe06e0495af5024020a12ad94805e4303aa172fa0c8773cb60d37251a3a9613
Update OpenAPI 3.0 Descriptions
2 parents f3dca50 + 5aedeb3 commit 4b8e654

32 files changed

Lines changed: 74 additions & 74 deletions

descriptions/api.github.com/api.github.com.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29694,7 +29694,7 @@
2969429694
"/repos/{owner}/{repo}/commits/{commit_sha}/pulls": {
2969529695
"get": {
2969629696
"summary": "List pull requests associated with a commit",
29697-
"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.",
29697+
"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.",
2969829698
"tags": [
2969929699
"repos"
2970029700
],
@@ -35752,7 +35752,7 @@
3575235752
"/repos/{owner}/{repo}/issues": {
3575335753
"get": {
3575435754
"summary": "List repository issues",
35755-
"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.",
35755+
"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.",
3575635756
"tags": [
3575735757
"issues"
3575835758
],

descriptions/api.github.com/api.github.com.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21545,8 +21545,8 @@ paths:
2154521545
summary: List pull requests associated with a commit
2154621546
description: Lists the merged pull request that introduced the commit to the
2154721547
repository. If the commit is not present in the default branch, additionally
21548-
returns open pull requests associated with the commit. The results may include
21549-
open and closed pull requests.
21548+
returns open pull requests associated with the commit. The results only include
21549+
open pull requests.
2155021550
tags:
2155121551
- repos
2155221552
operationId: repos/list-pull-requests-associated-with-commit
@@ -26116,7 +26116,7 @@ paths:
2611626116
get:
2611726117
summary: List repository issues
2611826118
description: |-
26119-
List issues in a repository.
26119+
List issues in a repository. Only open issues will be listed.
2612026120

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193758,7 +193758,7 @@
193758193758
"/repos/{owner}/{repo}/commits/{commit_sha}/pulls": {
193759193759
"get": {
193760193760
"summary": "List pull requests associated with a commit",
193761-
"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.",
193761+
"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.",
193762193762
"tags": [
193763193763
"repos"
193764193764
],
@@ -238497,7 +238497,7 @@
238497238497
"/repos/{owner}/{repo}/issues": {
238498238498
"get": {
238499238499
"summary": "List repository issues",
238500-
"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.",
238500+
"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.",
238501238501
"tags": [
238502238502
"issues"
238503238503
],

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44374,8 +44374,8 @@ paths:
4437444374
summary: List pull requests associated with a commit
4437544375
description: Lists the merged pull request that introduced the commit to the
4437644376
repository. If the commit is not present in the default branch, additionally
44377-
returns open pull requests associated with the commit. The results may include
44378-
open and closed pull requests.
44377+
returns open pull requests associated with the commit. The results only include
44378+
open pull requests.
4437944379
tags:
4438044380
- repos
4438144381
operationId: repos/list-pull-requests-associated-with-commit
@@ -53952,7 +53952,7 @@ paths:
5395253952
get:
5395353953
summary: List repository issues
5395453954
description: |-
53955-
List issues in a repository.
53955+
List issues in a repository. Only open issues will be listed.
5395653956

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

0 commit comments

Comments
 (0)