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
+19-23Lines changed: 19 additions & 23 deletions
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ public struct Client: APIProtocol {
42
42
///
43
43
/// Creates a new check run for a specific commit in a repository.
44
44
///
45
-
/// To create a check run, you must use a GitHub App with the `checks:write` permission. OAuth apps and authenticated users are not able to create a check suite.
45
+
/// To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite.
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
///
@@ -122,10 +122,10 @@ public struct Client: APIProtocol {
122
122
///
123
123
/// Gets a single check run using its `id`.
124
124
///
125
-
/// GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.
126
-
///
127
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.
128
126
///
127
+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
@@ -192,10 +192,10 @@ public struct Client: APIProtocol {
192
192
///
193
193
/// Updates a check run for a specific commit in a repository.
194
194
///
195
-
/// To update a check run, you must use a GitHub App with the `checks:write` permission. OAuth apps and authenticated users are not able to update a check run.
196
-
///
197
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.
198
196
///
197
+
/// OAuth apps and personal access tokens (classic) cannot use this endpoint.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/annotations/get(checks/list-annotations)`.
@@ -365,10 +361,10 @@ public struct Client: APIProtocol {
365
361
///
366
362
/// Triggers GitHub to rerequest an existing check run, without pushing new code to a repository. This endpoint will trigger the [`check_run` webhook](https://docs.github.com/webhooks/event-payloads/#check_run) event with the action `rerequested`. When a check run is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
367
363
///
368
-
/// To rerequest a check run, you must use a GitHub App with the `checks:read` permission on a private repository or pull access to a public repository. OAuth apps and authenticated users are not able to rerequest a check run.
369
-
///
370
364
/// For more information about how to re-run GitHub Actions jobs, see "[Re-run a job from a workflow run](https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run)".
371
365
///
366
+
/// OAuth apps and personal access tokens (classic) cannot use this endpoint.
@@ -501,10 +497,10 @@ public struct Client: APIProtocol {
501
497
///
502
498
/// 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)".
503
499
///
504
-
/// To create a check suite, you must use a GitHub App with the `checks:write` permission. OAuth apps and authenticated users are not able to create a check suite.
505
-
///
506
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`.
507
501
///
502
+
/// OAuth apps and personal access tokens (classic) cannot use this endpoint.
@@ -676,10 +672,10 @@ public struct Client: APIProtocol {
676
672
///
677
673
/// Gets a single check suite using its `id`.
678
674
///
679
-
/// GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.
680
-
///
681
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`.
682
676
///
677
+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
@@ -746,10 +742,10 @@ public struct Client: APIProtocol {
746
742
///
747
743
/// Lists check runs for a check suite using its `id`.
748
744
///
749
-
/// GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.
750
-
///
751
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.
752
746
///
747
+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
@@ -859,7 +855,7 @@ public struct Client: APIProtocol {
859
855
///
860
856
/// Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.
861
857
///
862
-
/// To rerequest a check suite, you must use a GitHub App with the `checks:write` permission on a private repository or pull access to a public repository. OAuth apps and authenticated users are not able to rerequest a check suite.
858
+
/// OAuth apps and personal access tokens (classic) cannot use this endpoint.
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest/post(checks/rerequest-suite)`.
@@ -927,12 +923,12 @@ public struct Client: APIProtocol {
927
923
///
928
924
/// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.
929
925
///
930
-
/// GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth apps and authenticated users must have the `repo` scope to get check runs in a private repository.
931
-
///
932
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.
933
927
///
934
928
/// 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.
935
929
///
930
+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
@@ -1049,10 +1045,10 @@ public struct Client: APIProtocol {
1049
1045
///
1050
1046
/// Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.
1051
1047
///
1052
-
/// GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth apps and authenticated users must have the `repo` scope to get check suites in a private repository.
1053
-
///
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
1049
///
1050
+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
0 commit comments