Commit via running ake Sources/code-scanning

Author: dependabot[bot]

Sources/code-scanning/Client.swift

@@ -42,9 +42,9 @@ public struct Client: APIProtocol {
     ///
     /// Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see "[Managing security managers in your organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
     ///
-    /// To use this endpoint, you must be an owner or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope.
+    /// The authenticated user must be an owner or security manager for the organization to use this endpoint.
     ///
-    /// For public repositories, you may instead use the `public_repo` scope.
+    /// OAuth app tokens and personal access tokens (classic) need the `security_events` or `repo`s cope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
     ///
     /// - Remark: HTTP `GET /orgs/{org}/code-scanning/alerts`.
     /// - Remark: Generated from `#/paths//orgs/{org}/code-scanning/alerts/get(code-scanning/list-alerts-for-org)`.
@@ -232,12 +232,12 @@ public struct Client: APIProtocol {
     ///
     /// Lists code scanning alerts.
     ///
-    /// To use this endpoint, you must use an access token with the `security_events` scope or, for alerts from public repositories only, an access token with the `public_repo` scope.
-    ///
     /// The response includes a `most_recent_instance` object.
     /// This provides details of the most recent instance of this alert
     /// for the default branch (or for the specified Git reference if you used `ref` in the request).
     ///
+    /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+    ///
     /// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/alerts`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/alerts/get(code-scanning/list-alerts-for-repo)`.
     public func code_hyphen_scanning_sol_list_hyphen_alerts_hyphen_for_hyphen_repo(_ input: Operations.code_hyphen_scanning_sol_list_hyphen_alerts_hyphen_for_hyphen_repo.Input) async throws -> Operations.code_hyphen_scanning_sol_list_hyphen_alerts_hyphen_for_hyphen_repo.Output {
@@ -432,7 +432,9 @@ public struct Client: APIProtocol {
     }
     /// Get a code scanning alert
     ///
-    /// Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories, the `public_repo` scope also grants permission to read security events on public repositories only.
+    /// Gets a single code scanning alert.
+    ///
+    /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
     ///
     /// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/get(code-scanning/get-alert)`.
@@ -566,7 +568,8 @@ public struct Client: APIProtocol {
     }
     /// Update a code scanning alert
     ///
-    /// Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint with private repositories. You can also use tokens with the `public_repo` scope for public repositories only.
+    /// Updates the status of a single code scanning alert.
+    /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
     ///
     /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/patch(code-scanning/update-alert)`.
@@ -708,8 +711,8 @@ public struct Client: APIProtocol {
     /// List instances of a code scanning alert
     ///
     /// Lists all instances of the specified code scanning alert.
-    /// You must use an access token with the `security_events` scope to use this endpoint with private repositories,
-    /// the `public_repo` scope also grants permission to read security events on public repositories only.
+    ///
+    /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
     ///
     /// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances/get(code-scanning/list-alert-instances)`.
@@ -873,12 +876,11 @@ public struct Client: APIProtocol {
     /// For very old analyses this data is not available,
     /// and `0` is returned in this field.
     ///
-    /// You must use an access token with the `security_events` scope to use this endpoint with private repositories,
-    /// the `public_repo` scope also grants permission to read security events on public repositories only.
-    ///
     /// **Deprecation notice**:
     /// The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.
     ///
+    /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+    ///
     /// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/analyses`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/analyses/get(code-scanning/list-recent-analyses)`.
     public func code_hyphen_scanning_sol_list_hyphen_recent_hyphen_analyses(_ input: Operations.code_hyphen_scanning_sol_list_hyphen_recent_hyphen_analyses.Input) async throws -> Operations.code_hyphen_scanning_sol_list_hyphen_recent_hyphen_analyses.Output {
@@ -1066,9 +1068,6 @@ public struct Client: APIProtocol {
     ///
     /// Gets a specified code scanning analysis for a repository.
     ///
-    /// You must use an access token with the `security_events` scope to use this endpoint with private repositories,
-    /// the `public_repo` scope also grants permission to read security events on public repositories only.
-    ///
     /// The default JSON response contains fields that describe the analysis.
     /// This includes the Git reference and commit SHA to which the analysis relates,
     /// the datetime of the analysis, the name of the code scanning tool,
@@ -1083,6 +1082,8 @@ public struct Client: APIProtocol {
     ///
     /// - **`application/sarif+json`**: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). It also returns additional data such as the `github/alertNumber` and `github/alertUrl` properties.
     ///
+    /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+    ///
     /// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}/get(code-scanning/get-analysis)`.
     public func code_hyphen_scanning_sol_get_hyphen_analysis(_ input: Operations.code_hyphen_scanning_sol_get_hyphen_analysis.Input) async throws -> Operations.code_hyphen_scanning_sol_get_hyphen_analysis.Output {
@@ -1222,10 +1223,7 @@ public struct Client: APIProtocol {
     }
     /// Delete a code scanning analysis from a repository
     ///
-    /// Deletes a specified code scanning analysis from a repository. For
-    /// private repositories, you must use an access token with the `repo` scope. For public repositories,
-    /// you must use an access token with `public_repo` scope.
-    /// GitHub Apps must have the `security_events` write permission to use this endpoint.
+    /// Deletes a specified code scanning analysis from a repository.
     ///
     /// You can delete one analysis at a time.
     /// To delete a series of analyses, start with the most recent analysis and work backwards.
@@ -1288,6 +1286,8 @@ public struct Client: APIProtocol {
     ///
     /// The above process assumes that you want to remove all trace of the tool's analyses from the GitHub user interface, for the specified repository, and it therefore uses the `confirm_delete_url` value. Alternatively, you could use the `next_analysis_url` value, which would leave the last analysis in each set undeleted to avoid removing a tool's analysis entirely.
     ///
+    /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+    ///
     /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}/delete(code-scanning/delete-analysis)`.
     public func code_hyphen_scanning_sol_delete_hyphen_analysis(_ input: Operations.code_hyphen_scanning_sol_delete_hyphen_analysis.Input) async throws -> Operations.code_hyphen_scanning_sol_delete_hyphen_analysis.Output {
@@ -1458,8 +1458,7 @@ public struct Client: APIProtocol {
     ///
     /// Lists the CodeQL databases that are available in a repository.
     ///
-    /// For private repositories, you must use an access token with the `security_events` scope.
-    /// For public repositories, you can use tokens with the `security_events` or `public_repo` scope.
+    /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
     ///
     /// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/codeql/databases`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/codeql/databases/get(code-scanning/list-codeql-databases)`.
@@ -1598,8 +1597,7 @@ public struct Client: APIProtocol {
     /// your HTTP client is configured to follow redirects or use the `Location` header
     /// to make a second request to get the redirect URL.
     ///
-    /// For private repositories, you must use an access token with the `security_events` scope.
-    /// For public repositories, you can use tokens with the `security_events` or `public_repo` scope.
+    /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
     ///
     /// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/codeql/databases/{language}`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/codeql/databases/{language}/get(code-scanning/get-codeql-database)`.
@@ -1734,8 +1732,8 @@ public struct Client: APIProtocol {
     /// Get a code scanning default setup configuration
     ///
     /// Gets a code scanning default setup configuration.
-    /// You must use an access token with the `repo` scope to use this endpoint with private repositories or the `public_repo`
-    /// scope for public repositories.
+    ///
+    /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
     ///
     /// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/default-setup`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/default-setup/get(code-scanning/get-default-setup)`.
@@ -1867,8 +1865,8 @@ public struct Client: APIProtocol {
     /// Update a code scanning default setup configuration
     ///
     /// Updates a code scanning default setup configuration.
-    /// You must use an access token with the `repo` scope to use this endpoint with private repositories or the `public_repo`
-    /// scope for public repositories.
+    ///
+    /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
     ///
     /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/code-scanning/default-setup`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/default-setup/patch(code-scanning/update-default-setup)`.
@@ -2052,7 +2050,7 @@ public struct Client: APIProtocol {
     }
     /// Upload an analysis as SARIF data
     ///
-    /// Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint for private repositories. You can also use tokens with the `public_repo` scope for public repositories only. GitHub Apps must have the `security_events` write permission to use this endpoint. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)."
+    /// Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see "[Troubleshooting SARIF uploads](https://docs.github.com/code-security/code-scanning/troubleshooting-sarif)."
     ///
     /// There are two places where you can upload code scanning results.
     ///  - If you upload to a pull request, for example `--ref refs/pull/42/merge` or `--ref refs/pull/42/head`, then the results appear as alerts in a pull request check. For more information, see "[Triaging code scanning alerts in pull requests](/code-security/secure-coding/triaging-code-scanning-alerts-in-pull-requests)."
@@ -2083,6 +2081,8 @@ public struct Client: APIProtocol {
     /// You can use this ID to check the status of the upload by using it in the `/sarifs/{sarif_id}` endpoint.
     /// For more information, see "[Get information about a SARIF upload](/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload)."
     ///
+    /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
+    ///
     /// - Remark: HTTP `POST /repos/{owner}/{repo}/code-scanning/sarifs`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/sarifs/post(code-scanning/upload-sarif)`.
     public func code_hyphen_scanning_sol_upload_hyphen_sarif(_ input: Operations.code_hyphen_scanning_sol_upload_hyphen_sarif.Input) async throws -> Operations.code_hyphen_scanning_sol_upload_hyphen_sarif.Output {
@@ -2225,7 +2225,8 @@ public struct Client: APIProtocol {
     }
     /// Get information about a SARIF upload
     ///
-    /// Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint with private repositories, the `public_repo` scope also grants permission to read security events on public repositories only.
+    /// Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see "[Get a code scanning analysis for a repository](/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository)."
+    /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.
     ///
     /// - Remark: HTTP `GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}`.
     /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}/get(code-scanning/get-sarif)`.