You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Sources/checks/Client.swift
+16-8Lines changed: 16 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,8 @@ public struct Client: APIProtocol {
46
46
///
47
47
/// In a check suite, GitHub limits the number of check runs with the same name to 1000. Once these check runs exceed 1000, GitHub will start to automatically delete older check runs.
48
48
///
49
-
/// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
49
+
/// > [!NOTE]
50
+
/// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/post(checks/create)`.
@@ -122,7 +123,8 @@ public struct Client: APIProtocol {
122
123
///
123
124
/// Gets a single check run using its `id`.
124
125
///
125
-
/// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
126
+
/// > [!NOTE]
127
+
/// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
126
128
///
127
129
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
128
130
///
@@ -192,7 +194,8 @@ public struct Client: APIProtocol {
192
194
///
193
195
/// Updates a check run for a specific commit in a repository.
194
196
///
195
-
/// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
197
+
/// > [!NOTE]
198
+
/// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
196
199
///
197
200
/// OAuth apps and personal access tokens (classic) cannot use this endpoint.
198
201
///
@@ -497,7 +500,8 @@ public struct Client: APIProtocol {
497
500
///
498
501
/// Creates a check suite manually. By default, check suites are automatically created when you create a [check run](https://docs.github.com/rest/checks/runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using "[Update repository preferences for check suites](https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites)".
499
502
///
500
-
/// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
503
+
/// > [!NOTE]
504
+
/// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
501
505
///
502
506
/// OAuth apps and personal access tokens (classic) cannot use this endpoint.
503
507
///
@@ -672,7 +676,8 @@ public struct Client: APIProtocol {
672
676
///
673
677
/// Gets a single check suite using its `id`.
674
678
///
675
-
/// **Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
679
+
/// > [!NOTE]
680
+
/// > The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
676
681
///
677
682
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
678
683
///
@@ -742,7 +747,8 @@ public struct Client: APIProtocol {
742
747
///
743
748
/// Lists check runs for a check suite using its `id`.
744
749
///
745
-
/// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
750
+
/// > [!NOTE]
751
+
/// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
746
752
///
747
753
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
748
754
///
@@ -923,7 +929,8 @@ public struct Client: APIProtocol {
923
929
///
924
930
/// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.
925
931
///
926
-
/// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
932
+
/// > [!NOTE]
933
+
/// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
927
934
///
928
935
/// If there are more than 1000 check suites on a single git reference, this endpoint will limit check runs to the 1000 most recent check suites. To iterate over all possible check runs, use the [List check suites for a Git reference](https://docs.github.com/rest/reference/checks#list-check-suites-for-a-git-reference) endpoint and provide the `check_suite_id` parameter to the [List check runs in a check suite](https://docs.github.com/rest/reference/checks#list-check-runs-in-a-check-suite) endpoint.
929
936
///
@@ -1045,7 +1052,8 @@ public struct Client: APIProtocol {
1045
1052
///
1046
1053
/// Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.
1047
1054
///
1048
-
/// **Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
1055
+
/// > [!NOTE]
1056
+
/// > The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.
1049
1057
///
1050
1058
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
0 commit comments