Skip to content

Commit 700fa7c

Browse files
Commit via running ake Sources/issues
1 parent e8e4ea0 commit 700fa7c

File tree

2 files changed

+40
-80
lines changed

2 files changed

+40
-80
lines changed

Sources/issues/Client.swift

Lines changed: 10 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,8 @@ public struct Client: APIProtocol {
4444
/// repositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not
4545
/// necessarily assigned to you.
4646
///
47-
/// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
48-
/// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
49-
/// the `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
50-
/// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
47+
/// > [!NOTE]
48+
/// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `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 request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
5149
///
5250
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
5351
///
@@ -256,10 +254,8 @@ public struct Client: APIProtocol {
256254
///
257255
/// List issues in an organization assigned to the authenticated user.
258256
///
259-
/// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
260-
/// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
261-
/// the `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
262-
/// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
257+
/// > [!NOTE]
258+
/// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `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 request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
263259
///
264260
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
265261
///
@@ -599,10 +595,8 @@ public struct Client: APIProtocol {
599595
///
600596
/// List issues in a repository. Only open issues will be listed.
601597
///
602-
/// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
603-
/// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
604-
/// the `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
605-
/// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
598+
/// > [!NOTE]
599+
/// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `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 request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
606600
///
607601
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
608602
///
@@ -1708,10 +1702,8 @@ public struct Client: APIProtocol {
17081702
/// access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe
17091703
/// to the [`issues`](https://docs.github.com/webhooks/event-payloads/#issues) webhook.
17101704
///
1711-
/// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
1712-
/// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
1713-
/// the `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
1714-
/// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
1705+
/// > [!NOTE]
1706+
/// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `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 request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
17151707
///
17161708
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
17171709
///
@@ -4855,10 +4847,8 @@ public struct Client: APIProtocol {
48554847
///
48564848
/// List issues across owned and member repositories assigned to the authenticated user.
48574849
///
4858-
/// **Note**: GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this
4859-
/// reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by
4860-
/// the `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
4861-
/// request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
4850+
/// > [!NOTE]
4851+
/// > GitHub's REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `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 request id, use the "[List pull requests](https://docs.github.com/rest/pulls/pulls#list-pull-requests)" endpoint.
48624852
///
48634853
/// This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
48644854
///

0 commit comments

Comments
 (0)