Skip to content

Commit ed0cef5

Browse files
Commit via running ake Sources/checks
1 parent 56e1f44 commit ed0cef5

File tree

2 files changed

+76
-92
lines changed

2 files changed

+76
-92
lines changed

Sources/checks/Client.swift

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public struct Client: APIProtocol {
4242
///
4343
/// Creates a new check run for a specific commit in a repository.
4444
///
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.
4646
///
4747
/// 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.
4848
///
@@ -122,10 +122,10 @@ public struct Client: APIProtocol {
122122
///
123123
/// Gets a single check run using its `id`.
124124
///
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-
///
127125
/// **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.
128126
///
127+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
128+
///
129129
/// - Remark: HTTP `GET /repos/{owner}/{repo}/check-runs/{check_run_id}`.
130130
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/get(checks/get)`.
131131
public func checks_sol_get(_ input: Operations.checks_sol_get.Input) async throws -> Operations.checks_sol_get.Output {
@@ -192,10 +192,10 @@ public struct Client: APIProtocol {
192192
///
193193
/// Updates a check run for a specific commit in a repository.
194194
///
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-
///
197195
/// **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.
198196
///
197+
/// OAuth apps and personal access tokens (classic) cannot use this endpoint.
198+
///
199199
/// - Remark: HTTP `PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}`.
200200
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/patch(checks/update)`.
201201
public func checks_sol_update(_ input: Operations.checks_sol_update.Input) async throws -> Operations.checks_sol_update.Output {
@@ -271,11 +271,7 @@ public struct Client: APIProtocol {
271271
///
272272
/// Lists annotations for a check run using the annotation `id`.
273273
///
274-
/// GitHub Apps
275-
/// must have the `checks:read` permission on a private repository or pull access to
276-
/// a public repository to get annotations for a check run. OAuth apps and authenticated
277-
/// users must have the `repo` scope to get annotations for a check run in a private
278-
/// repository.
274+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
279275
///
280276
/// - Remark: HTTP `GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations`.
281277
/// - 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 {
365361
///
366362
/// 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.
367363
///
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-
///
370364
/// 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)".
371365
///
366+
/// OAuth apps and personal access tokens (classic) cannot use this endpoint.
367+
///
372368
/// - Remark: HTTP `POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest`.
373369
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest/post(checks/rerequest-run)`.
374370
public func checks_sol_rerequest_hyphen_run(_ input: Operations.checks_sol_rerequest_hyphen_run.Input) async throws -> Operations.checks_sol_rerequest_hyphen_run.Output {
@@ -501,10 +497,10 @@ public struct Client: APIProtocol {
501497
///
502498
/// 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)".
503499
///
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-
///
506500
/// **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`.
507501
///
502+
/// OAuth apps and personal access tokens (classic) cannot use this endpoint.
503+
///
508504
/// - Remark: HTTP `POST /repos/{owner}/{repo}/check-suites`.
509505
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/post(checks/create-suite)`.
510506
public func checks_sol_create_hyphen_suite(_ input: Operations.checks_sol_create_hyphen_suite.Input) async throws -> Operations.checks_sol_create_hyphen_suite.Output {
@@ -676,10 +672,10 @@ public struct Client: APIProtocol {
676672
///
677673
/// Gets a single check suite using its `id`.
678674
///
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-
///
681675
/// **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`.
682676
///
677+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
678+
///
683679
/// - Remark: HTTP `GET /repos/{owner}/{repo}/check-suites/{check_suite_id}`.
684680
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/get(checks/get-suite)`.
685681
public func checks_sol_get_hyphen_suite(_ input: Operations.checks_sol_get_hyphen_suite.Input) async throws -> Operations.checks_sol_get_hyphen_suite.Output {
@@ -746,10 +742,10 @@ public struct Client: APIProtocol {
746742
///
747743
/// Lists check runs for a check suite using its `id`.
748744
///
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-
///
751745
/// **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.
752746
///
747+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
748+
///
753749
/// - Remark: HTTP `GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs`.
754750
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs/get(checks/list-for-suite)`.
755751
public func checks_sol_list_hyphen_for_hyphen_suite(_ input: Operations.checks_sol_list_hyphen_for_hyphen_suite.Input) async throws -> Operations.checks_sol_list_hyphen_for_hyphen_suite.Output {
@@ -859,7 +855,7 @@ public struct Client: APIProtocol {
859855
///
860856
/// 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.
861857
///
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.
863859
///
864860
/// - Remark: HTTP `POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest`.
865861
/// - 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 {
927923
///
928924
/// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name.
929925
///
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-
///
932926
/// **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.
933927
///
934928
/// 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.
935929
///
930+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
931+
///
936932
/// - Remark: HTTP `GET /repos/{owner}/{repo}/commits/{ref}/check-runs`.
937933
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/commits/{ref}/check-runs/get(checks/list-for-ref)`.
938934
public func checks_sol_list_hyphen_for_hyphen_ref(_ input: Operations.checks_sol_list_hyphen_for_hyphen_ref.Input) async throws -> Operations.checks_sol_list_hyphen_for_hyphen_ref.Output {
@@ -1049,10 +1045,10 @@ public struct Client: APIProtocol {
10491045
///
10501046
/// Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name.
10511047
///
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-
///
10541048
/// **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`.
10551049
///
1050+
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository.
1051+
///
10561052
/// - Remark: HTTP `GET /repos/{owner}/{repo}/commits/{ref}/check-suites`.
10571053
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/commits/{ref}/check-suites/get(checks/list-suites-for-ref)`.
10581054
public func checks_sol_list_hyphen_suites_hyphen_for_hyphen_ref(_ input: Operations.checks_sol_list_hyphen_suites_hyphen_for_hyphen_ref.Input) async throws -> Operations.checks_sol_list_hyphen_suites_hyphen_for_hyphen_ref.Output {

0 commit comments

Comments
 (0)