From ec6dbfbb1016ae003c64ecf77119468eccd7d61f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 15 Feb 2024 21:58:44 +0000 Subject: [PATCH 01/20] Bump Submodule/github/rest-api-description from `2124d78` to `e3b351a` Bumps [Submodule/github/rest-api-description](https://github.com/github/rest-api-description) from `2124d78` to `e3b351a`. - [Release notes](https://github.com/github/rest-api-description/releases) - [Commits](https://github.com/github/rest-api-description/compare/2124d78cf5bbaeb1d75911b9f880e76ed0153ef4...e3b351abbafd1e19e95319d396f0513038f332b1) --- updated-dependencies: - dependency-name: Submodule/github/rest-api-description dependency-type: direct:production ... Signed-off-by: dependabot[bot] --- Submodule/github/rest-api-description | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Submodule/github/rest-api-description b/Submodule/github/rest-api-description index 2124d78cf5..e3b351abba 160000 --- a/Submodule/github/rest-api-description +++ b/Submodule/github/rest-api-description @@ -1 +1 @@ -Subproject commit 2124d78cf5bbaeb1d75911b9f880e76ed0153ef4 +Subproject commit e3b351abbafd1e19e95319d396f0513038f332b1 From 821b46a1ef21420c9c9a6b316f6b2d81743ebb64 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:10:06 +0000 Subject: [PATCH 02/20] Commit via running ake Sources/actions --- Sources/actions/Client.swift | 629 ++++---- Sources/actions/Types.swift | 2670 +++++++++++++--------------------- 2 files changed, 1316 insertions(+), 1983 deletions(-) diff --git a/Sources/actions/Client.swift b/Sources/actions/Client.swift index 6f79a7e1b7..d3a047c01d 100644 --- a/Sources/actions/Client.swift +++ b/Sources/actions/Client.swift @@ -42,7 +42,8 @@ public struct Client: APIProtocol { /// /// Gets the total GitHub Actions cache usage for an organization. /// The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - /// You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/cache/usage`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/cache/usage/get(actions/get-actions-cache-usage-for-org)`. @@ -116,7 +117,8 @@ public struct Client: APIProtocol { /// /// Lists repositories and their GitHub Actions cache usage for an organization. /// The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - /// You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/cache/usage-by-repository`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/cache/usage-by-repository/get(actions/get-actions-cache-usage-by-repo-for-org)`. @@ -204,7 +206,7 @@ public struct Client: APIProtocol { /// /// Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/get(actions/get-github-actions-permissions-organization)`. @@ -270,7 +272,7 @@ public struct Client: APIProtocol { /// /// Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/put(actions/set-github-actions-permissions-organization)`. @@ -321,7 +323,7 @@ public struct Client: APIProtocol { /// /// Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/get(actions/list-selected-repositories-enabled-github-actions-organization)`. @@ -401,7 +403,8 @@ public struct Client: APIProtocol { /// /// Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/put(actions/set-selected-repositories-enabled-github-actions-organization)`. @@ -452,7 +455,7 @@ public struct Client: APIProtocol { /// /// Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/{repository_id}/put(actions/enable-selected-repository-github-actions-organization)`. @@ -495,7 +498,7 @@ public struct Client: APIProtocol { /// /// Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/{repository_id}/delete(actions/disable-selected-repository-github-actions-organization)`. @@ -536,9 +539,9 @@ public struct Client: APIProtocol { } /// Get allowed actions and reusable workflows for an organization /// - /// Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + /// Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/selected-actions/get(actions/get-allowed-actions-organization)`. @@ -604,7 +607,7 @@ public struct Client: APIProtocol { /// /// Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/selected-actions/put(actions/set-allowed-actions-organization)`. @@ -659,7 +662,7 @@ public struct Client: APIProtocol { /// as well as whether GitHub Actions can submit approving pull request reviews. For more information, see /// "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/workflow/get(actions/get-github-actions-default-workflow-permissions-organization)`. @@ -727,7 +730,7 @@ public struct Client: APIProtocol { /// can submit approving pull request reviews. For more information, see /// "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/workflow/put(actions/set-github-actions-default-workflow-permissions-organization)`. @@ -780,10 +783,9 @@ public struct Client: APIProtocol { /// /// Lists all self-hosted runners configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/get(actions/list-self-hosted-runners-for-org)`. @@ -878,10 +880,9 @@ public struct Client: APIProtocol { /// /// Lists binaries for the runner application that you can download and run. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners/downloads`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/downloads/get(actions/list-runner-applications-for-org)`. @@ -947,10 +948,9 @@ public struct Client: APIProtocol { /// /// Generates a configuration that can be passed to the runner application at startup. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// The authenticated user must have admin access to the organization. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/generate-jitconfig`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/generate-jitconfig/post(actions/generate-runner-jitconfig-for-org)`. @@ -1069,19 +1069,16 @@ public struct Client: APIProtocol { /// /// Returns a token that you can pass to the `config` script. The token expires after one hour. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - /// - /// Example using registration token: - /// - /// Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: /// /// ``` /// ./config.sh --url https://github.com/octo-org --token TOKEN /// ``` /// + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/registration-token`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/registration-token/post(actions/create-registration-token-for-org)`. public func actions_sol_create_hyphen_registration_hyphen_token_hyphen_for_hyphen_org(_ input: Operations.actions_sol_create_hyphen_registration_hyphen_token_hyphen_for_hyphen_org.Input) async throws -> Operations.actions_sol_create_hyphen_registration_hyphen_token_hyphen_for_hyphen_org.Output { @@ -1146,20 +1143,16 @@ public struct Client: APIProtocol { /// /// Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - /// - /// Example using remove token: - /// - /// To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - /// endpoint. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: /// /// ``` /// ./config.sh remove --token TOKEN /// ``` /// + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/remove-token`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/remove-token/post(actions/create-remove-token-for-org)`. public func actions_sol_create_hyphen_remove_hyphen_token_hyphen_for_hyphen_org(_ input: Operations.actions_sol_create_hyphen_remove_hyphen_token_hyphen_for_hyphen_org.Input) async throws -> Operations.actions_sol_create_hyphen_remove_hyphen_token_hyphen_for_hyphen_org.Output { @@ -1224,10 +1217,9 @@ public struct Client: APIProtocol { /// /// Gets a specific self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/get(actions/get-self-hosted-runner-for-org)`. @@ -1294,10 +1286,9 @@ public struct Client: APIProtocol { /// /// Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/delete(actions/delete-self-hosted-runner-from-org)`. @@ -1340,10 +1331,9 @@ public struct Client: APIProtocol { /// /// Lists all labels for a self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/get(actions/list-labels-for-self-hosted-runner-for-org)`. @@ -1430,12 +1420,11 @@ public struct Client: APIProtocol { } /// Add custom labels to a self-hosted runner for an organization /// - /// Add custom labels to a self-hosted runner configured in an organization. + /// Adds custom labels to a self-hosted runner configured in an organization. + /// + /// Authenticated users must have admin access to the organization to use this endpoint. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/post(actions/add-custom-labels-to-self-hosted-runner-for-org)`. @@ -1556,10 +1545,9 @@ public struct Client: APIProtocol { /// Remove all previous custom labels and set the new custom labels for a specific /// self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/put(actions/set-custom-labels-for-self-hosted-runner-for-org)`. @@ -1680,10 +1668,9 @@ public struct Client: APIProtocol { /// Remove all custom labels from a self-hosted runner configured in an /// organization. Returns the remaining read-only labels from the runner. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/delete(actions/remove-all-custom-labels-from-self-hosted-runner-for-org)`. @@ -1776,10 +1763,9 @@ public struct Client: APIProtocol { /// This endpoint returns a `404 Not Found` status if the custom label is not /// present on the runner. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/runners/{runner_id}/labels/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/{name}/delete(actions/remove-custom-label-from-self-hosted-runner-for-org)`. @@ -1892,11 +1878,10 @@ public struct Client: APIProtocol { /// Lists all secrets available in an organization without revealing their /// encrypted values. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/get(actions/list-org-secrets)`. public func actions_sol_list_hyphen_org_hyphen_secrets(_ input: Operations.actions_sol_list_hyphen_org_hyphen_secrets.Input) async throws -> Operations.actions_sol_list_hyphen_org_hyphen_secrets.Output { @@ -1984,10 +1969,9 @@ public struct Client: APIProtocol { /// Gets your public key, which you need to encrypt secrets. You need to /// encrypt a secret before you can create or update secrets. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// The authenticated user must have collaborator access to a repository to create, update, or read secrets. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets/public-key`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/public-key/get(actions/get-org-public-key)`. @@ -2053,10 +2037,9 @@ public struct Client: APIProtocol { /// /// Gets a single organization secret without revealing its encrypted value. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// The authenticated user must have collaborator access to a repository to create, update, or read secrets + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/get(actions/get-org-secret)`. @@ -2124,11 +2107,10 @@ public struct Client: APIProtocol { /// Creates or updates an organization secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/put(actions/create-or-update-org-secret)`. public func actions_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret(_ input: Operations.actions_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret.Input) async throws -> Operations.actions_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret.Output { @@ -2205,11 +2187,10 @@ public struct Client: APIProtocol { /// /// Deletes a secret in an organization using the secret name. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/delete(actions/delete-org-secret)`. public func actions_sol_delete_hyphen_org_hyphen_secret(_ input: Operations.actions_sol_delete_hyphen_org_hyphen_secret.Input) async throws -> Operations.actions_sol_delete_hyphen_org_hyphen_secret.Output { @@ -2252,11 +2233,10 @@ public struct Client: APIProtocol { /// Lists all repositories that have been selected when the `visibility` /// for repository access to a secret is set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/get(actions/list-selected-repos-for-org-secret)`. public func actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret(_ input: Operations.actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Input) async throws -> Operations.actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Output { @@ -2338,11 +2318,10 @@ public struct Client: APIProtocol { /// for repository access is set to `selected`. The visibility is set when you [Create /// or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/put(actions/set-selected-repos-for-org-secret)`. public func actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret(_ input: Operations.actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Input) async throws -> Operations.actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Output { @@ -2392,14 +2371,13 @@ public struct Client: APIProtocol { /// Add selected repository to an organization secret /// /// Adds a repository to an organization secret when the `visibility` for - /// repository access is set to `selected`. The visibility is set when you [Create or + /// repository access is set to `selected`. For more information about setting the visibility, see [Create or /// update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}/put(actions/add-selected-repo-to-org-secret)`. public func actions_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret(_ input: Operations.actions_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret.Input) async throws -> Operations.actions_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret.Output { @@ -2446,11 +2424,10 @@ public struct Client: APIProtocol { /// for repository access is set to `selected`. The visibility is set when you [Create /// or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}/delete(actions/remove-selected-repo-from-org-secret)`. public func actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret(_ input: Operations.actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret.Input) async throws -> Operations.actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret.Output { @@ -2494,7 +2471,10 @@ public struct Client: APIProtocol { /// List organization variables /// /// Lists all organization variables. - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// + /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/variables`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/get(actions/list-org-variables)`. @@ -2582,11 +2562,10 @@ public struct Client: APIProtocol { /// /// Creates an organization variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/actions/variables`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/post(actions/create-org-variable)`. public func actions_sol_create_hyphen_org_hyphen_variable(_ input: Operations.actions_sol_create_hyphen_org_hyphen_variable.Input) async throws -> Operations.actions_sol_create_hyphen_org_hyphen_variable.Output { @@ -2660,10 +2639,9 @@ public struct Client: APIProtocol { /// /// Gets a specific variable in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// The authenticated user must have collaborator access to a repository to create, update, or read variables. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/get(actions/get-org-variable)`. @@ -2730,11 +2708,10 @@ public struct Client: APIProtocol { /// /// Updates an organization variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `PATCH /orgs/{org}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/patch(actions/update-org-variable)`. public func actions_sol_update_hyphen_org_hyphen_variable(_ input: Operations.actions_sol_update_hyphen_org_hyphen_variable.Input) async throws -> Operations.actions_sol_update_hyphen_org_hyphen_variable.Output { @@ -2785,11 +2762,10 @@ public struct Client: APIProtocol { /// /// Deletes an organization variable using the variable name. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/delete(actions/delete-org-variable)`. public func actions_sol_delete_hyphen_org_hyphen_variable(_ input: Operations.actions_sol_delete_hyphen_org_hyphen_variable.Input) async throws -> Operations.actions_sol_delete_hyphen_org_hyphen_variable.Output { @@ -2832,11 +2808,10 @@ public struct Client: APIProtocol { /// Lists all repositories that can access an organization variable /// that is available to selected repositories. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `GET /orgs/{org}/actions/variables/{name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/get(actions/list-selected-repos-for-org-variable)`. public func actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable(_ input: Operations.actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable.Input) async throws -> Operations.actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable.Output { @@ -2920,12 +2895,10 @@ public struct Client: APIProtocol { /// to selected repositories. Organization variables that are available to selected /// repositories have their `visibility` field set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this - /// endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/variables/{name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/put(actions/set-selected-repos-for-org-variable)`. public func actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable(_ input: Operations.actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable.Input) async throws -> Operations.actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable.Output { @@ -2979,10 +2952,9 @@ public struct Client: APIProtocol { /// Adds a repository to an organization variable that is available to selected repositories. /// Organization variables that are available to selected repositories have their `visibility` field set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/variables/{name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/{repository_id}/put(actions/add-selected-repo-to-org-variable)`. @@ -3030,11 +3002,10 @@ public struct Client: APIProtocol { /// available to selected repositories. Organization variables that are available to /// selected repositories have their `visibility` field set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/variables/{name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/{repository_id}/delete(actions/remove-selected-repo-from-org-variable)`. public func actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_variable(_ input: Operations.actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_variable.Input) async throws -> Operations.actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_variable.Output { @@ -3077,7 +3048,11 @@ public struct Client: APIProtocol { } /// List artifacts for a repository /// - /// Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Lists all artifacts for a repository. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/artifacts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/get(actions/list-artifacts-for-repo)`. @@ -3171,7 +3146,11 @@ public struct Client: APIProtocol { } /// Get an artifact /// - /// Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific artifact for a workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/{artifact_id}/get(actions/get-artifact)`. @@ -3237,7 +3216,8 @@ public struct Client: APIProtocol { } /// Delete an artifact /// - /// Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// Deletes an artifact for a workflow run. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/{artifact_id}/delete(actions/delete-artifact)`. @@ -3282,8 +3262,7 @@ public struct Client: APIProtocol { /// Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in /// the response header to find the URL for the download. The `:archive_format` must be `zip`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:read` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}/get(actions/download-artifact)`. @@ -3359,7 +3338,10 @@ public struct Client: APIProtocol { /// /// Gets GitHub Actions cache usage for a repository. /// The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/cache/usage`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/cache/usage/get(actions/get-actions-cache-usage)`. @@ -3425,8 +3407,8 @@ public struct Client: APIProtocol { /// List GitHub Actions caches for a repository /// /// Lists the GitHub Actions caches for a repository. - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/caches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/caches/get(actions/get-actions-cache-list)`. @@ -3543,9 +3525,7 @@ public struct Client: APIProtocol { /// /// Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/caches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/caches/delete(actions/delete-actions-cache-by-key)`. @@ -3626,9 +3606,7 @@ public struct Client: APIProtocol { /// /// Deletes a GitHub Actions cache for a repository, using a cache ID. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/caches/{cache_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/caches/{cache_id}/delete(actions/delete-actions-cache-by-id)`. @@ -3670,7 +3648,11 @@ public struct Client: APIProtocol { } /// Get a job for a workflow run /// - /// Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific job in a workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/jobs/{job_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/jobs/{job_id}/get(actions/get-job-for-workflow-run)`. @@ -3737,9 +3719,11 @@ public struct Client: APIProtocol { /// Download job logs for a workflow run /// /// Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look - /// for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can - /// use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must - /// have the `actions:read` permission to use this endpoint. + /// for `Location:` in the response header to find the URL for the download. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/jobs/{job_id}/logs/get(actions/download-job-logs-for-workflow-run)`. @@ -3788,8 +3772,7 @@ public struct Client: APIProtocol { /// /// Re-run a job and its dependent jobs in a workflow run. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/jobs/{job_id}/rerun/post(actions/re-run-job-for-workflow-run)`. @@ -3889,8 +3872,8 @@ public struct Client: APIProtocol { /// Get the customization template for an OIDC subject claim for a repository /// /// Gets the customization template for an OpenID Connect (OIDC) subject claim. - /// You must authenticate using an access token with the `repo` scope to use this - /// endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/oidc/customization/sub/get(actions/get-custom-oidc-sub-claim-for-repo)`. @@ -4009,8 +3992,8 @@ public struct Client: APIProtocol { /// Set the customization template for an OIDC subject claim for a repository /// /// Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - /// You must authenticate using an access token with the `repo` scope to use this - /// endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/oidc/customization/sub/put(actions/set-custom-oidc-sub-claim-for-repo)`. @@ -4162,10 +4145,10 @@ public struct Client: APIProtocol { /// Lists all organization secrets shared with a repository without revealing their encrypted /// values. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/organization-secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/organization-secrets/get(actions/list-repo-organization-secrets)`. public func actions_sol_list_hyphen_repo_hyphen_organization_hyphen_secrets(_ input: Operations.actions_sol_list_hyphen_repo_hyphen_organization_hyphen_secrets.Input) async throws -> Operations.actions_sol_list_hyphen_repo_hyphen_organization_hyphen_secrets.Output { @@ -4251,12 +4234,12 @@ public struct Client: APIProtocol { } /// List repository organization variables /// - /// Lists all organiation variables shared with a repository. + /// Lists all organization variables shared with a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/organization-variables`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/organization-variables/get(actions/list-repo-organization-variables)`. public func actions_sol_list_hyphen_repo_hyphen_organization_hyphen_variables(_ input: Operations.actions_sol_list_hyphen_repo_hyphen_organization_hyphen_variables.Input) async throws -> Operations.actions_sol_list_hyphen_repo_hyphen_organization_hyphen_variables.Output { @@ -4344,7 +4327,7 @@ public struct Client: APIProtocol { /// /// Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/get(actions/get-github-actions-permissions-repository)`. @@ -4411,7 +4394,7 @@ public struct Client: APIProtocol { /// /// Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/put(actions/set-github-actions-permissions-repository)`. @@ -4465,8 +4448,7 @@ public struct Client: APIProtocol { /// This endpoint only applies to private repositories. /// For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - /// repository `administration` permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions/access`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/access/get(actions/get-workflow-access-to-repository)`. @@ -4535,8 +4517,7 @@ public struct Client: APIProtocol { /// This endpoint only applies to private repositories. /// For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - /// repository `administration` permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions/access`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/access/put(actions/set-workflow-access-to-repository)`. @@ -4588,7 +4569,7 @@ public struct Client: APIProtocol { /// /// Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/selected-actions/get(actions/get-allowed-actions-repository)`. @@ -4655,7 +4636,7 @@ public struct Client: APIProtocol { /// /// Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/selected-actions/put(actions/set-allowed-actions-repository)`. @@ -4711,7 +4692,7 @@ public struct Client: APIProtocol { /// as well as if GitHub Actions can submit approving pull request reviews. /// For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/workflow/get(actions/get-github-actions-default-workflow-permissions-repository)`. @@ -4780,7 +4761,7 @@ public struct Client: APIProtocol { /// can submit approving pull request reviews. /// For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/workflow/put(actions/set-github-actions-default-workflow-permissions-repository)`. @@ -4834,9 +4815,9 @@ public struct Client: APIProtocol { /// /// Lists all self-hosted runners configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/get(actions/list-self-hosted-runners-for-repo)`. @@ -4932,9 +4913,9 @@ public struct Client: APIProtocol { /// /// Lists binaries for the runner application that you can download and run. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners/downloads`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/downloads/get(actions/list-runner-applications-for-repo)`. @@ -5001,9 +4982,9 @@ public struct Client: APIProtocol { /// /// Generates a configuration that can be passed to the runner application at startup. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// The authenticated user must have admin access to the repository. + /// + /// OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/generate-jitconfig`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/generate-jitconfig/post(actions/generate-runner-jitconfig-for-repo)`. @@ -5121,19 +5102,17 @@ public struct Client: APIProtocol { } /// Create a registration token for a repository /// - /// Returns a token that you can pass to the `config` script. The token - /// expires after one hour. + /// Returns a token that you can pass to the `config` script. The token expires after one hour. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: /// - /// Example using registration token: + /// ``` + /// ./config.sh --url https://github.com/octo-org --token TOKEN + /// ``` /// - /// Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - /// by this endpoint. + /// Authenticated users must have admin access to the repository to use this endpoint. /// - /// ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/registration-token`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/registration-token/post(actions/create-registration-token-for-repo)`. @@ -5198,19 +5177,17 @@ public struct Client: APIProtocol { } /// Create a remove token for a repository /// - /// Returns a token that you can pass to remove a self-hosted runner from - /// a repository. The token expires after one hour. + /// Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: /// - /// Example using remove token: + /// ``` + /// ./config.sh remove --token TOKEN + /// ``` /// - /// To remove your self-hosted runner from a repository, replace TOKEN with - /// the remove token provided by this endpoint. + /// Authenticated users must have admin access to the repository to use this endpoint. /// - /// ```config.sh remove --token TOKEN``` + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/remove-token`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/remove-token/post(actions/create-remove-token-for-repo)`. @@ -5277,9 +5254,9 @@ public struct Client: APIProtocol { /// /// Gets a specific self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/get(actions/get-self-hosted-runner-for-repo)`. @@ -5347,9 +5324,9 @@ public struct Client: APIProtocol { /// /// Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/delete(actions/delete-self-hosted-runner-from-repo)`. @@ -5393,9 +5370,9 @@ public struct Client: APIProtocol { /// /// Lists all labels for a self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/get(actions/list-labels-for-self-hosted-runner-for-repo)`. @@ -5483,11 +5460,11 @@ public struct Client: APIProtocol { } /// Add custom labels to a self-hosted runner for a repository /// - /// Add custom labels to a self-hosted runner configured in a repository. + /// Adds custom labels to a self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/post(actions/add-custom-labels-to-self-hosted-runner-for-repo)`. @@ -5609,9 +5586,9 @@ public struct Client: APIProtocol { /// Remove all previous custom labels and set the new custom labels for a specific /// self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/put(actions/set-custom-labels-for-self-hosted-runner-for-repo)`. @@ -5733,9 +5710,9 @@ public struct Client: APIProtocol { /// Remove all custom labels from a self-hosted runner configured in a /// repository. Returns the remaining read-only labels from the runner. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/delete(actions/remove-all-custom-labels-from-self-hosted-runner-for-repo)`. @@ -5829,9 +5806,9 @@ public struct Client: APIProtocol { /// This endpoint returns a `404 Not Found` status if the custom label is not /// present on the runner. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}/delete(actions/remove-custom-label-from-self-hosted-runner-for-repo)`. @@ -5944,7 +5921,9 @@ public struct Client: APIProtocol { /// /// Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/get(actions/list-workflow-runs-for-repo)`. @@ -6087,7 +6066,11 @@ public struct Client: APIProtocol { } /// Get a workflow run /// - /// Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/get(actions/get-workflow-run)`. @@ -6160,9 +6143,11 @@ public struct Client: APIProtocol { } /// Delete a workflow run /// - /// Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is - /// private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use - /// this endpoint. + /// Deletes a specific workflow run. + /// + /// Anyone with write access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runs/{run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/delete(actions/delete-workflow-run)`. @@ -6204,7 +6189,9 @@ public struct Client: APIProtocol { } /// Get the review history for a workflow run /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/approvals/get(actions/get-reviews-for-run)`. @@ -6272,7 +6259,7 @@ public struct Client: APIProtocol { /// /// Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/approve/post(actions/approve-workflow-run)`. @@ -6382,7 +6369,11 @@ public struct Client: APIProtocol { } /// List workflow run artifacts /// - /// Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Lists artifacts for a workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/artifacts/get(actions/list-workflow-run-artifacts)`. @@ -6477,10 +6468,11 @@ public struct Client: APIProtocol { } /// Get a workflow run attempt /// - /// Gets a specific workflow run attempt. Anyone with read access to the repository - /// can use this endpoint. If the repository is private you must use an access token - /// with the `repo` scope. GitHub Apps must have the `actions:read` permission to - /// use this endpoint. + /// Gets a specific workflow run attempt. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/get(actions/get-workflow-run-attempt)`. @@ -6554,7 +6546,12 @@ public struct Client: APIProtocol { } /// List jobs for a workflow run attempt /// - /// Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information + /// about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs/get(actions/list-jobs-for-workflow-run-attempt)`. @@ -6666,9 +6663,11 @@ public struct Client: APIProtocol { /// Download workflow run attempt logs /// /// Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - /// 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to - /// the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. - /// GitHub Apps must have the `actions:read` permission to use this endpoint. + /// 1 minute. Look for `Location:` in the response header to find the URL for the download. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs/get(actions/download-workflow-run-attempt-logs)`. @@ -6718,8 +6717,7 @@ public struct Client: APIProtocol { /// /// Cancels a workflow run using its `id`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/cancel/post(actions/cancel-workflow-run)`. @@ -6812,8 +6810,7 @@ public struct Client: APIProtocol { /// **Note:** GitHub Apps can only review their own custom deployment protection rules. /// To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). /// - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have read and write permission for **Deployments** to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule/post(actions/review-custom-gates-for-run)`. @@ -6867,8 +6864,7 @@ public struct Client: APIProtocol { /// Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. /// You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel/post(actions/force-cancel-workflow-run)`. @@ -6956,7 +6952,12 @@ public struct Client: APIProtocol { } /// List jobs for a workflow run /// - /// Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information + /// about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/jobs/get(actions/list-jobs-for-workflow-run)`. @@ -7052,9 +7053,11 @@ public struct Client: APIProtocol { /// Download workflow run logs /// /// Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - /// `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use - /// this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have - /// the `actions:read` permission to use this endpoint. + /// `Location:` in the response header to find the URL for the download. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/logs/get(actions/download-workflow-run-logs)`. @@ -7101,7 +7104,9 @@ public struct Client: APIProtocol { } /// Delete workflow run logs /// - /// Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// Deletes all logs for a workflow run. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/logs/delete(actions/delete-workflow-run-logs)`. @@ -7193,7 +7198,9 @@ public struct Client: APIProtocol { /// /// Get all deployment environments for a workflow run that are waiting for protection rules to pass. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments/get(actions/get-pending-deployments-for-run)`. @@ -7261,7 +7268,9 @@ public struct Client: APIProtocol { /// /// Approve or reject pending deployments that are waiting on approval by a required reviewer. /// - /// Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. + /// Required reviewers with read access to the repository contents and deployments can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments/post(actions/review-pending-deployments-for-run)`. @@ -7336,7 +7345,9 @@ public struct Client: APIProtocol { } /// Re-run a workflow /// - /// Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// Re-runs your workflow run using its `id`. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/rerun/post(actions/re-run-workflow)`. @@ -7413,7 +7424,9 @@ public struct Client: APIProtocol { } /// Re-run failed jobs from a workflow run /// - /// Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. + /// Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs/post(actions/re-run-workflow-failed-jobs)`. @@ -7492,7 +7505,9 @@ public struct Client: APIProtocol { /// /// Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/timing/get(actions/get-workflow-run-usage)`. @@ -7561,10 +7576,10 @@ public struct Client: APIProtocol { /// Lists all secrets available in a repository without revealing their encrypted /// values. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/get(actions/list-repo-secrets)`. public func actions_sol_list_hyphen_repo_hyphen_secrets(_ input: Operations.actions_sol_list_hyphen_repo_hyphen_secrets.Input) async throws -> Operations.actions_sol_list_hyphen_repo_hyphen_secrets.Output { @@ -7654,9 +7669,8 @@ public struct Client: APIProtocol { /// encrypt a secret before you can create or update secrets. /// /// Anyone with read access to the repository can use this endpoint. - /// If the repository is private you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/secrets/public-key`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/public-key/get(actions/get-repo-public-key)`. @@ -7723,9 +7737,9 @@ public struct Client: APIProtocol { /// /// Gets a single repository secret without revealing its encrypted value. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// The authenticated user must have collaborator access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/{secret_name}/get(actions/get-repo-secret)`. @@ -7794,10 +7808,10 @@ public struct Client: APIProtocol { /// Creates or updates a repository secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/{secret_name}/put(actions/create-or-update-repo-secret)`. public func actions_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret(_ input: Operations.actions_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret.Input) async throws -> Operations.actions_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret.Output { @@ -7875,10 +7889,10 @@ public struct Client: APIProtocol { /// /// Deletes a secret in a repository using the secret name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/{secret_name}/delete(actions/delete-repo-secret)`. public func actions_sol_delete_hyphen_repo_hyphen_secret(_ input: Operations.actions_sol_delete_hyphen_repo_hyphen_secret.Input) async throws -> Operations.actions_sol_delete_hyphen_repo_hyphen_secret.Output { @@ -7920,10 +7934,11 @@ public struct Client: APIProtocol { /// List repository variables /// /// Lists all repository variables. - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + /// /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/variables`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/get(actions/list-repo-variables)`. public func actions_sol_list_hyphen_repo_hyphen_variables(_ input: Operations.actions_sol_list_hyphen_repo_hyphen_variables.Input) async throws -> Operations.actions_sol_list_hyphen_repo_hyphen_variables.Output { @@ -8011,10 +8026,10 @@ public struct Client: APIProtocol { /// /// Creates a repository variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/variables`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/post(actions/create-repo-variable)`. public func actions_sol_create_hyphen_repo_hyphen_variable(_ input: Operations.actions_sol_create_hyphen_repo_hyphen_variable.Input) async throws -> Operations.actions_sol_create_hyphen_repo_hyphen_variable.Output { @@ -8089,9 +8104,9 @@ public struct Client: APIProtocol { /// /// Gets a specific variable in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// The authenticated user must have collaborator access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/{name}/get(actions/get-repo-variable)`. @@ -8159,10 +8174,10 @@ public struct Client: APIProtocol { /// /// Updates a repository variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/{name}/patch(actions/update-repo-variable)`. public func actions_sol_update_hyphen_repo_hyphen_variable(_ input: Operations.actions_sol_update_hyphen_repo_hyphen_variable.Input) async throws -> Operations.actions_sol_update_hyphen_repo_hyphen_variable.Output { @@ -8214,10 +8229,10 @@ public struct Client: APIProtocol { /// /// Deletes a repository variable using the variable name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/{name}/delete(actions/delete-repo-variable)`. public func actions_sol_delete_hyphen_repo_hyphen_variable(_ input: Operations.actions_sol_delete_hyphen_repo_hyphen_variable.Input) async throws -> Operations.actions_sol_delete_hyphen_repo_hyphen_variable.Output { @@ -8258,7 +8273,11 @@ public struct Client: APIProtocol { } /// List repository workflows /// - /// Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Lists the workflows in a repository. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/get(actions/list-repo-workflows)`. @@ -8345,7 +8364,12 @@ public struct Client: APIProtocol { } /// Get a workflow /// - /// Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific workflow. You can replace `workflow_id` with the workflow + /// file name. For example, you could use `main.yaml`. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/get(actions/get-workflow)`. @@ -8413,7 +8437,7 @@ public struct Client: APIProtocol { /// /// Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable/put(actions/disable-workflow)`. @@ -8459,7 +8483,7 @@ public struct Client: APIProtocol { /// /// You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches/post(actions/create-workflow-dispatch)`. @@ -8512,7 +8536,7 @@ public struct Client: APIProtocol { /// /// Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable/put(actions/enable-workflow)`. @@ -8556,7 +8580,9 @@ public struct Client: APIProtocol { /// /// List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + /// Anyone with read access to the repository can use this endpoint + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs/get(actions/list-workflow-runs)`. @@ -8702,7 +8728,11 @@ public struct Client: APIProtocol { /// /// Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing/get(actions/get-workflow-usage)`. @@ -8771,10 +8801,10 @@ public struct Client: APIProtocol { /// Lists all secrets available in an environment without revealing their /// encrypted values. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/secrets`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/get(actions/list-environment-secrets)`. public func actions_sol_list_hyphen_environment_hyphen_secrets(_ input: Operations.actions_sol_list_hyphen_environment_hyphen_secrets.Input) async throws -> Operations.actions_sol_list_hyphen_environment_hyphen_secrets.Output { @@ -8864,9 +8894,8 @@ public struct Client: APIProtocol { /// secrets. You need to encrypt a secret before you can create or update secrets. /// /// Anyone with read access to the repository can use this endpoint. - /// If the repository is private you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/public-key/get(actions/get-environment-public-key)`. @@ -8933,10 +8962,10 @@ public struct Client: APIProtocol { /// /// Gets a single environment secret without revealing its encrypted value. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}/get(actions/get-environment-secret)`. public func actions_sol_get_hyphen_environment_hyphen_secret(_ input: Operations.actions_sol_get_hyphen_environment_hyphen_secret.Input) async throws -> Operations.actions_sol_get_hyphen_environment_hyphen_secret.Output { @@ -9004,10 +9033,10 @@ public struct Client: APIProtocol { /// Creates or updates an environment secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}/put(actions/create-or-update-environment-secret)`. public func actions_sol_create_hyphen_or_hyphen_update_hyphen_environment_hyphen_secret(_ input: Operations.actions_sol_create_hyphen_or_hyphen_update_hyphen_environment_hyphen_secret.Input) async throws -> Operations.actions_sol_create_hyphen_or_hyphen_update_hyphen_environment_hyphen_secret.Output { @@ -9085,10 +9114,10 @@ public struct Client: APIProtocol { /// /// Deletes a secret in an environment using the secret name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}/delete(actions/delete-environment-secret)`. public func actions_sol_delete_hyphen_environment_hyphen_secret(_ input: Operations.actions_sol_delete_hyphen_environment_hyphen_secret.Input) async throws -> Operations.actions_sol_delete_hyphen_environment_hyphen_secret.Output { @@ -9131,10 +9160,10 @@ public struct Client: APIProtocol { /// /// Lists all environment variables. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environments:read` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/variables`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/get(actions/list-environment-variables)`. public func actions_sol_list_hyphen_environment_hyphen_variables(_ input: Operations.actions_sol_list_hyphen_environment_hyphen_variables.Input) async throws -> Operations.actions_sol_list_hyphen_environment_hyphen_variables.Output { @@ -9222,10 +9251,10 @@ public struct Client: APIProtocol { /// /// Create an environment variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environment:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repositories/{repository_id}/environments/{environment_name}/variables`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/post(actions/create-environment-variable)`. public func actions_sol_create_hyphen_environment_hyphen_variable(_ input: Operations.actions_sol_create_hyphen_environment_hyphen_variable.Input) async throws -> Operations.actions_sol_create_hyphen_environment_hyphen_variable.Output { @@ -9300,10 +9329,10 @@ public struct Client: APIProtocol { /// /// Gets a specific variable in an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environments:read` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/variables/{name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/{name}/get(actions/get-environment-variable)`. public func actions_sol_get_hyphen_environment_hyphen_variable(_ input: Operations.actions_sol_get_hyphen_environment_hyphen_variable.Input) async throws -> Operations.actions_sol_get_hyphen_environment_hyphen_variable.Output { @@ -9370,10 +9399,10 @@ public struct Client: APIProtocol { /// /// Updates an environment variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environment:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /repositories/{repository_id}/environments/{environment_name}/variables/{name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/{name}/patch(actions/update-environment-variable)`. public func actions_sol_update_hyphen_environment_hyphen_variable(_ input: Operations.actions_sol_update_hyphen_environment_hyphen_variable.Input) async throws -> Operations.actions_sol_update_hyphen_environment_hyphen_variable.Output { @@ -9425,10 +9454,10 @@ public struct Client: APIProtocol { /// /// Deletes an environment variable using the variable name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environment:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/{name}/delete(actions/delete-environment-variable)`. public func actions_sol_delete_hyphen_environment_hyphen_variable(_ input: Operations.actions_sol_delete_hyphen_environment_hyphen_variable.Input) async throws -> Operations.actions_sol_delete_hyphen_environment_hyphen_variable.Output { diff --git a/Sources/actions/Types.swift b/Sources/actions/Types.swift index 4ea0e43426..33e6573b66 100644 --- a/Sources/actions/Types.swift +++ b/Sources/actions/Types.swift @@ -15,7 +15,8 @@ public protocol APIProtocol: Sendable { /// /// Gets the total GitHub Actions cache usage for an organization. /// The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - /// You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/cache/usage`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/cache/usage/get(actions/get-actions-cache-usage-for-org)`. @@ -24,7 +25,8 @@ public protocol APIProtocol: Sendable { /// /// Lists repositories and their GitHub Actions cache usage for an organization. /// The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - /// You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/cache/usage-by-repository`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/cache/usage-by-repository/get(actions/get-actions-cache-usage-by-repo-for-org)`. @@ -33,7 +35,7 @@ public protocol APIProtocol: Sendable { /// /// Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/get(actions/get-github-actions-permissions-organization)`. @@ -42,7 +44,7 @@ public protocol APIProtocol: Sendable { /// /// Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/put(actions/set-github-actions-permissions-organization)`. @@ -51,7 +53,7 @@ public protocol APIProtocol: Sendable { /// /// Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/get(actions/list-selected-repositories-enabled-github-actions-organization)`. @@ -60,7 +62,8 @@ public protocol APIProtocol: Sendable { /// /// Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/put(actions/set-selected-repositories-enabled-github-actions-organization)`. @@ -69,7 +72,7 @@ public protocol APIProtocol: Sendable { /// /// Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/{repository_id}/put(actions/enable-selected-repository-github-actions-organization)`. @@ -78,16 +81,16 @@ public protocol APIProtocol: Sendable { /// /// Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/{repository_id}/delete(actions/disable-selected-repository-github-actions-organization)`. func actions_sol_disable_hyphen_selected_hyphen_repository_hyphen_github_hyphen_actions_hyphen_organization(_ input: Operations.actions_sol_disable_hyphen_selected_hyphen_repository_hyphen_github_hyphen_actions_hyphen_organization.Input) async throws -> Operations.actions_sol_disable_hyphen_selected_hyphen_repository_hyphen_github_hyphen_actions_hyphen_organization.Output /// Get allowed actions and reusable workflows for an organization /// - /// Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + /// Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/selected-actions/get(actions/get-allowed-actions-organization)`. @@ -96,7 +99,7 @@ public protocol APIProtocol: Sendable { /// /// Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/selected-actions/put(actions/set-allowed-actions-organization)`. @@ -107,7 +110,7 @@ public protocol APIProtocol: Sendable { /// as well as whether GitHub Actions can submit approving pull request reviews. For more information, see /// "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/workflow/get(actions/get-github-actions-default-workflow-permissions-organization)`. @@ -118,7 +121,7 @@ public protocol APIProtocol: Sendable { /// can submit approving pull request reviews. For more information, see /// "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/workflow/put(actions/set-github-actions-default-workflow-permissions-organization)`. @@ -127,10 +130,9 @@ public protocol APIProtocol: Sendable { /// /// Lists all self-hosted runners configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/get(actions/list-self-hosted-runners-for-org)`. @@ -139,10 +141,9 @@ public protocol APIProtocol: Sendable { /// /// Lists binaries for the runner application that you can download and run. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners/downloads`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/downloads/get(actions/list-runner-applications-for-org)`. @@ -151,10 +152,9 @@ public protocol APIProtocol: Sendable { /// /// Generates a configuration that can be passed to the runner application at startup. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// The authenticated user must have admin access to the organization. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/generate-jitconfig`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/generate-jitconfig/post(actions/generate-runner-jitconfig-for-org)`. @@ -163,19 +163,16 @@ public protocol APIProtocol: Sendable { /// /// Returns a token that you can pass to the `config` script. The token expires after one hour. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - /// - /// Example using registration token: - /// - /// Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: /// /// ``` /// ./config.sh --url https://github.com/octo-org --token TOKEN /// ``` /// + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/registration-token`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/registration-token/post(actions/create-registration-token-for-org)`. func actions_sol_create_hyphen_registration_hyphen_token_hyphen_for_hyphen_org(_ input: Operations.actions_sol_create_hyphen_registration_hyphen_token_hyphen_for_hyphen_org.Input) async throws -> Operations.actions_sol_create_hyphen_registration_hyphen_token_hyphen_for_hyphen_org.Output @@ -183,20 +180,16 @@ public protocol APIProtocol: Sendable { /// /// Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - /// - /// Example using remove token: - /// - /// To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - /// endpoint. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: /// /// ``` /// ./config.sh remove --token TOKEN /// ``` /// + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/remove-token`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/remove-token/post(actions/create-remove-token-for-org)`. func actions_sol_create_hyphen_remove_hyphen_token_hyphen_for_hyphen_org(_ input: Operations.actions_sol_create_hyphen_remove_hyphen_token_hyphen_for_hyphen_org.Input) async throws -> Operations.actions_sol_create_hyphen_remove_hyphen_token_hyphen_for_hyphen_org.Output @@ -204,10 +197,9 @@ public protocol APIProtocol: Sendable { /// /// Gets a specific self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/get(actions/get-self-hosted-runner-for-org)`. @@ -216,10 +208,9 @@ public protocol APIProtocol: Sendable { /// /// Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/delete(actions/delete-self-hosted-runner-from-org)`. @@ -228,22 +219,20 @@ public protocol APIProtocol: Sendable { /// /// Lists all labels for a self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/get(actions/list-labels-for-self-hosted-runner-for-org)`. func actions_sol_list_hyphen_labels_hyphen_for_hyphen_self_hyphen_hosted_hyphen_runner_hyphen_for_hyphen_org(_ input: Operations.actions_sol_list_hyphen_labels_hyphen_for_hyphen_self_hyphen_hosted_hyphen_runner_hyphen_for_hyphen_org.Input) async throws -> Operations.actions_sol_list_hyphen_labels_hyphen_for_hyphen_self_hyphen_hosted_hyphen_runner_hyphen_for_hyphen_org.Output /// Add custom labels to a self-hosted runner for an organization /// - /// Add custom labels to a self-hosted runner configured in an organization. + /// Adds custom labels to a self-hosted runner configured in an organization. + /// + /// Authenticated users must have admin access to the organization to use this endpoint. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/post(actions/add-custom-labels-to-self-hosted-runner-for-org)`. @@ -253,10 +242,9 @@ public protocol APIProtocol: Sendable { /// Remove all previous custom labels and set the new custom labels for a specific /// self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/put(actions/set-custom-labels-for-self-hosted-runner-for-org)`. @@ -266,10 +254,9 @@ public protocol APIProtocol: Sendable { /// Remove all custom labels from a self-hosted runner configured in an /// organization. Returns the remaining read-only labels from the runner. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/delete(actions/remove-all-custom-labels-from-self-hosted-runner-for-org)`. @@ -282,10 +269,9 @@ public protocol APIProtocol: Sendable { /// This endpoint returns a `404 Not Found` status if the custom label is not /// present on the runner. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/runners/{runner_id}/labels/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/{name}/delete(actions/remove-custom-label-from-self-hosted-runner-for-org)`. @@ -295,11 +281,10 @@ public protocol APIProtocol: Sendable { /// Lists all secrets available in an organization without revealing their /// encrypted values. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/get(actions/list-org-secrets)`. func actions_sol_list_hyphen_org_hyphen_secrets(_ input: Operations.actions_sol_list_hyphen_org_hyphen_secrets.Input) async throws -> Operations.actions_sol_list_hyphen_org_hyphen_secrets.Output @@ -308,10 +293,9 @@ public protocol APIProtocol: Sendable { /// Gets your public key, which you need to encrypt secrets. You need to /// encrypt a secret before you can create or update secrets. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// The authenticated user must have collaborator access to a repository to create, update, or read secrets. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets/public-key`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/public-key/get(actions/get-org-public-key)`. @@ -320,10 +304,9 @@ public protocol APIProtocol: Sendable { /// /// Gets a single organization secret without revealing its encrypted value. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// The authenticated user must have collaborator access to a repository to create, update, or read secrets + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/get(actions/get-org-secret)`. @@ -333,11 +316,10 @@ public protocol APIProtocol: Sendable { /// Creates or updates an organization secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/put(actions/create-or-update-org-secret)`. func actions_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret(_ input: Operations.actions_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret.Input) async throws -> Operations.actions_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret.Output @@ -345,11 +327,10 @@ public protocol APIProtocol: Sendable { /// /// Deletes a secret in an organization using the secret name. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/delete(actions/delete-org-secret)`. func actions_sol_delete_hyphen_org_hyphen_secret(_ input: Operations.actions_sol_delete_hyphen_org_hyphen_secret.Input) async throws -> Operations.actions_sol_delete_hyphen_org_hyphen_secret.Output @@ -358,11 +339,10 @@ public protocol APIProtocol: Sendable { /// Lists all repositories that have been selected when the `visibility` /// for repository access to a secret is set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/get(actions/list-selected-repos-for-org-secret)`. func actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret(_ input: Operations.actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Input) async throws -> Operations.actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Output @@ -372,25 +352,23 @@ public protocol APIProtocol: Sendable { /// for repository access is set to `selected`. The visibility is set when you [Create /// or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/put(actions/set-selected-repos-for-org-secret)`. func actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret(_ input: Operations.actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Input) async throws -> Operations.actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Output /// Add selected repository to an organization secret /// /// Adds a repository to an organization secret when the `visibility` for - /// repository access is set to `selected`. The visibility is set when you [Create or + /// repository access is set to `selected`. For more information about setting the visibility, see [Create or /// update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}/put(actions/add-selected-repo-to-org-secret)`. func actions_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret(_ input: Operations.actions_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret.Input) async throws -> Operations.actions_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret.Output @@ -400,18 +378,20 @@ public protocol APIProtocol: Sendable { /// for repository access is set to `selected`. The visibility is set when you [Create /// or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}/delete(actions/remove-selected-repo-from-org-secret)`. func actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret(_ input: Operations.actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret.Input) async throws -> Operations.actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret.Output /// List organization variables /// /// Lists all organization variables. - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// + /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/variables`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/get(actions/list-org-variables)`. @@ -420,11 +400,10 @@ public protocol APIProtocol: Sendable { /// /// Creates an organization variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/actions/variables`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/post(actions/create-org-variable)`. func actions_sol_create_hyphen_org_hyphen_variable(_ input: Operations.actions_sol_create_hyphen_org_hyphen_variable.Input) async throws -> Operations.actions_sol_create_hyphen_org_hyphen_variable.Output @@ -432,10 +411,9 @@ public protocol APIProtocol: Sendable { /// /// Gets a specific variable in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// The authenticated user must have collaborator access to a repository to create, update, or read variables. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/get(actions/get-org-variable)`. @@ -444,11 +422,10 @@ public protocol APIProtocol: Sendable { /// /// Updates an organization variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `PATCH /orgs/{org}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/patch(actions/update-org-variable)`. func actions_sol_update_hyphen_org_hyphen_variable(_ input: Operations.actions_sol_update_hyphen_org_hyphen_variable.Input) async throws -> Operations.actions_sol_update_hyphen_org_hyphen_variable.Output @@ -456,11 +433,10 @@ public protocol APIProtocol: Sendable { /// /// Deletes an organization variable using the variable name. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/delete(actions/delete-org-variable)`. func actions_sol_delete_hyphen_org_hyphen_variable(_ input: Operations.actions_sol_delete_hyphen_org_hyphen_variable.Input) async throws -> Operations.actions_sol_delete_hyphen_org_hyphen_variable.Output @@ -469,11 +445,10 @@ public protocol APIProtocol: Sendable { /// Lists all repositories that can access an organization variable /// that is available to selected repositories. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `GET /orgs/{org}/actions/variables/{name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/get(actions/list-selected-repos-for-org-variable)`. func actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable(_ input: Operations.actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable.Input) async throws -> Operations.actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable.Output @@ -483,12 +458,10 @@ public protocol APIProtocol: Sendable { /// to selected repositories. Organization variables that are available to selected /// repositories have their `visibility` field set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this - /// endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/variables/{name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/put(actions/set-selected-repos-for-org-variable)`. func actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable(_ input: Operations.actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable.Input) async throws -> Operations.actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable.Output @@ -497,10 +470,9 @@ public protocol APIProtocol: Sendable { /// Adds a repository to an organization variable that is available to selected repositories. /// Organization variables that are available to selected repositories have their `visibility` field set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/variables/{name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/{repository_id}/put(actions/add-selected-repo-to-org-variable)`. @@ -511,31 +483,39 @@ public protocol APIProtocol: Sendable { /// available to selected repositories. Organization variables that are available to /// selected repositories have their `visibility` field set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/variables/{name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/{repository_id}/delete(actions/remove-selected-repo-from-org-variable)`. func actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_variable(_ input: Operations.actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_variable.Input) async throws -> Operations.actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_variable.Output /// List artifacts for a repository /// - /// Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Lists all artifacts for a repository. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/artifacts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/get(actions/list-artifacts-for-repo)`. func actions_sol_list_hyphen_artifacts_hyphen_for_hyphen_repo(_ input: Operations.actions_sol_list_hyphen_artifacts_hyphen_for_hyphen_repo.Input) async throws -> Operations.actions_sol_list_hyphen_artifacts_hyphen_for_hyphen_repo.Output /// Get an artifact /// - /// Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific artifact for a workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/{artifact_id}/get(actions/get-artifact)`. func actions_sol_get_hyphen_artifact(_ input: Operations.actions_sol_get_hyphen_artifact.Input) async throws -> Operations.actions_sol_get_hyphen_artifact.Output /// Delete an artifact /// - /// Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// Deletes an artifact for a workflow run. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/{artifact_id}/delete(actions/delete-artifact)`. @@ -545,8 +525,7 @@ public protocol APIProtocol: Sendable { /// Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in /// the response header to find the URL for the download. The `:archive_format` must be `zip`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:read` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}/get(actions/download-artifact)`. @@ -555,7 +534,10 @@ public protocol APIProtocol: Sendable { /// /// Gets GitHub Actions cache usage for a repository. /// The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/cache/usage`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/cache/usage/get(actions/get-actions-cache-usage)`. @@ -563,8 +545,8 @@ public protocol APIProtocol: Sendable { /// List GitHub Actions caches for a repository /// /// Lists the GitHub Actions caches for a repository. - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/caches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/caches/get(actions/get-actions-cache-list)`. @@ -573,9 +555,7 @@ public protocol APIProtocol: Sendable { /// /// Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/caches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/caches/delete(actions/delete-actions-cache-by-key)`. @@ -584,16 +564,18 @@ public protocol APIProtocol: Sendable { /// /// Deletes a GitHub Actions cache for a repository, using a cache ID. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/caches/{cache_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/caches/{cache_id}/delete(actions/delete-actions-cache-by-id)`. func actions_sol_delete_hyphen_actions_hyphen_cache_hyphen_by_hyphen_id(_ input: Operations.actions_sol_delete_hyphen_actions_hyphen_cache_hyphen_by_hyphen_id.Input) async throws -> Operations.actions_sol_delete_hyphen_actions_hyphen_cache_hyphen_by_hyphen_id.Output /// Get a job for a workflow run /// - /// Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific job in a workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/jobs/{job_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/jobs/{job_id}/get(actions/get-job-for-workflow-run)`. @@ -601,9 +583,11 @@ public protocol APIProtocol: Sendable { /// Download job logs for a workflow run /// /// Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look - /// for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can - /// use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must - /// have the `actions:read` permission to use this endpoint. + /// for `Location:` in the response header to find the URL for the download. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/jobs/{job_id}/logs/get(actions/download-job-logs-for-workflow-run)`. @@ -612,8 +596,7 @@ public protocol APIProtocol: Sendable { /// /// Re-run a job and its dependent jobs in a workflow run. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/jobs/{job_id}/rerun/post(actions/re-run-job-for-workflow-run)`. @@ -621,8 +604,8 @@ public protocol APIProtocol: Sendable { /// Get the customization template for an OIDC subject claim for a repository /// /// Gets the customization template for an OpenID Connect (OIDC) subject claim. - /// You must authenticate using an access token with the `repo` scope to use this - /// endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/oidc/customization/sub/get(actions/get-custom-oidc-sub-claim-for-repo)`. @@ -630,8 +613,8 @@ public protocol APIProtocol: Sendable { /// Set the customization template for an OIDC subject claim for a repository /// /// Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - /// You must authenticate using an access token with the `repo` scope to use this - /// endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/oidc/customization/sub/put(actions/set-custom-oidc-sub-claim-for-repo)`. @@ -641,21 +624,21 @@ public protocol APIProtocol: Sendable { /// Lists all organization secrets shared with a repository without revealing their encrypted /// values. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/organization-secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/organization-secrets/get(actions/list-repo-organization-secrets)`. func actions_sol_list_hyphen_repo_hyphen_organization_hyphen_secrets(_ input: Operations.actions_sol_list_hyphen_repo_hyphen_organization_hyphen_secrets.Input) async throws -> Operations.actions_sol_list_hyphen_repo_hyphen_organization_hyphen_secrets.Output /// List repository organization variables /// - /// Lists all organiation variables shared with a repository. + /// Lists all organization variables shared with a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/organization-variables`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/organization-variables/get(actions/list-repo-organization-variables)`. func actions_sol_list_hyphen_repo_hyphen_organization_hyphen_variables(_ input: Operations.actions_sol_list_hyphen_repo_hyphen_organization_hyphen_variables.Input) async throws -> Operations.actions_sol_list_hyphen_repo_hyphen_organization_hyphen_variables.Output @@ -663,7 +646,7 @@ public protocol APIProtocol: Sendable { /// /// Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/get(actions/get-github-actions-permissions-repository)`. @@ -672,7 +655,7 @@ public protocol APIProtocol: Sendable { /// /// Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/put(actions/set-github-actions-permissions-repository)`. @@ -683,8 +666,7 @@ public protocol APIProtocol: Sendable { /// This endpoint only applies to private repositories. /// For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - /// repository `administration` permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions/access`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/access/get(actions/get-workflow-access-to-repository)`. @@ -695,8 +677,7 @@ public protocol APIProtocol: Sendable { /// This endpoint only applies to private repositories. /// For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - /// repository `administration` permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions/access`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/access/put(actions/set-workflow-access-to-repository)`. @@ -705,7 +686,7 @@ public protocol APIProtocol: Sendable { /// /// Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/selected-actions/get(actions/get-allowed-actions-repository)`. @@ -714,7 +695,7 @@ public protocol APIProtocol: Sendable { /// /// Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/selected-actions/put(actions/set-allowed-actions-repository)`. @@ -725,7 +706,7 @@ public protocol APIProtocol: Sendable { /// as well as if GitHub Actions can submit approving pull request reviews. /// For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/workflow/get(actions/get-github-actions-default-workflow-permissions-repository)`. @@ -736,7 +717,7 @@ public protocol APIProtocol: Sendable { /// can submit approving pull request reviews. /// For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/workflow/put(actions/set-github-actions-default-workflow-permissions-repository)`. @@ -745,9 +726,9 @@ public protocol APIProtocol: Sendable { /// /// Lists all self-hosted runners configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/get(actions/list-self-hosted-runners-for-repo)`. @@ -756,9 +737,9 @@ public protocol APIProtocol: Sendable { /// /// Lists binaries for the runner application that you can download and run. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners/downloads`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/downloads/get(actions/list-runner-applications-for-repo)`. @@ -767,47 +748,43 @@ public protocol APIProtocol: Sendable { /// /// Generates a configuration that can be passed to the runner application at startup. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// The authenticated user must have admin access to the repository. + /// + /// OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/generate-jitconfig`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/generate-jitconfig/post(actions/generate-runner-jitconfig-for-repo)`. func actions_sol_generate_hyphen_runner_hyphen_jitconfig_hyphen_for_hyphen_repo(_ input: Operations.actions_sol_generate_hyphen_runner_hyphen_jitconfig_hyphen_for_hyphen_repo.Input) async throws -> Operations.actions_sol_generate_hyphen_runner_hyphen_jitconfig_hyphen_for_hyphen_repo.Output /// Create a registration token for a repository /// - /// Returns a token that you can pass to the `config` script. The token - /// expires after one hour. + /// Returns a token that you can pass to the `config` script. The token expires after one hour. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: /// - /// Example using registration token: + /// ``` + /// ./config.sh --url https://github.com/octo-org --token TOKEN + /// ``` /// - /// Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - /// by this endpoint. + /// Authenticated users must have admin access to the repository to use this endpoint. /// - /// ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/registration-token`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/registration-token/post(actions/create-registration-token-for-repo)`. func actions_sol_create_hyphen_registration_hyphen_token_hyphen_for_hyphen_repo(_ input: Operations.actions_sol_create_hyphen_registration_hyphen_token_hyphen_for_hyphen_repo.Input) async throws -> Operations.actions_sol_create_hyphen_registration_hyphen_token_hyphen_for_hyphen_repo.Output /// Create a remove token for a repository /// - /// Returns a token that you can pass to remove a self-hosted runner from - /// a repository. The token expires after one hour. + /// Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: /// - /// Example using remove token: + /// ``` + /// ./config.sh remove --token TOKEN + /// ``` /// - /// To remove your self-hosted runner from a repository, replace TOKEN with - /// the remove token provided by this endpoint. + /// Authenticated users must have admin access to the repository to use this endpoint. /// - /// ```config.sh remove --token TOKEN``` + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/remove-token`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/remove-token/post(actions/create-remove-token-for-repo)`. @@ -816,9 +793,9 @@ public protocol APIProtocol: Sendable { /// /// Gets a specific self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/get(actions/get-self-hosted-runner-for-repo)`. @@ -827,9 +804,9 @@ public protocol APIProtocol: Sendable { /// /// Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/delete(actions/delete-self-hosted-runner-from-repo)`. @@ -838,20 +815,20 @@ public protocol APIProtocol: Sendable { /// /// Lists all labels for a self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/get(actions/list-labels-for-self-hosted-runner-for-repo)`. func actions_sol_list_hyphen_labels_hyphen_for_hyphen_self_hyphen_hosted_hyphen_runner_hyphen_for_hyphen_repo(_ input: Operations.actions_sol_list_hyphen_labels_hyphen_for_hyphen_self_hyphen_hosted_hyphen_runner_hyphen_for_hyphen_repo.Input) async throws -> Operations.actions_sol_list_hyphen_labels_hyphen_for_hyphen_self_hyphen_hosted_hyphen_runner_hyphen_for_hyphen_repo.Output /// Add custom labels to a self-hosted runner for a repository /// - /// Add custom labels to a self-hosted runner configured in a repository. + /// Adds custom labels to a self-hosted runner configured in a repository. + /// + /// Authenticated users must have admin access to the organization to use this endpoint. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/post(actions/add-custom-labels-to-self-hosted-runner-for-repo)`. @@ -861,9 +838,9 @@ public protocol APIProtocol: Sendable { /// Remove all previous custom labels and set the new custom labels for a specific /// self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/put(actions/set-custom-labels-for-self-hosted-runner-for-repo)`. @@ -873,9 +850,9 @@ public protocol APIProtocol: Sendable { /// Remove all custom labels from a self-hosted runner configured in a /// repository. Returns the remaining read-only labels from the runner. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/delete(actions/remove-all-custom-labels-from-self-hosted-runner-for-repo)`. @@ -888,9 +865,9 @@ public protocol APIProtocol: Sendable { /// This endpoint returns a `404 Not Found` status if the custom label is not /// present on the runner. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}/delete(actions/remove-custom-label-from-self-hosted-runner-for-repo)`. @@ -899,30 +876,40 @@ public protocol APIProtocol: Sendable { /// /// Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/get(actions/list-workflow-runs-for-repo)`. func actions_sol_list_hyphen_workflow_hyphen_runs_hyphen_for_hyphen_repo(_ input: Operations.actions_sol_list_hyphen_workflow_hyphen_runs_hyphen_for_hyphen_repo.Input) async throws -> Operations.actions_sol_list_hyphen_workflow_hyphen_runs_hyphen_for_hyphen_repo.Output /// Get a workflow run /// - /// Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/get(actions/get-workflow-run)`. func actions_sol_get_hyphen_workflow_hyphen_run(_ input: Operations.actions_sol_get_hyphen_workflow_hyphen_run.Input) async throws -> Operations.actions_sol_get_hyphen_workflow_hyphen_run.Output /// Delete a workflow run /// - /// Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is - /// private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use - /// this endpoint. + /// Deletes a specific workflow run. + /// + /// Anyone with write access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runs/{run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/delete(actions/delete-workflow-run)`. func actions_sol_delete_hyphen_workflow_hyphen_run(_ input: Operations.actions_sol_delete_hyphen_workflow_hyphen_run.Input) async throws -> Operations.actions_sol_delete_hyphen_workflow_hyphen_run.Output /// Get the review history for a workflow run /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/approvals/get(actions/get-reviews-for-run)`. @@ -931,31 +918,41 @@ public protocol APIProtocol: Sendable { /// /// Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/approve/post(actions/approve-workflow-run)`. func actions_sol_approve_hyphen_workflow_hyphen_run(_ input: Operations.actions_sol_approve_hyphen_workflow_hyphen_run.Input) async throws -> Operations.actions_sol_approve_hyphen_workflow_hyphen_run.Output /// List workflow run artifacts /// - /// Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Lists artifacts for a workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/artifacts/get(actions/list-workflow-run-artifacts)`. func actions_sol_list_hyphen_workflow_hyphen_run_hyphen_artifacts(_ input: Operations.actions_sol_list_hyphen_workflow_hyphen_run_hyphen_artifacts.Input) async throws -> Operations.actions_sol_list_hyphen_workflow_hyphen_run_hyphen_artifacts.Output /// Get a workflow run attempt /// - /// Gets a specific workflow run attempt. Anyone with read access to the repository - /// can use this endpoint. If the repository is private you must use an access token - /// with the `repo` scope. GitHub Apps must have the `actions:read` permission to - /// use this endpoint. + /// Gets a specific workflow run attempt. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/get(actions/get-workflow-run-attempt)`. func actions_sol_get_hyphen_workflow_hyphen_run_hyphen_attempt(_ input: Operations.actions_sol_get_hyphen_workflow_hyphen_run_hyphen_attempt.Input) async throws -> Operations.actions_sol_get_hyphen_workflow_hyphen_run_hyphen_attempt.Output /// List jobs for a workflow run attempt /// - /// Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information + /// about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs/get(actions/list-jobs-for-workflow-run-attempt)`. @@ -963,9 +960,11 @@ public protocol APIProtocol: Sendable { /// Download workflow run attempt logs /// /// Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - /// 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to - /// the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. - /// GitHub Apps must have the `actions:read` permission to use this endpoint. + /// 1 minute. Look for `Location:` in the response header to find the URL for the download. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs/get(actions/download-workflow-run-attempt-logs)`. @@ -974,8 +973,7 @@ public protocol APIProtocol: Sendable { /// /// Cancels a workflow run using its `id`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/cancel/post(actions/cancel-workflow-run)`. @@ -987,8 +985,7 @@ public protocol APIProtocol: Sendable { /// **Note:** GitHub Apps can only review their own custom deployment protection rules. /// To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). /// - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have read and write permission for **Deployments** to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule/post(actions/review-custom-gates-for-run)`. @@ -998,15 +995,19 @@ public protocol APIProtocol: Sendable { /// Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. /// You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel/post(actions/force-cancel-workflow-run)`. func actions_sol_force_hyphen_cancel_hyphen_workflow_hyphen_run(_ input: Operations.actions_sol_force_hyphen_cancel_hyphen_workflow_hyphen_run.Input) async throws -> Operations.actions_sol_force_hyphen_cancel_hyphen_workflow_hyphen_run.Output /// List jobs for a workflow run /// - /// Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information + /// about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/jobs/get(actions/list-jobs-for-workflow-run)`. @@ -1014,16 +1015,20 @@ public protocol APIProtocol: Sendable { /// Download workflow run logs /// /// Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - /// `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use - /// this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have - /// the `actions:read` permission to use this endpoint. + /// `Location:` in the response header to find the URL for the download. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/logs/get(actions/download-workflow-run-logs)`. func actions_sol_download_hyphen_workflow_hyphen_run_hyphen_logs(_ input: Operations.actions_sol_download_hyphen_workflow_hyphen_run_hyphen_logs.Input) async throws -> Operations.actions_sol_download_hyphen_workflow_hyphen_run_hyphen_logs.Output /// Delete workflow run logs /// - /// Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// Deletes all logs for a workflow run. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/logs/delete(actions/delete-workflow-run-logs)`. @@ -1032,7 +1037,9 @@ public protocol APIProtocol: Sendable { /// /// Get all deployment environments for a workflow run that are waiting for protection rules to pass. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments/get(actions/get-pending-deployments-for-run)`. @@ -1041,21 +1048,27 @@ public protocol APIProtocol: Sendable { /// /// Approve or reject pending deployments that are waiting on approval by a required reviewer. /// - /// Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. + /// Required reviewers with read access to the repository contents and deployments can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments/post(actions/review-pending-deployments-for-run)`. func actions_sol_review_hyphen_pending_hyphen_deployments_hyphen_for_hyphen_run(_ input: Operations.actions_sol_review_hyphen_pending_hyphen_deployments_hyphen_for_hyphen_run.Input) async throws -> Operations.actions_sol_review_hyphen_pending_hyphen_deployments_hyphen_for_hyphen_run.Output /// Re-run a workflow /// - /// Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// Re-runs your workflow run using its `id`. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/rerun/post(actions/re-run-workflow)`. func actions_sol_re_hyphen_run_hyphen_workflow(_ input: Operations.actions_sol_re_hyphen_run_hyphen_workflow.Input) async throws -> Operations.actions_sol_re_hyphen_run_hyphen_workflow.Output /// Re-run failed jobs from a workflow run /// - /// Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. + /// Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs/post(actions/re-run-workflow-failed-jobs)`. @@ -1064,7 +1077,9 @@ public protocol APIProtocol: Sendable { /// /// Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/timing/get(actions/get-workflow-run-usage)`. @@ -1074,10 +1089,10 @@ public protocol APIProtocol: Sendable { /// Lists all secrets available in a repository without revealing their encrypted /// values. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/get(actions/list-repo-secrets)`. func actions_sol_list_hyphen_repo_hyphen_secrets(_ input: Operations.actions_sol_list_hyphen_repo_hyphen_secrets.Input) async throws -> Operations.actions_sol_list_hyphen_repo_hyphen_secrets.Output @@ -1087,9 +1102,8 @@ public protocol APIProtocol: Sendable { /// encrypt a secret before you can create or update secrets. /// /// Anyone with read access to the repository can use this endpoint. - /// If the repository is private you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/secrets/public-key`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/public-key/get(actions/get-repo-public-key)`. @@ -1098,9 +1112,9 @@ public protocol APIProtocol: Sendable { /// /// Gets a single repository secret without revealing its encrypted value. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// The authenticated user must have collaborator access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/{secret_name}/get(actions/get-repo-secret)`. @@ -1110,10 +1124,10 @@ public protocol APIProtocol: Sendable { /// Creates or updates a repository secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/{secret_name}/put(actions/create-or-update-repo-secret)`. func actions_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret(_ input: Operations.actions_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret.Input) async throws -> Operations.actions_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret.Output @@ -1121,20 +1135,21 @@ public protocol APIProtocol: Sendable { /// /// Deletes a secret in a repository using the secret name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/{secret_name}/delete(actions/delete-repo-secret)`. func actions_sol_delete_hyphen_repo_hyphen_secret(_ input: Operations.actions_sol_delete_hyphen_repo_hyphen_secret.Input) async throws -> Operations.actions_sol_delete_hyphen_repo_hyphen_secret.Output /// List repository variables /// /// Lists all repository variables. - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + /// /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/variables`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/get(actions/list-repo-variables)`. func actions_sol_list_hyphen_repo_hyphen_variables(_ input: Operations.actions_sol_list_hyphen_repo_hyphen_variables.Input) async throws -> Operations.actions_sol_list_hyphen_repo_hyphen_variables.Output @@ -1142,10 +1157,10 @@ public protocol APIProtocol: Sendable { /// /// Creates a repository variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/variables`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/post(actions/create-repo-variable)`. func actions_sol_create_hyphen_repo_hyphen_variable(_ input: Operations.actions_sol_create_hyphen_repo_hyphen_variable.Input) async throws -> Operations.actions_sol_create_hyphen_repo_hyphen_variable.Output @@ -1153,9 +1168,9 @@ public protocol APIProtocol: Sendable { /// /// Gets a specific variable in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// The authenticated user must have collaborator access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/{name}/get(actions/get-repo-variable)`. @@ -1164,10 +1179,10 @@ public protocol APIProtocol: Sendable { /// /// Updates a repository variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/{name}/patch(actions/update-repo-variable)`. func actions_sol_update_hyphen_repo_hyphen_variable(_ input: Operations.actions_sol_update_hyphen_repo_hyphen_variable.Input) async throws -> Operations.actions_sol_update_hyphen_repo_hyphen_variable.Output @@ -1175,23 +1190,32 @@ public protocol APIProtocol: Sendable { /// /// Deletes a repository variable using the variable name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/{name}/delete(actions/delete-repo-variable)`. func actions_sol_delete_hyphen_repo_hyphen_variable(_ input: Operations.actions_sol_delete_hyphen_repo_hyphen_variable.Input) async throws -> Operations.actions_sol_delete_hyphen_repo_hyphen_variable.Output /// List repository workflows /// - /// Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Lists the workflows in a repository. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/get(actions/list-repo-workflows)`. func actions_sol_list_hyphen_repo_hyphen_workflows(_ input: Operations.actions_sol_list_hyphen_repo_hyphen_workflows.Input) async throws -> Operations.actions_sol_list_hyphen_repo_hyphen_workflows.Output /// Get a workflow /// - /// Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific workflow. You can replace `workflow_id` with the workflow + /// file name. For example, you could use `main.yaml`. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/get(actions/get-workflow)`. @@ -1200,7 +1224,7 @@ public protocol APIProtocol: Sendable { /// /// Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable/put(actions/disable-workflow)`. @@ -1211,7 +1235,7 @@ public protocol APIProtocol: Sendable { /// /// You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches/post(actions/create-workflow-dispatch)`. @@ -1220,7 +1244,7 @@ public protocol APIProtocol: Sendable { /// /// Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable/put(actions/enable-workflow)`. @@ -1229,7 +1253,9 @@ public protocol APIProtocol: Sendable { /// /// List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + /// Anyone with read access to the repository can use this endpoint + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs/get(actions/list-workflow-runs)`. @@ -1238,7 +1264,11 @@ public protocol APIProtocol: Sendable { /// /// Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing/get(actions/get-workflow-usage)`. @@ -1248,10 +1278,10 @@ public protocol APIProtocol: Sendable { /// Lists all secrets available in an environment without revealing their /// encrypted values. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/secrets`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/get(actions/list-environment-secrets)`. func actions_sol_list_hyphen_environment_hyphen_secrets(_ input: Operations.actions_sol_list_hyphen_environment_hyphen_secrets.Input) async throws -> Operations.actions_sol_list_hyphen_environment_hyphen_secrets.Output @@ -1261,9 +1291,8 @@ public protocol APIProtocol: Sendable { /// secrets. You need to encrypt a secret before you can create or update secrets. /// /// Anyone with read access to the repository can use this endpoint. - /// If the repository is private you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/public-key/get(actions/get-environment-public-key)`. @@ -1272,10 +1301,10 @@ public protocol APIProtocol: Sendable { /// /// Gets a single environment secret without revealing its encrypted value. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}/get(actions/get-environment-secret)`. func actions_sol_get_hyphen_environment_hyphen_secret(_ input: Operations.actions_sol_get_hyphen_environment_hyphen_secret.Input) async throws -> Operations.actions_sol_get_hyphen_environment_hyphen_secret.Output @@ -1284,10 +1313,10 @@ public protocol APIProtocol: Sendable { /// Creates or updates an environment secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}/put(actions/create-or-update-environment-secret)`. func actions_sol_create_hyphen_or_hyphen_update_hyphen_environment_hyphen_secret(_ input: Operations.actions_sol_create_hyphen_or_hyphen_update_hyphen_environment_hyphen_secret.Input) async throws -> Operations.actions_sol_create_hyphen_or_hyphen_update_hyphen_environment_hyphen_secret.Output @@ -1295,10 +1324,10 @@ public protocol APIProtocol: Sendable { /// /// Deletes a secret in an environment using the secret name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}/delete(actions/delete-environment-secret)`. func actions_sol_delete_hyphen_environment_hyphen_secret(_ input: Operations.actions_sol_delete_hyphen_environment_hyphen_secret.Input) async throws -> Operations.actions_sol_delete_hyphen_environment_hyphen_secret.Output @@ -1306,10 +1335,10 @@ public protocol APIProtocol: Sendable { /// /// Lists all environment variables. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environments:read` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/variables`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/get(actions/list-environment-variables)`. func actions_sol_list_hyphen_environment_hyphen_variables(_ input: Operations.actions_sol_list_hyphen_environment_hyphen_variables.Input) async throws -> Operations.actions_sol_list_hyphen_environment_hyphen_variables.Output @@ -1317,10 +1346,10 @@ public protocol APIProtocol: Sendable { /// /// Create an environment variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environment:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repositories/{repository_id}/environments/{environment_name}/variables`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/post(actions/create-environment-variable)`. func actions_sol_create_hyphen_environment_hyphen_variable(_ input: Operations.actions_sol_create_hyphen_environment_hyphen_variable.Input) async throws -> Operations.actions_sol_create_hyphen_environment_hyphen_variable.Output @@ -1328,10 +1357,10 @@ public protocol APIProtocol: Sendable { /// /// Gets a specific variable in an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environments:read` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/variables/{name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/{name}/get(actions/get-environment-variable)`. func actions_sol_get_hyphen_environment_hyphen_variable(_ input: Operations.actions_sol_get_hyphen_environment_hyphen_variable.Input) async throws -> Operations.actions_sol_get_hyphen_environment_hyphen_variable.Output @@ -1339,10 +1368,10 @@ public protocol APIProtocol: Sendable { /// /// Updates an environment variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environment:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /repositories/{repository_id}/environments/{environment_name}/variables/{name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/{name}/patch(actions/update-environment-variable)`. func actions_sol_update_hyphen_environment_hyphen_variable(_ input: Operations.actions_sol_update_hyphen_environment_hyphen_variable.Input) async throws -> Operations.actions_sol_update_hyphen_environment_hyphen_variable.Output @@ -1350,10 +1379,10 @@ public protocol APIProtocol: Sendable { /// /// Deletes an environment variable using the variable name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environment:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/{name}/delete(actions/delete-environment-variable)`. func actions_sol_delete_hyphen_environment_hyphen_variable(_ input: Operations.actions_sol_delete_hyphen_environment_hyphen_variable.Input) async throws -> Operations.actions_sol_delete_hyphen_environment_hyphen_variable.Output @@ -1365,7 +1394,8 @@ extension APIProtocol { /// /// Gets the total GitHub Actions cache usage for an organization. /// The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - /// You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/cache/usage`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/cache/usage/get(actions/get-actions-cache-usage-for-org)`. @@ -1382,7 +1412,8 @@ extension APIProtocol { /// /// Lists repositories and their GitHub Actions cache usage for an organization. /// The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - /// You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/cache/usage-by-repository`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/cache/usage-by-repository/get(actions/get-actions-cache-usage-by-repo-for-org)`. @@ -1401,7 +1432,7 @@ extension APIProtocol { /// /// Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/get(actions/get-github-actions-permissions-organization)`. @@ -1418,7 +1449,7 @@ extension APIProtocol { /// /// Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/put(actions/set-github-actions-permissions-organization)`. @@ -1435,7 +1466,7 @@ extension APIProtocol { /// /// Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/get(actions/list-selected-repositories-enabled-github-actions-organization)`. @@ -1454,7 +1485,8 @@ extension APIProtocol { /// /// Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/put(actions/set-selected-repositories-enabled-github-actions-organization)`. @@ -1471,7 +1503,7 @@ extension APIProtocol { /// /// Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/{repository_id}/put(actions/enable-selected-repository-github-actions-organization)`. @@ -1482,7 +1514,7 @@ extension APIProtocol { /// /// Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/{repository_id}/delete(actions/disable-selected-repository-github-actions-organization)`. @@ -1491,9 +1523,9 @@ extension APIProtocol { } /// Get allowed actions and reusable workflows for an organization /// - /// Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + /// Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/selected-actions/get(actions/get-allowed-actions-organization)`. @@ -1510,7 +1542,7 @@ extension APIProtocol { /// /// Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/selected-actions/put(actions/set-allowed-actions-organization)`. @@ -1529,7 +1561,7 @@ extension APIProtocol { /// as well as whether GitHub Actions can submit approving pull request reviews. For more information, see /// "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/workflow/get(actions/get-github-actions-default-workflow-permissions-organization)`. @@ -1548,7 +1580,7 @@ extension APIProtocol { /// can submit approving pull request reviews. For more information, see /// "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/workflow/put(actions/set-github-actions-default-workflow-permissions-organization)`. @@ -1565,10 +1597,9 @@ extension APIProtocol { /// /// Lists all self-hosted runners configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/get(actions/list-self-hosted-runners-for-org)`. @@ -1587,10 +1618,9 @@ extension APIProtocol { /// /// Lists binaries for the runner application that you can download and run. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners/downloads`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/downloads/get(actions/list-runner-applications-for-org)`. @@ -1607,10 +1637,9 @@ extension APIProtocol { /// /// Generates a configuration that can be passed to the runner application at startup. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// The authenticated user must have admin access to the organization. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/generate-jitconfig`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/generate-jitconfig/post(actions/generate-runner-jitconfig-for-org)`. @@ -1629,19 +1658,16 @@ extension APIProtocol { /// /// Returns a token that you can pass to the `config` script. The token expires after one hour. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - /// - /// Example using registration token: - /// - /// Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: /// /// ``` /// ./config.sh --url https://github.com/octo-org --token TOKEN /// ``` /// + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/registration-token`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/registration-token/post(actions/create-registration-token-for-org)`. public func actions_sol_create_hyphen_registration_hyphen_token_hyphen_for_hyphen_org( @@ -1657,20 +1683,16 @@ extension APIProtocol { /// /// Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - /// - /// Example using remove token: - /// - /// To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - /// endpoint. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: /// /// ``` /// ./config.sh remove --token TOKEN /// ``` /// + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/remove-token`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/remove-token/post(actions/create-remove-token-for-org)`. public func actions_sol_create_hyphen_remove_hyphen_token_hyphen_for_hyphen_org( @@ -1686,10 +1708,9 @@ extension APIProtocol { /// /// Gets a specific self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/get(actions/get-self-hosted-runner-for-org)`. @@ -1706,10 +1727,9 @@ extension APIProtocol { /// /// Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/delete(actions/delete-self-hosted-runner-from-org)`. @@ -1720,10 +1740,9 @@ extension APIProtocol { /// /// Lists all labels for a self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/get(actions/list-labels-for-self-hosted-runner-for-org)`. @@ -1738,12 +1757,11 @@ extension APIProtocol { } /// Add custom labels to a self-hosted runner for an organization /// - /// Add custom labels to a self-hosted runner configured in an organization. + /// Adds custom labels to a self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/post(actions/add-custom-labels-to-self-hosted-runner-for-org)`. @@ -1763,10 +1781,9 @@ extension APIProtocol { /// Remove all previous custom labels and set the new custom labels for a specific /// self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/put(actions/set-custom-labels-for-self-hosted-runner-for-org)`. @@ -1786,10 +1803,9 @@ extension APIProtocol { /// Remove all custom labels from a self-hosted runner configured in an /// organization. Returns the remaining read-only labels from the runner. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/delete(actions/remove-all-custom-labels-from-self-hosted-runner-for-org)`. @@ -1810,10 +1826,9 @@ extension APIProtocol { /// This endpoint returns a `404 Not Found` status if the custom label is not /// present on the runner. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/runners/{runner_id}/labels/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/{name}/delete(actions/remove-custom-label-from-self-hosted-runner-for-org)`. @@ -1831,11 +1846,10 @@ extension APIProtocol { /// Lists all secrets available in an organization without revealing their /// encrypted values. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/get(actions/list-org-secrets)`. public func actions_sol_list_hyphen_org_hyphen_secrets( @@ -1854,10 +1868,9 @@ extension APIProtocol { /// Gets your public key, which you need to encrypt secrets. You need to /// encrypt a secret before you can create or update secrets. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// The authenticated user must have collaborator access to a repository to create, update, or read secrets. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets/public-key`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/public-key/get(actions/get-org-public-key)`. @@ -1874,10 +1887,9 @@ extension APIProtocol { /// /// Gets a single organization secret without revealing its encrypted value. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// The authenticated user must have collaborator access to a repository to create, update, or read secrets + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/get(actions/get-org-secret)`. @@ -1895,11 +1907,10 @@ extension APIProtocol { /// Creates or updates an organization secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/put(actions/create-or-update-org-secret)`. public func actions_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret( @@ -1917,11 +1928,10 @@ extension APIProtocol { /// /// Deletes a secret in an organization using the secret name. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/delete(actions/delete-org-secret)`. public func actions_sol_delete_hyphen_org_hyphen_secret(path: Operations.actions_sol_delete_hyphen_org_hyphen_secret.Input.Path) async throws -> Operations.actions_sol_delete_hyphen_org_hyphen_secret.Output { @@ -1932,11 +1942,10 @@ extension APIProtocol { /// Lists all repositories that have been selected when the `visibility` /// for repository access to a secret is set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/get(actions/list-selected-repos-for-org-secret)`. public func actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret( @@ -1956,11 +1965,10 @@ extension APIProtocol { /// for repository access is set to `selected`. The visibility is set when you [Create /// or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/put(actions/set-selected-repos-for-org-secret)`. public func actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret( @@ -1975,14 +1983,13 @@ extension APIProtocol { /// Add selected repository to an organization secret /// /// Adds a repository to an organization secret when the `visibility` for - /// repository access is set to `selected`. The visibility is set when you [Create or + /// repository access is set to `selected`. For more information about setting the visibility, see [Create or /// update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}/put(actions/add-selected-repo-to-org-secret)`. public func actions_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret(path: Operations.actions_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret.Input.Path) async throws -> Operations.actions_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret.Output { @@ -1994,11 +2001,10 @@ extension APIProtocol { /// for repository access is set to `selected`. The visibility is set when you [Create /// or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}/delete(actions/remove-selected-repo-from-org-secret)`. public func actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret(path: Operations.actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret.Input.Path) async throws -> Operations.actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret.Output { @@ -2007,7 +2013,10 @@ extension APIProtocol { /// List organization variables /// /// Lists all organization variables. - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// + /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/variables`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/get(actions/list-org-variables)`. @@ -2026,11 +2035,10 @@ extension APIProtocol { /// /// Creates an organization variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/actions/variables`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/post(actions/create-org-variable)`. public func actions_sol_create_hyphen_org_hyphen_variable( @@ -2048,10 +2056,9 @@ extension APIProtocol { /// /// Gets a specific variable in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// The authenticated user must have collaborator access to a repository to create, update, or read variables. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/get(actions/get-org-variable)`. @@ -2068,11 +2075,10 @@ extension APIProtocol { /// /// Updates an organization variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `PATCH /orgs/{org}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/patch(actions/update-org-variable)`. public func actions_sol_update_hyphen_org_hyphen_variable( @@ -2088,11 +2094,10 @@ extension APIProtocol { /// /// Deletes an organization variable using the variable name. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/delete(actions/delete-org-variable)`. public func actions_sol_delete_hyphen_org_hyphen_variable(path: Operations.actions_sol_delete_hyphen_org_hyphen_variable.Input.Path) async throws -> Operations.actions_sol_delete_hyphen_org_hyphen_variable.Output { @@ -2103,11 +2108,10 @@ extension APIProtocol { /// Lists all repositories that can access an organization variable /// that is available to selected repositories. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `GET /orgs/{org}/actions/variables/{name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/get(actions/list-selected-repos-for-org-variable)`. public func actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable( @@ -2127,12 +2131,10 @@ extension APIProtocol { /// to selected repositories. Organization variables that are available to selected /// repositories have their `visibility` field set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this - /// endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/variables/{name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/put(actions/set-selected-repos-for-org-variable)`. public func actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable( @@ -2149,10 +2151,9 @@ extension APIProtocol { /// Adds a repository to an organization variable that is available to selected repositories. /// Organization variables that are available to selected repositories have their `visibility` field set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/variables/{name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/{repository_id}/put(actions/add-selected-repo-to-org-variable)`. @@ -2165,11 +2166,10 @@ extension APIProtocol { /// available to selected repositories. Organization variables that are available to /// selected repositories have their `visibility` field set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/variables/{name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/{repository_id}/delete(actions/remove-selected-repo-from-org-variable)`. public func actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_variable(path: Operations.actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_variable.Input.Path) async throws -> Operations.actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_variable.Output { @@ -2177,7 +2177,11 @@ extension APIProtocol { } /// List artifacts for a repository /// - /// Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Lists all artifacts for a repository. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/artifacts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/get(actions/list-artifacts-for-repo)`. @@ -2194,7 +2198,11 @@ extension APIProtocol { } /// Get an artifact /// - /// Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific artifact for a workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/{artifact_id}/get(actions/get-artifact)`. @@ -2209,7 +2217,8 @@ extension APIProtocol { } /// Delete an artifact /// - /// Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// Deletes an artifact for a workflow run. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/{artifact_id}/delete(actions/delete-artifact)`. @@ -2221,8 +2230,7 @@ extension APIProtocol { /// Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in /// the response header to find the URL for the download. The `:archive_format` must be `zip`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:read` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}/get(actions/download-artifact)`. @@ -2239,7 +2247,10 @@ extension APIProtocol { /// /// Gets GitHub Actions cache usage for a repository. /// The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/cache/usage`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/cache/usage/get(actions/get-actions-cache-usage)`. @@ -2255,8 +2266,8 @@ extension APIProtocol { /// List GitHub Actions caches for a repository /// /// Lists the GitHub Actions caches for a repository. - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/caches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/caches/get(actions/get-actions-cache-list)`. @@ -2275,9 +2286,7 @@ extension APIProtocol { /// /// Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/caches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/caches/delete(actions/delete-actions-cache-by-key)`. @@ -2296,9 +2305,7 @@ extension APIProtocol { /// /// Deletes a GitHub Actions cache for a repository, using a cache ID. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/caches/{cache_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/caches/{cache_id}/delete(actions/delete-actions-cache-by-id)`. @@ -2307,7 +2314,11 @@ extension APIProtocol { } /// Get a job for a workflow run /// - /// Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific job in a workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/jobs/{job_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/jobs/{job_id}/get(actions/get-job-for-workflow-run)`. @@ -2323,9 +2334,11 @@ extension APIProtocol { /// Download job logs for a workflow run /// /// Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look - /// for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can - /// use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must - /// have the `actions:read` permission to use this endpoint. + /// for `Location:` in the response header to find the URL for the download. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/jobs/{job_id}/logs/get(actions/download-job-logs-for-workflow-run)`. @@ -2336,8 +2349,7 @@ extension APIProtocol { /// /// Re-run a job and its dependent jobs in a workflow run. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/jobs/{job_id}/rerun/post(actions/re-run-job-for-workflow-run)`. @@ -2355,8 +2367,8 @@ extension APIProtocol { /// Get the customization template for an OIDC subject claim for a repository /// /// Gets the customization template for an OpenID Connect (OIDC) subject claim. - /// You must authenticate using an access token with the `repo` scope to use this - /// endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/oidc/customization/sub/get(actions/get-custom-oidc-sub-claim-for-repo)`. @@ -2372,8 +2384,8 @@ extension APIProtocol { /// Set the customization template for an OIDC subject claim for a repository /// /// Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - /// You must authenticate using an access token with the `repo` scope to use this - /// endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/oidc/customization/sub/put(actions/set-custom-oidc-sub-claim-for-repo)`. @@ -2393,10 +2405,10 @@ extension APIProtocol { /// Lists all organization secrets shared with a repository without revealing their encrypted /// values. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/organization-secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/organization-secrets/get(actions/list-repo-organization-secrets)`. public func actions_sol_list_hyphen_repo_hyphen_organization_hyphen_secrets( @@ -2412,12 +2424,12 @@ extension APIProtocol { } /// List repository organization variables /// - /// Lists all organiation variables shared with a repository. + /// Lists all organization variables shared with a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/organization-variables`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/organization-variables/get(actions/list-repo-organization-variables)`. public func actions_sol_list_hyphen_repo_hyphen_organization_hyphen_variables( @@ -2435,7 +2447,7 @@ extension APIProtocol { /// /// Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/get(actions/get-github-actions-permissions-repository)`. @@ -2452,7 +2464,7 @@ extension APIProtocol { /// /// Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/put(actions/set-github-actions-permissions-repository)`. @@ -2471,8 +2483,7 @@ extension APIProtocol { /// This endpoint only applies to private repositories. /// For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - /// repository `administration` permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions/access`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/access/get(actions/get-workflow-access-to-repository)`. @@ -2491,8 +2502,7 @@ extension APIProtocol { /// This endpoint only applies to private repositories. /// For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - /// repository `administration` permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions/access`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/access/put(actions/set-workflow-access-to-repository)`. @@ -2509,7 +2519,7 @@ extension APIProtocol { /// /// Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/selected-actions/get(actions/get-allowed-actions-repository)`. @@ -2526,7 +2536,7 @@ extension APIProtocol { /// /// Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/selected-actions/put(actions/set-allowed-actions-repository)`. @@ -2545,7 +2555,7 @@ extension APIProtocol { /// as well as if GitHub Actions can submit approving pull request reviews. /// For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/workflow/get(actions/get-github-actions-default-workflow-permissions-repository)`. @@ -2564,7 +2574,7 @@ extension APIProtocol { /// can submit approving pull request reviews. /// For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/workflow/put(actions/set-github-actions-default-workflow-permissions-repository)`. @@ -2581,9 +2591,9 @@ extension APIProtocol { /// /// Lists all self-hosted runners configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/get(actions/list-self-hosted-runners-for-repo)`. @@ -2602,9 +2612,9 @@ extension APIProtocol { /// /// Lists binaries for the runner application that you can download and run. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners/downloads`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/downloads/get(actions/list-runner-applications-for-repo)`. @@ -2621,9 +2631,9 @@ extension APIProtocol { /// /// Generates a configuration that can be passed to the runner application at startup. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// The authenticated user must have admin access to the repository. + /// + /// OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/generate-jitconfig`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/generate-jitconfig/post(actions/generate-runner-jitconfig-for-repo)`. @@ -2640,19 +2650,17 @@ extension APIProtocol { } /// Create a registration token for a repository /// - /// Returns a token that you can pass to the `config` script. The token - /// expires after one hour. + /// Returns a token that you can pass to the `config` script. The token expires after one hour. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: /// - /// Example using registration token: + /// ``` + /// ./config.sh --url https://github.com/octo-org --token TOKEN + /// ``` /// - /// Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - /// by this endpoint. + /// Authenticated users must have admin access to the repository to use this endpoint. /// - /// ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/registration-token`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/registration-token/post(actions/create-registration-token-for-repo)`. @@ -2667,19 +2675,17 @@ extension APIProtocol { } /// Create a remove token for a repository /// - /// Returns a token that you can pass to remove a self-hosted runner from - /// a repository. The token expires after one hour. + /// Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: /// - /// Example using remove token: + /// ``` + /// ./config.sh remove --token TOKEN + /// ``` /// - /// To remove your self-hosted runner from a repository, replace TOKEN with - /// the remove token provided by this endpoint. + /// Authenticated users must have admin access to the repository to use this endpoint. /// - /// ```config.sh remove --token TOKEN``` + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/remove-token`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/remove-token/post(actions/create-remove-token-for-repo)`. @@ -2696,9 +2702,9 @@ extension APIProtocol { /// /// Gets a specific self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/get(actions/get-self-hosted-runner-for-repo)`. @@ -2715,9 +2721,9 @@ extension APIProtocol { /// /// Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/delete(actions/delete-self-hosted-runner-from-repo)`. @@ -2728,9 +2734,9 @@ extension APIProtocol { /// /// Lists all labels for a self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/get(actions/list-labels-for-self-hosted-runner-for-repo)`. @@ -2745,11 +2751,11 @@ extension APIProtocol { } /// Add custom labels to a self-hosted runner for a repository /// - /// Add custom labels to a self-hosted runner configured in a repository. + /// Adds custom labels to a self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/post(actions/add-custom-labels-to-self-hosted-runner-for-repo)`. @@ -2769,9 +2775,9 @@ extension APIProtocol { /// Remove all previous custom labels and set the new custom labels for a specific /// self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/put(actions/set-custom-labels-for-self-hosted-runner-for-repo)`. @@ -2791,9 +2797,9 @@ extension APIProtocol { /// Remove all custom labels from a self-hosted runner configured in a /// repository. Returns the remaining read-only labels from the runner. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/delete(actions/remove-all-custom-labels-from-self-hosted-runner-for-repo)`. @@ -2814,9 +2820,9 @@ extension APIProtocol { /// This endpoint returns a `404 Not Found` status if the custom label is not /// present on the runner. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}/delete(actions/remove-custom-label-from-self-hosted-runner-for-repo)`. @@ -2833,7 +2839,9 @@ extension APIProtocol { /// /// Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/get(actions/list-workflow-runs-for-repo)`. @@ -2850,7 +2858,11 @@ extension APIProtocol { } /// Get a workflow run /// - /// Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/get(actions/get-workflow-run)`. @@ -2867,9 +2879,11 @@ extension APIProtocol { } /// Delete a workflow run /// - /// Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is - /// private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use - /// this endpoint. + /// Deletes a specific workflow run. + /// + /// Anyone with write access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runs/{run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/delete(actions/delete-workflow-run)`. @@ -2878,7 +2892,9 @@ extension APIProtocol { } /// Get the review history for a workflow run /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/approvals/get(actions/get-reviews-for-run)`. @@ -2895,7 +2911,7 @@ extension APIProtocol { /// /// Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/approve/post(actions/approve-workflow-run)`. @@ -2910,7 +2926,11 @@ extension APIProtocol { } /// List workflow run artifacts /// - /// Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Lists artifacts for a workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/artifacts/get(actions/list-workflow-run-artifacts)`. @@ -2927,10 +2947,11 @@ extension APIProtocol { } /// Get a workflow run attempt /// - /// Gets a specific workflow run attempt. Anyone with read access to the repository - /// can use this endpoint. If the repository is private you must use an access token - /// with the `repo` scope. GitHub Apps must have the `actions:read` permission to - /// use this endpoint. + /// Gets a specific workflow run attempt. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/get(actions/get-workflow-run-attempt)`. @@ -2947,7 +2968,12 @@ extension APIProtocol { } /// List jobs for a workflow run attempt /// - /// Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information + /// about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs/get(actions/list-jobs-for-workflow-run-attempt)`. @@ -2965,9 +2991,11 @@ extension APIProtocol { /// Download workflow run attempt logs /// /// Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - /// 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to - /// the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. - /// GitHub Apps must have the `actions:read` permission to use this endpoint. + /// 1 minute. Look for `Location:` in the response header to find the URL for the download. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs/get(actions/download-workflow-run-attempt-logs)`. @@ -2978,8 +3006,7 @@ extension APIProtocol { /// /// Cancels a workflow run using its `id`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/cancel/post(actions/cancel-workflow-run)`. @@ -2999,8 +3026,7 @@ extension APIProtocol { /// **Note:** GitHub Apps can only review their own custom deployment protection rules. /// To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). /// - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have read and write permission for **Deployments** to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule/post(actions/review-custom-gates-for-run)`. @@ -3018,8 +3044,7 @@ extension APIProtocol { /// Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. /// You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel/post(actions/force-cancel-workflow-run)`. @@ -3034,7 +3059,12 @@ extension APIProtocol { } /// List jobs for a workflow run /// - /// Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information + /// about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/jobs/get(actions/list-jobs-for-workflow-run)`. @@ -3052,9 +3082,11 @@ extension APIProtocol { /// Download workflow run logs /// /// Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - /// `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use - /// this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have - /// the `actions:read` permission to use this endpoint. + /// `Location:` in the response header to find the URL for the download. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/logs/get(actions/download-workflow-run-logs)`. @@ -3063,7 +3095,9 @@ extension APIProtocol { } /// Delete workflow run logs /// - /// Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// Deletes all logs for a workflow run. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/logs/delete(actions/delete-workflow-run-logs)`. @@ -3080,7 +3114,9 @@ extension APIProtocol { /// /// Get all deployment environments for a workflow run that are waiting for protection rules to pass. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments/get(actions/get-pending-deployments-for-run)`. @@ -3097,7 +3133,9 @@ extension APIProtocol { /// /// Approve or reject pending deployments that are waiting on approval by a required reviewer. /// - /// Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. + /// Required reviewers with read access to the repository contents and deployments can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments/post(actions/review-pending-deployments-for-run)`. @@ -3114,7 +3152,9 @@ extension APIProtocol { } /// Re-run a workflow /// - /// Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// Re-runs your workflow run using its `id`. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/rerun/post(actions/re-run-workflow)`. @@ -3131,7 +3171,9 @@ extension APIProtocol { } /// Re-run failed jobs from a workflow run /// - /// Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. + /// Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs/post(actions/re-run-workflow-failed-jobs)`. @@ -3150,7 +3192,9 @@ extension APIProtocol { /// /// Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/timing/get(actions/get-workflow-run-usage)`. @@ -3168,10 +3212,10 @@ extension APIProtocol { /// Lists all secrets available in a repository without revealing their encrypted /// values. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/get(actions/list-repo-secrets)`. public func actions_sol_list_hyphen_repo_hyphen_secrets( @@ -3191,9 +3235,8 @@ extension APIProtocol { /// encrypt a secret before you can create or update secrets. /// /// Anyone with read access to the repository can use this endpoint. - /// If the repository is private you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/secrets/public-key`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/public-key/get(actions/get-repo-public-key)`. @@ -3210,9 +3253,9 @@ extension APIProtocol { /// /// Gets a single repository secret without revealing its encrypted value. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// The authenticated user must have collaborator access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/{secret_name}/get(actions/get-repo-secret)`. @@ -3230,10 +3273,10 @@ extension APIProtocol { /// Creates or updates a repository secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/{secret_name}/put(actions/create-or-update-repo-secret)`. public func actions_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret( @@ -3251,10 +3294,10 @@ extension APIProtocol { /// /// Deletes a secret in a repository using the secret name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/{secret_name}/delete(actions/delete-repo-secret)`. public func actions_sol_delete_hyphen_repo_hyphen_secret(path: Operations.actions_sol_delete_hyphen_repo_hyphen_secret.Input.Path) async throws -> Operations.actions_sol_delete_hyphen_repo_hyphen_secret.Output { @@ -3263,10 +3306,11 @@ extension APIProtocol { /// List repository variables /// /// Lists all repository variables. - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + /// /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/variables`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/get(actions/list-repo-variables)`. public func actions_sol_list_hyphen_repo_hyphen_variables( @@ -3284,10 +3328,10 @@ extension APIProtocol { /// /// Creates a repository variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/variables`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/post(actions/create-repo-variable)`. public func actions_sol_create_hyphen_repo_hyphen_variable( @@ -3305,9 +3349,9 @@ extension APIProtocol { /// /// Gets a specific variable in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// The authenticated user must have collaborator access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/{name}/get(actions/get-repo-variable)`. @@ -3324,10 +3368,10 @@ extension APIProtocol { /// /// Updates a repository variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/{name}/patch(actions/update-repo-variable)`. public func actions_sol_update_hyphen_repo_hyphen_variable( @@ -3343,10 +3387,10 @@ extension APIProtocol { /// /// Deletes a repository variable using the variable name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/{name}/delete(actions/delete-repo-variable)`. public func actions_sol_delete_hyphen_repo_hyphen_variable(path: Operations.actions_sol_delete_hyphen_repo_hyphen_variable.Input.Path) async throws -> Operations.actions_sol_delete_hyphen_repo_hyphen_variable.Output { @@ -3354,7 +3398,11 @@ extension APIProtocol { } /// List repository workflows /// - /// Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Lists the workflows in a repository. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/get(actions/list-repo-workflows)`. @@ -3371,7 +3419,12 @@ extension APIProtocol { } /// Get a workflow /// - /// Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific workflow. You can replace `workflow_id` with the workflow + /// file name. For example, you could use `main.yaml`. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/get(actions/get-workflow)`. @@ -3388,7 +3441,7 @@ extension APIProtocol { /// /// Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable/put(actions/disable-workflow)`. @@ -3401,7 +3454,7 @@ extension APIProtocol { /// /// You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches/post(actions/create-workflow-dispatch)`. @@ -3418,7 +3471,7 @@ extension APIProtocol { /// /// Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable/put(actions/enable-workflow)`. @@ -3429,7 +3482,9 @@ extension APIProtocol { /// /// List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + /// Anyone with read access to the repository can use this endpoint + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs/get(actions/list-workflow-runs)`. @@ -3448,7 +3503,11 @@ extension APIProtocol { /// /// Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing/get(actions/get-workflow-usage)`. @@ -3466,10 +3525,10 @@ extension APIProtocol { /// Lists all secrets available in an environment without revealing their /// encrypted values. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/secrets`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/get(actions/list-environment-secrets)`. public func actions_sol_list_hyphen_environment_hyphen_secrets( @@ -3489,9 +3548,8 @@ extension APIProtocol { /// secrets. You need to encrypt a secret before you can create or update secrets. /// /// Anyone with read access to the repository can use this endpoint. - /// If the repository is private you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/public-key/get(actions/get-environment-public-key)`. @@ -3508,10 +3566,10 @@ extension APIProtocol { /// /// Gets a single environment secret without revealing its encrypted value. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}/get(actions/get-environment-secret)`. public func actions_sol_get_hyphen_environment_hyphen_secret( @@ -3528,10 +3586,10 @@ extension APIProtocol { /// Creates or updates an environment secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}/put(actions/create-or-update-environment-secret)`. public func actions_sol_create_hyphen_or_hyphen_update_hyphen_environment_hyphen_secret( @@ -3549,10 +3607,10 @@ extension APIProtocol { /// /// Deletes a secret in an environment using the secret name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}/delete(actions/delete-environment-secret)`. public func actions_sol_delete_hyphen_environment_hyphen_secret(path: Operations.actions_sol_delete_hyphen_environment_hyphen_secret.Input.Path) async throws -> Operations.actions_sol_delete_hyphen_environment_hyphen_secret.Output { @@ -3562,10 +3620,10 @@ extension APIProtocol { /// /// Lists all environment variables. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environments:read` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/variables`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/get(actions/list-environment-variables)`. public func actions_sol_list_hyphen_environment_hyphen_variables( @@ -3583,10 +3641,10 @@ extension APIProtocol { /// /// Create an environment variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environment:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repositories/{repository_id}/environments/{environment_name}/variables`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/post(actions/create-environment-variable)`. public func actions_sol_create_hyphen_environment_hyphen_variable( @@ -3604,10 +3662,10 @@ extension APIProtocol { /// /// Gets a specific variable in an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environments:read` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/variables/{name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/{name}/get(actions/get-environment-variable)`. public func actions_sol_get_hyphen_environment_hyphen_variable( @@ -3623,10 +3681,10 @@ extension APIProtocol { /// /// Updates an environment variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environment:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /repositories/{repository_id}/environments/{environment_name}/variables/{name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/{name}/patch(actions/update-environment-variable)`. public func actions_sol_update_hyphen_environment_hyphen_variable( @@ -3642,10 +3700,10 @@ extension APIProtocol { /// /// Deletes an environment variable using the variable name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environment:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/{name}/delete(actions/delete-environment-variable)`. public func actions_sol_delete_hyphen_environment_hyphen_variable(path: Operations.actions_sol_delete_hyphen_environment_hyphen_variable.Input.Path) async throws -> Operations.actions_sol_delete_hyphen_environment_hyphen_variable.Output { @@ -4129,8 +4187,6 @@ public enum Components { public var full_name: Swift.String /// - Remark: Generated from `#/components/schemas/repository/license`. public var license: Components.Schemas.nullable_hyphen_license_hyphen_simple? - /// - Remark: Generated from `#/components/schemas/repository/organization`. - public var organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? /// - Remark: Generated from `#/components/schemas/repository/forks`. public var forks: Swift.Int /// - Remark: Generated from `#/components/schemas/repository/permissions`. @@ -4343,767 +4399,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/repository/allow_rebase_merge`. public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository`. - public struct template_repositoryPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/name`. - public var name: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/full_name`. - public var full_name: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner`. - public struct ownerPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/login`. - public var login: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/avatar_url`. - public var avatar_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/gravatar_id`. - public var gravatar_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/followers_url`. - public var followers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/following_url`. - public var following_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/gists_url`. - public var gists_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/starred_url`. - public var starred_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/subscriptions_url`. - public var subscriptions_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/organizations_url`. - public var organizations_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/repos_url`. - public var repos_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/received_events_url`. - public var received_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/type`. - public var _type: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/site_admin`. - public var site_admin: Swift.Bool? - /// Creates a new `ownerPayload`. - /// - /// - Parameters: - /// - login: - /// - id: - /// - node_id: - /// - avatar_url: - /// - gravatar_id: - /// - url: - /// - html_url: - /// - followers_url: - /// - following_url: - /// - gists_url: - /// - starred_url: - /// - subscriptions_url: - /// - organizations_url: - /// - repos_url: - /// - events_url: - /// - received_events_url: - /// - _type: - /// - site_admin: - public init( - login: Swift.String? = nil, - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - avatar_url: Swift.String? = nil, - gravatar_id: Swift.String? = nil, - url: Swift.String? = nil, - html_url: Swift.String? = nil, - followers_url: Swift.String? = nil, - following_url: Swift.String? = nil, - gists_url: Swift.String? = nil, - starred_url: Swift.String? = nil, - subscriptions_url: Swift.String? = nil, - organizations_url: Swift.String? = nil, - repos_url: Swift.String? = nil, - events_url: Swift.String? = nil, - received_events_url: Swift.String? = nil, - _type: Swift.String? = nil, - site_admin: Swift.Bool? = nil - ) { - self.login = login - self.id = id - self.node_id = node_id - self.avatar_url = avatar_url - self.gravatar_id = gravatar_id - self.url = url - self.html_url = html_url - self.followers_url = followers_url - self.following_url = following_url - self.gists_url = gists_url - self.starred_url = starred_url - self.subscriptions_url = subscriptions_url - self.organizations_url = organizations_url - self.repos_url = repos_url - self.events_url = events_url - self.received_events_url = received_events_url - self._type = _type - self.site_admin = site_admin - } - public enum CodingKeys: String, CodingKey { - case login - case id - case node_id - case avatar_url - case gravatar_id - case url - case html_url - case followers_url - case following_url - case gists_url - case starred_url - case subscriptions_url - case organizations_url - case repos_url - case events_url - case received_events_url - case _type = "type" - case site_admin - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner`. - public var owner: Components.Schemas.repository.template_repositoryPayload.ownerPayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/private`. - public var _private: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/description`. - public var description: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/fork`. - public var fork: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/archive_url`. - public var archive_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/assignees_url`. - public var assignees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/blobs_url`. - public var blobs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/branches_url`. - public var branches_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/collaborators_url`. - public var collaborators_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/comments_url`. - public var comments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/commits_url`. - public var commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/compare_url`. - public var compare_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/contents_url`. - public var contents_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/contributors_url`. - public var contributors_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/deployments_url`. - public var deployments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/downloads_url`. - public var downloads_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/forks_url`. - public var forks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_commits_url`. - public var git_commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_refs_url`. - public var git_refs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_tags_url`. - public var git_tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_url`. - public var git_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issue_comment_url`. - public var issue_comment_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issue_events_url`. - public var issue_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issues_url`. - public var issues_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/keys_url`. - public var keys_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/labels_url`. - public var labels_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/languages_url`. - public var languages_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merges_url`. - public var merges_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/milestones_url`. - public var milestones_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/notifications_url`. - public var notifications_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/pulls_url`. - public var pulls_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/releases_url`. - public var releases_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/ssh_url`. - public var ssh_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/stargazers_url`. - public var stargazers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/statuses_url`. - public var statuses_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscribers_url`. - public var subscribers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscription_url`. - public var subscription_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/tags_url`. - public var tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/teams_url`. - public var teams_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/trees_url`. - public var trees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/clone_url`. - public var clone_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/mirror_url`. - public var mirror_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/hooks_url`. - public var hooks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/svn_url`. - public var svn_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/homepage`. - public var homepage: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/language`. - public var language: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/forks_count`. - public var forks_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/stargazers_count`. - public var stargazers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/watchers_count`. - public var watchers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/size`. - public var size: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/default_branch`. - public var default_branch: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/open_issues_count`. - public var open_issues_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/is_template`. - public var is_template: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/topics`. - public var topics: [Swift.String]? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_issues`. - public var has_issues: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_projects`. - public var has_projects: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_wiki`. - public var has_wiki: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_pages`. - public var has_pages: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_downloads`. - public var has_downloads: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/archived`. - public var archived: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/disabled`. - public var disabled: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/visibility`. - public var visibility: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/pushed_at`. - public var pushed_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/created_at`. - public var created_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/updated_at`. - public var updated_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions`. - public struct permissionsPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/admin`. - public var admin: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/maintain`. - public var maintain: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/push`. - public var push: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/triage`. - public var triage: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/pull`. - public var pull: Swift.Bool? - /// Creates a new `permissionsPayload`. - /// - /// - Parameters: - /// - admin: - /// - maintain: - /// - push: - /// - triage: - /// - pull: - public init( - admin: Swift.Bool? = nil, - maintain: Swift.Bool? = nil, - push: Swift.Bool? = nil, - triage: Swift.Bool? = nil, - pull: Swift.Bool? = nil - ) { - self.admin = admin - self.maintain = maintain - self.push = push - self.triage = triage - self.pull = pull - } - public enum CodingKeys: String, CodingKey { - case admin - case maintain - case push - case triage - case pull - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions`. - public var permissions: Components.Schemas.repository.template_repositoryPayload.permissionsPayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_rebase_merge`. - public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/temp_clone_token`. - public var temp_clone_token: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_squash_merge`. - public var allow_squash_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_auto_merge`. - public var allow_auto_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/delete_branch_on_merge`. - public var delete_branch_on_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_update_branch`. - public var allow_update_branch: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/use_squash_pr_title_as_default`. - public var use_squash_pr_title_as_default: Swift.Bool? - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_title`. - @frozen public enum squash_merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case COMMIT_OR_PR_TITLE = "COMMIT_OR_PR_TITLE" - } - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_title`. - public var squash_merge_commit_title: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_titlePayload? - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_message`. - @frozen public enum squash_merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case COMMIT_MESSAGES = "COMMIT_MESSAGES" - case BLANK = "BLANK" - } - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_message`. - public var squash_merge_commit_message: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_messagePayload? - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_title`. - @frozen public enum merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case MERGE_MESSAGE = "MERGE_MESSAGE" - } - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_title`. - public var merge_commit_title: Components.Schemas.repository.template_repositoryPayload.merge_commit_titlePayload? - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_message`. - @frozen public enum merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case PR_TITLE = "PR_TITLE" - case BLANK = "BLANK" - } - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_message`. - public var merge_commit_message: Components.Schemas.repository.template_repositoryPayload.merge_commit_messagePayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_merge_commit`. - public var allow_merge_commit: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/network_count`. - public var network_count: Swift.Int? - /// Creates a new `template_repositoryPayload`. - /// - /// - Parameters: - /// - id: - /// - node_id: - /// - name: - /// - full_name: - /// - owner: - /// - _private: - /// - html_url: - /// - description: - /// - fork: - /// - url: - /// - archive_url: - /// - assignees_url: - /// - blobs_url: - /// - branches_url: - /// - collaborators_url: - /// - comments_url: - /// - commits_url: - /// - compare_url: - /// - contents_url: - /// - contributors_url: - /// - deployments_url: - /// - downloads_url: - /// - events_url: - /// - forks_url: - /// - git_commits_url: - /// - git_refs_url: - /// - git_tags_url: - /// - git_url: - /// - issue_comment_url: - /// - issue_events_url: - /// - issues_url: - /// - keys_url: - /// - labels_url: - /// - languages_url: - /// - merges_url: - /// - milestones_url: - /// - notifications_url: - /// - pulls_url: - /// - releases_url: - /// - ssh_url: - /// - stargazers_url: - /// - statuses_url: - /// - subscribers_url: - /// - subscription_url: - /// - tags_url: - /// - teams_url: - /// - trees_url: - /// - clone_url: - /// - mirror_url: - /// - hooks_url: - /// - svn_url: - /// - homepage: - /// - language: - /// - forks_count: - /// - stargazers_count: - /// - watchers_count: - /// - size: - /// - default_branch: - /// - open_issues_count: - /// - is_template: - /// - topics: - /// - has_issues: - /// - has_projects: - /// - has_wiki: - /// - has_pages: - /// - has_downloads: - /// - archived: - /// - disabled: - /// - visibility: - /// - pushed_at: - /// - created_at: - /// - updated_at: - /// - permissions: - /// - allow_rebase_merge: - /// - temp_clone_token: - /// - allow_squash_merge: - /// - allow_auto_merge: - /// - delete_branch_on_merge: - /// - allow_update_branch: - /// - use_squash_pr_title_as_default: - /// - squash_merge_commit_title: The default value for a squash merge commit title: - /// - squash_merge_commit_message: The default value for a squash merge commit message: - /// - merge_commit_title: The default value for a merge commit title. - /// - merge_commit_message: The default value for a merge commit message. - /// - allow_merge_commit: - /// - subscribers_count: - /// - network_count: - public init( - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - name: Swift.String? = nil, - full_name: Swift.String? = nil, - owner: Components.Schemas.repository.template_repositoryPayload.ownerPayload? = nil, - _private: Swift.Bool? = nil, - html_url: Swift.String? = nil, - description: Swift.String? = nil, - fork: Swift.Bool? = nil, - url: Swift.String? = nil, - archive_url: Swift.String? = nil, - assignees_url: Swift.String? = nil, - blobs_url: Swift.String? = nil, - branches_url: Swift.String? = nil, - collaborators_url: Swift.String? = nil, - comments_url: Swift.String? = nil, - commits_url: Swift.String? = nil, - compare_url: Swift.String? = nil, - contents_url: Swift.String? = nil, - contributors_url: Swift.String? = nil, - deployments_url: Swift.String? = nil, - downloads_url: Swift.String? = nil, - events_url: Swift.String? = nil, - forks_url: Swift.String? = nil, - git_commits_url: Swift.String? = nil, - git_refs_url: Swift.String? = nil, - git_tags_url: Swift.String? = nil, - git_url: Swift.String? = nil, - issue_comment_url: Swift.String? = nil, - issue_events_url: Swift.String? = nil, - issues_url: Swift.String? = nil, - keys_url: Swift.String? = nil, - labels_url: Swift.String? = nil, - languages_url: Swift.String? = nil, - merges_url: Swift.String? = nil, - milestones_url: Swift.String? = nil, - notifications_url: Swift.String? = nil, - pulls_url: Swift.String? = nil, - releases_url: Swift.String? = nil, - ssh_url: Swift.String? = nil, - stargazers_url: Swift.String? = nil, - statuses_url: Swift.String? = nil, - subscribers_url: Swift.String? = nil, - subscription_url: Swift.String? = nil, - tags_url: Swift.String? = nil, - teams_url: Swift.String? = nil, - trees_url: Swift.String? = nil, - clone_url: Swift.String? = nil, - mirror_url: Swift.String? = nil, - hooks_url: Swift.String? = nil, - svn_url: Swift.String? = nil, - homepage: Swift.String? = nil, - language: Swift.String? = nil, - forks_count: Swift.Int? = nil, - stargazers_count: Swift.Int? = nil, - watchers_count: Swift.Int? = nil, - size: Swift.Int? = nil, - default_branch: Swift.String? = nil, - open_issues_count: Swift.Int? = nil, - is_template: Swift.Bool? = nil, - topics: [Swift.String]? = nil, - has_issues: Swift.Bool? = nil, - has_projects: Swift.Bool? = nil, - has_wiki: Swift.Bool? = nil, - has_pages: Swift.Bool? = nil, - has_downloads: Swift.Bool? = nil, - archived: Swift.Bool? = nil, - disabled: Swift.Bool? = nil, - visibility: Swift.String? = nil, - pushed_at: Swift.String? = nil, - created_at: Swift.String? = nil, - updated_at: Swift.String? = nil, - permissions: Components.Schemas.repository.template_repositoryPayload.permissionsPayload? = nil, - allow_rebase_merge: Swift.Bool? = nil, - temp_clone_token: Swift.String? = nil, - allow_squash_merge: Swift.Bool? = nil, - allow_auto_merge: Swift.Bool? = nil, - delete_branch_on_merge: Swift.Bool? = nil, - allow_update_branch: Swift.Bool? = nil, - use_squash_pr_title_as_default: Swift.Bool? = nil, - squash_merge_commit_title: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_titlePayload? = nil, - squash_merge_commit_message: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_messagePayload? = nil, - merge_commit_title: Components.Schemas.repository.template_repositoryPayload.merge_commit_titlePayload? = nil, - merge_commit_message: Components.Schemas.repository.template_repositoryPayload.merge_commit_messagePayload? = nil, - allow_merge_commit: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil - ) { - self.id = id - self.node_id = node_id - self.name = name - self.full_name = full_name - self.owner = owner - self._private = _private - self.html_url = html_url - self.description = description - self.fork = fork - self.url = url - self.archive_url = archive_url - self.assignees_url = assignees_url - self.blobs_url = blobs_url - self.branches_url = branches_url - self.collaborators_url = collaborators_url - self.comments_url = comments_url - self.commits_url = commits_url - self.compare_url = compare_url - self.contents_url = contents_url - self.contributors_url = contributors_url - self.deployments_url = deployments_url - self.downloads_url = downloads_url - self.events_url = events_url - self.forks_url = forks_url - self.git_commits_url = git_commits_url - self.git_refs_url = git_refs_url - self.git_tags_url = git_tags_url - self.git_url = git_url - self.issue_comment_url = issue_comment_url - self.issue_events_url = issue_events_url - self.issues_url = issues_url - self.keys_url = keys_url - self.labels_url = labels_url - self.languages_url = languages_url - self.merges_url = merges_url - self.milestones_url = milestones_url - self.notifications_url = notifications_url - self.pulls_url = pulls_url - self.releases_url = releases_url - self.ssh_url = ssh_url - self.stargazers_url = stargazers_url - self.statuses_url = statuses_url - self.subscribers_url = subscribers_url - self.subscription_url = subscription_url - self.tags_url = tags_url - self.teams_url = teams_url - self.trees_url = trees_url - self.clone_url = clone_url - self.mirror_url = mirror_url - self.hooks_url = hooks_url - self.svn_url = svn_url - self.homepage = homepage - self.language = language - self.forks_count = forks_count - self.stargazers_count = stargazers_count - self.watchers_count = watchers_count - self.size = size - self.default_branch = default_branch - self.open_issues_count = open_issues_count - self.is_template = is_template - self.topics = topics - self.has_issues = has_issues - self.has_projects = has_projects - self.has_wiki = has_wiki - self.has_pages = has_pages - self.has_downloads = has_downloads - self.archived = archived - self.disabled = disabled - self.visibility = visibility - self.pushed_at = pushed_at - self.created_at = created_at - self.updated_at = updated_at - self.permissions = permissions - self.allow_rebase_merge = allow_rebase_merge - self.temp_clone_token = temp_clone_token - self.allow_squash_merge = allow_squash_merge - self.allow_auto_merge = allow_auto_merge - self.delete_branch_on_merge = delete_branch_on_merge - self.allow_update_branch = allow_update_branch - self.use_squash_pr_title_as_default = use_squash_pr_title_as_default - self.squash_merge_commit_title = squash_merge_commit_title - self.squash_merge_commit_message = squash_merge_commit_message - self.merge_commit_title = merge_commit_title - self.merge_commit_message = merge_commit_message - self.allow_merge_commit = allow_merge_commit - self.subscribers_count = subscribers_count - self.network_count = network_count - } - public enum CodingKeys: String, CodingKey { - case id - case node_id - case name - case full_name - case owner - case _private = "private" - case html_url - case description - case fork - case url - case archive_url - case assignees_url - case blobs_url - case branches_url - case collaborators_url - case comments_url - case commits_url - case compare_url - case contents_url - case contributors_url - case deployments_url - case downloads_url - case events_url - case forks_url - case git_commits_url - case git_refs_url - case git_tags_url - case git_url - case issue_comment_url - case issue_events_url - case issues_url - case keys_url - case labels_url - case languages_url - case merges_url - case milestones_url - case notifications_url - case pulls_url - case releases_url - case ssh_url - case stargazers_url - case statuses_url - case subscribers_url - case subscription_url - case tags_url - case teams_url - case trees_url - case clone_url - case mirror_url - case hooks_url - case svn_url - case homepage - case language - case forks_count - case stargazers_count - case watchers_count - case size - case default_branch - case open_issues_count - case is_template - case topics - case has_issues - case has_projects - case has_wiki - case has_pages - case has_downloads - case archived - case disabled - case visibility - case pushed_at - case created_at - case updated_at - case permissions - case allow_rebase_merge - case temp_clone_token - case allow_squash_merge - case allow_auto_merge - case delete_branch_on_merge - case allow_update_branch - case use_squash_pr_title_as_default - case squash_merge_commit_title - case squash_merge_commit_message - case merge_commit_title - case merge_commit_message - case allow_merge_commit - case subscribers_count - case network_count - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository`. - public var template_repository: Components.Schemas.repository.template_repositoryPayload? /// - Remark: Generated from `#/components/schemas/repository/temp_clone_token`. public var temp_clone_token: Swift.String? /// Whether to allow squash merges for pull requests. @@ -5213,10 +4508,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/repository/web_commit_signoff_required`. public var web_commit_signoff_required: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/network_count`. - public var network_count: Swift.Int? /// - Remark: Generated from `#/components/schemas/repository/open_issues`. public var open_issues: Swift.Int /// - Remark: Generated from `#/components/schemas/repository/watchers`. @@ -5237,7 +4528,6 @@ public enum Components { /// - name: The name of the repository. /// - full_name: /// - license: - /// - organization: /// - forks: /// - permissions: /// - owner: @@ -5310,7 +4600,6 @@ public enum Components { /// - created_at: /// - updated_at: /// - allow_rebase_merge: Whether to allow rebase merges for pull requests. - /// - template_repository: /// - temp_clone_token: /// - allow_squash_merge: Whether to allow squash merges for pull requests. /// - allow_auto_merge: Whether to allow Auto-merge to be used on pull requests. @@ -5324,8 +4613,6 @@ public enum Components { /// - allow_merge_commit: Whether to allow merge commits for pull requests. /// - allow_forking: Whether to allow forking this repo /// - web_commit_signoff_required: Whether to require contributors to sign off on web-based commits - /// - subscribers_count: - /// - network_count: /// - open_issues: /// - watchers: /// - master_branch: @@ -5337,7 +4624,6 @@ public enum Components { name: Swift.String, full_name: Swift.String, license: Components.Schemas.nullable_hyphen_license_hyphen_simple? = nil, - organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? = nil, forks: Swift.Int, permissions: Components.Schemas.repository.permissionsPayload? = nil, owner: Components.Schemas.simple_hyphen_user, @@ -5410,7 +4696,6 @@ public enum Components { created_at: Foundation.Date? = nil, updated_at: Foundation.Date? = nil, allow_rebase_merge: Swift.Bool? = nil, - template_repository: Components.Schemas.repository.template_repositoryPayload? = nil, temp_clone_token: Swift.String? = nil, allow_squash_merge: Swift.Bool? = nil, allow_auto_merge: Swift.Bool? = nil, @@ -5424,8 +4709,6 @@ public enum Components { allow_merge_commit: Swift.Bool? = nil, allow_forking: Swift.Bool? = nil, web_commit_signoff_required: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil, open_issues: Swift.Int, watchers: Swift.Int, master_branch: Swift.String? = nil, @@ -5437,7 +4720,6 @@ public enum Components { self.name = name self.full_name = full_name self.license = license - self.organization = organization self.forks = forks self.permissions = permissions self.owner = owner @@ -5510,7 +4792,6 @@ public enum Components { self.created_at = created_at self.updated_at = updated_at self.allow_rebase_merge = allow_rebase_merge - self.template_repository = template_repository self.temp_clone_token = temp_clone_token self.allow_squash_merge = allow_squash_merge self.allow_auto_merge = allow_auto_merge @@ -5524,8 +4805,6 @@ public enum Components { self.allow_merge_commit = allow_merge_commit self.allow_forking = allow_forking self.web_commit_signoff_required = web_commit_signoff_required - self.subscribers_count = subscribers_count - self.network_count = network_count self.open_issues = open_issues self.watchers = watchers self.master_branch = master_branch @@ -5538,7 +4817,6 @@ public enum Components { case name case full_name case license - case organization case forks case permissions case owner @@ -5611,7 +4889,6 @@ public enum Components { case created_at case updated_at case allow_rebase_merge - case template_repository case temp_clone_token case allow_squash_merge case allow_auto_merge @@ -5625,8 +4902,6 @@ public enum Components { case allow_merge_commit case allow_forking case web_commit_signoff_required - case subscribers_count - case network_count case open_issues case watchers case master_branch @@ -10275,7 +9550,8 @@ public enum Operations { /// /// Gets the total GitHub Actions cache usage for an organization. /// The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - /// You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/cache/usage`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/cache/usage/get(actions/get-actions-cache-usage-for-org)`. @@ -10428,7 +9704,8 @@ public enum Operations { /// /// Lists repositories and their GitHub Actions cache usage for an organization. /// The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - /// You must authenticate using an access token with the `read:org` scope to use this endpoint. GitHub Apps must have the `organization_admistration:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/cache/usage-by-repository`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/cache/usage-by-repository/get(actions/get-actions-cache-usage-by-repo-for-org)`. @@ -10631,7 +9908,7 @@ public enum Operations { /// /// Gets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/get(actions/get-github-actions-permissions-organization)`. @@ -10765,7 +10042,7 @@ public enum Operations { /// /// Sets the GitHub Actions permissions policy for repositories and allowed actions and reusable workflows in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/put(actions/set-github-actions-permissions-organization)`. @@ -10867,7 +10144,7 @@ public enum Operations { /// /// Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/get(actions/list-selected-repositories-enabled-github-actions-organization)`. @@ -11051,7 +10328,8 @@ public enum Operations { /// /// Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/put(actions/set-selected-repositories-enabled-github-actions-organization)`. @@ -11147,7 +10425,7 @@ public enum Operations { /// /// Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/{repository_id}/put(actions/enable-selected-repository-github-actions-organization)`. @@ -11224,7 +10502,7 @@ public enum Operations { /// /// Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/repositories/{repository_id}/delete(actions/disable-selected-repository-github-actions-organization)`. @@ -11299,9 +10577,9 @@ public enum Operations { } /// Get allowed actions and reusable workflows for an organization /// - /// Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."" + /// Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/selected-actions/get(actions/get-allowed-actions-organization)`. @@ -11435,7 +10713,7 @@ public enum Operations { /// /// Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/selected-actions/put(actions/set-allowed-actions-organization)`. @@ -11516,7 +10794,7 @@ public enum Operations { /// as well as whether GitHub Actions can submit approving pull request reviews. For more information, see /// "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/workflow/get(actions/get-github-actions-default-workflow-permissions-organization)`. @@ -11652,7 +10930,7 @@ public enum Operations { /// can submit approving pull request reviews. For more information, see /// "[Setting the permissions of the GITHUB_TOKEN for your organization](https://docs.github.com/organizations/managing-organization-settings/disabling-or-limiting-github-actions-for-your-organization#setting-the-permissions-of-the-github_token-for-your-organization)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/permissions/workflow/put(actions/set-github-actions-default-workflow-permissions-organization)`. @@ -11731,10 +11009,9 @@ public enum Operations { /// /// Lists all self-hosted runners configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/get(actions/list-self-hosted-runners-for-org)`. @@ -11944,10 +11221,9 @@ public enum Operations { /// /// Lists binaries for the runner application that you can download and run. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners/downloads`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/downloads/get(actions/list-runner-applications-for-org)`. @@ -12081,10 +11357,9 @@ public enum Operations { /// /// Generates a configuration that can be passed to the runner application at startup. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// The authenticated user must have admin access to the organization. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/generate-jitconfig`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/generate-jitconfig/post(actions/generate-runner-jitconfig-for-org)`. @@ -12288,19 +11563,16 @@ public enum Operations { /// /// Returns a token that you can pass to the `config` script. The token expires after one hour. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - /// - /// Example using registration token: - /// - /// Configure your self-hosted runner, replacing `TOKEN` with the registration token provided by this endpoint. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: /// /// ``` /// ./config.sh --url https://github.com/octo-org --token TOKEN /// ``` /// + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/registration-token`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/registration-token/post(actions/create-registration-token-for-org)`. public enum actions_sol_create_hyphen_registration_hyphen_token_hyphen_for_hyphen_org { @@ -12433,20 +11705,16 @@ public enum Operations { /// /// Returns a token that you can pass to the `config` script to remove a self-hosted runner from an organization. The token expires after one hour. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. - /// - /// Example using remove token: - /// - /// To remove your self-hosted runner from an organization, replace `TOKEN` with the remove token provided by this - /// endpoint. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: /// /// ``` /// ./config.sh remove --token TOKEN /// ``` /// + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/remove-token`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/remove-token/post(actions/create-remove-token-for-org)`. public enum actions_sol_create_hyphen_remove_hyphen_token_hyphen_for_hyphen_org { @@ -12579,10 +11847,9 @@ public enum Operations { /// /// Gets a specific self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/get(actions/get-self-hosted-runner-for-org)`. @@ -12725,10 +11992,9 @@ public enum Operations { /// /// Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/delete(actions/delete-self-hosted-runner-from-org)`. @@ -12805,10 +12071,9 @@ public enum Operations { /// /// Lists all labels for a self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/get(actions/list-labels-for-self-hosted-runner-for-org)`. @@ -12944,12 +12209,11 @@ public enum Operations { } /// Add custom labels to a self-hosted runner for an organization /// - /// Add custom labels to a self-hosted runner configured in an organization. + /// Adds custom labels to a self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/post(actions/add-custom-labels-to-self-hosted-runner-for-org)`. @@ -13137,10 +12401,9 @@ public enum Operations { /// Remove all previous custom labels and set the new custom labels for a specific /// self-hosted runner configured in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/put(actions/set-custom-labels-for-self-hosted-runner-for-org)`. @@ -13328,10 +12591,9 @@ public enum Operations { /// Remove all custom labels from a self-hosted runner configured in an /// organization. Returns the remaining read-only labels from the runner. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/delete(actions/remove-all-custom-labels-from-self-hosted-runner-for-org)`. @@ -13473,10 +12735,9 @@ public enum Operations { /// This endpoint returns a `404 Not Found` status if the custom label is not /// present on the runner. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/runners/{runner_id}/labels/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/runners/{runner_id}/labels/{name}/delete(actions/remove-custom-label-from-self-hosted-runner-for-org)`. @@ -13645,11 +12906,10 @@ public enum Operations { /// Lists all secrets available in an organization without revealing their /// encrypted values. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/get(actions/list-org-secrets)`. public enum actions_sol_list_hyphen_org_hyphen_secrets { @@ -13852,10 +13112,9 @@ public enum Operations { /// Gets your public key, which you need to encrypt secrets. You need to /// encrypt a secret before you can create or update secrets. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// The authenticated user must have collaborator access to a repository to create, update, or read secrets. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets/public-key`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/public-key/get(actions/get-org-public-key)`. @@ -13989,10 +13248,9 @@ public enum Operations { /// /// Gets a single organization secret without revealing its encrypted value. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// The authenticated user must have collaborator access to a repository to create, update, or read secrets + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/get(actions/get-org-secret)`. @@ -14136,11 +13394,10 @@ public enum Operations { /// Creates or updates an organization secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/put(actions/create-or-update-org-secret)`. public enum actions_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret { @@ -14369,11 +13626,10 @@ public enum Operations { /// /// Deletes a secret in an organization using the secret name. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/delete(actions/delete-org-secret)`. public enum actions_sol_delete_hyphen_org_hyphen_secret { @@ -14450,11 +13706,10 @@ public enum Operations { /// Lists all repositories that have been selected when the `visibility` /// for repository access to a secret is set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `GET /orgs/{org}/actions/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/get(actions/list-selected-repos-for-org-secret)`. public enum actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret { @@ -14648,11 +13903,10 @@ public enum Operations { /// for repository access is set to `selected`. The visibility is set when you [Create /// or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/put(actions/set-selected-repos-for-org-secret)`. public enum actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret { @@ -14755,14 +14009,13 @@ public enum Operations { /// Add selected repository to an organization secret /// /// Adds a repository to an organization secret when the `visibility` for - /// repository access is set to `selected`. The visibility is set when you [Create or + /// repository access is set to `selected`. For more information about setting the visibility, see [Create or /// update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}/put(actions/add-selected-repo-to-org-secret)`. public enum actions_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret { @@ -14872,11 +14125,10 @@ public enum Operations { /// for repository access is set to `selected`. The visibility is set when you [Create /// or update an organization secret](https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret). /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}/delete(actions/remove-selected-repo-from-org-secret)`. public enum actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret { @@ -14983,7 +14235,10 @@ public enum Operations { /// List organization variables /// /// Lists all organization variables. - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// + /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. /// /// - Remark: HTTP `GET /orgs/{org}/actions/variables`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/get(actions/list-org-variables)`. @@ -15186,11 +14441,10 @@ public enum Operations { /// /// Creates an organization variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/actions/variables`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/post(actions/create-org-variable)`. public enum actions_sol_create_hyphen_org_hyphen_variable { @@ -15383,10 +14637,9 @@ public enum Operations { /// /// Gets a specific variable in an organization. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// The authenticated user must have collaborator access to a repository to create, update, or read variables. + /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/get(actions/get-org-variable)`. @@ -15529,11 +14782,10 @@ public enum Operations { /// /// Updates an organization variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `PATCH /orgs/{org}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/patch(actions/update-org-variable)`. public enum actions_sol_update_hyphen_org_hyphen_variable { @@ -15671,11 +14923,10 @@ public enum Operations { /// /// Deletes an organization variable using the variable name. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/delete(actions/delete-org-variable)`. public enum actions_sol_delete_hyphen_org_hyphen_variable { @@ -15752,11 +15003,10 @@ public enum Operations { /// Lists all repositories that can access an organization variable /// that is available to selected repositories. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:read` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `GET /orgs/{org}/actions/variables/{name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/get(actions/list-selected-repos-for-org-variable)`. public enum actions_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable { @@ -15977,12 +15227,10 @@ public enum Operations { /// to selected repositories. Organization variables that are available to selected /// repositories have their `visibility` field set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this - /// endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `PUT /orgs/{org}/actions/variables/{name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/put(actions/set-selected-repos-for-org-variable)`. public enum actions_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_variable { @@ -16114,10 +15362,9 @@ public enum Operations { /// Adds a repository to an organization variable that is available to selected repositories. /// Organization variables that are available to selected repositories have their `visibility` field set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// + /// OAuth tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/variables/{name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/{repository_id}/put(actions/add-selected-repo-to-org-variable)`. @@ -16228,11 +15475,10 @@ public enum Operations { /// available to selected repositories. Organization variables that are available to /// selected repositories have their `visibility` field set to `selected`. /// - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have the `organization_actions_variables:write` organization permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required. + /// /// - Remark: HTTP `DELETE /orgs/{org}/actions/variables/{name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/variables/{name}/repositories/{repository_id}/delete(actions/remove-selected-repo-from-org-variable)`. public enum actions_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_variable { @@ -16338,7 +15584,11 @@ public enum Operations { } /// List artifacts for a repository /// - /// Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Lists all artifacts for a repository. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/artifacts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/get(actions/list-artifacts-for-repo)`. @@ -16555,7 +15805,11 @@ public enum Operations { } /// Get an artifact /// - /// Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific artifact for a workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/{artifact_id}/get(actions/get-artifact)`. @@ -16703,7 +15957,8 @@ public enum Operations { } /// Delete an artifact /// - /// Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// Deletes an artifact for a workflow run. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/{artifact_id}/delete(actions/delete-artifact)`. @@ -16788,8 +16043,7 @@ public enum Operations { /// Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in /// the response header to find the URL for the download. The `:archive_format` must be `zip`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:read` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}/get(actions/download-artifact)`. @@ -16962,7 +16216,10 @@ public enum Operations { /// /// Gets GitHub Actions cache usage for a repository. /// The data fetched using this API is refreshed approximately every 5 minutes, so values returned from this endpoint may take at least 5 minutes to get updated. - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/cache/usage`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/cache/usage/get(actions/get-actions-cache-usage)`. @@ -17104,8 +16361,8 @@ public enum Operations { /// List GitHub Actions caches for a repository /// /// Lists the GitHub Actions caches for a repository. - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/caches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/caches/get(actions/get-actions-cache-list)`. @@ -17333,9 +16590,7 @@ public enum Operations { /// /// Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/caches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/caches/delete(actions/delete-actions-cache-by-key)`. @@ -17505,9 +16760,7 @@ public enum Operations { /// /// Deletes a GitHub Actions cache for a repository, using a cache ID. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/caches/{cache_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/caches/{cache_id}/delete(actions/delete-actions-cache-by-id)`. @@ -17589,7 +16842,11 @@ public enum Operations { } /// Get a job for a workflow run /// - /// Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific job in a workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/jobs/{job_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/jobs/{job_id}/get(actions/get-job-for-workflow-run)`. @@ -17738,9 +16995,11 @@ public enum Operations { /// Download job logs for a workflow run /// /// Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look - /// for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can - /// use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must - /// have the `actions:read` permission to use this endpoint. + /// for `Location:` in the response header to find the URL for the download. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/jobs/{job_id}/logs/get(actions/download-job-logs-for-workflow-run)`. @@ -17843,8 +17102,7 @@ public enum Operations { /// /// Re-run a job and its dependent jobs in a workflow run. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/jobs/{job_id}/rerun`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/jobs/{job_id}/rerun/post(actions/re-run-job-for-workflow-run)`. @@ -18042,8 +17300,8 @@ public enum Operations { /// Get the customization template for an OIDC subject claim for a repository /// /// Gets the customization template for an OpenID Connect (OIDC) subject claim. - /// You must authenticate using an access token with the `repo` scope to use this - /// endpoint. GitHub Apps must have the `organization_administration:read` permission to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/oidc/customization/sub/get(actions/get-custom-oidc-sub-claim-for-repo)`. @@ -18237,8 +17495,8 @@ public enum Operations { /// Set the customization template for an OIDC subject claim for a repository /// /// Sets the customization template and `opt-in` or `opt-out` flag for an OpenID Connect (OIDC) subject claim for a repository. - /// You must authenticate using an access token with the `repo` scope to use this - /// endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/oidc/customization/sub/put(actions/set-custom-oidc-sub-claim-for-repo)`. @@ -18495,10 +17753,10 @@ public enum Operations { /// Lists all organization secrets shared with a repository without revealing their encrypted /// values. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/organization-secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/organization-secrets/get(actions/list-repo-organization-secrets)`. public enum actions_sol_list_hyphen_repo_hyphen_organization_hyphen_secrets { @@ -18707,12 +17965,12 @@ public enum Operations { } /// List repository organization variables /// - /// Lists all organiation variables shared with a repository. + /// Lists all organization variables shared with a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/organization-variables`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/organization-variables/get(actions/list-repo-organization-variables)`. public enum actions_sol_list_hyphen_repo_hyphen_organization_hyphen_variables { @@ -18923,7 +18181,7 @@ public enum Operations { /// /// Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions and reusable workflows allowed to run in the repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/get(actions/get-github-actions-permissions-repository)`. @@ -19066,7 +18324,7 @@ public enum Operations { /// /// Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions and reusable workflows in the repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/put(actions/set-github-actions-permissions-repository)`. @@ -19179,8 +18437,7 @@ public enum Operations { /// This endpoint only applies to private repositories. /// For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - /// repository `administration` permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions/access`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/access/get(actions/get-workflow-access-to-repository)`. @@ -19325,8 +18582,7 @@ public enum Operations { /// This endpoint only applies to private repositories. /// For more information, see "[Allowing access to components in a private repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository)". /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the - /// repository `administration` permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions/access`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/access/put(actions/set-workflow-access-to-repository)`. @@ -19414,7 +18670,7 @@ public enum Operations { /// /// Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/selected-actions/get(actions/get-allowed-actions-repository)`. @@ -19557,7 +18813,7 @@ public enum Operations { /// /// Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions/selected-actions`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/selected-actions/put(actions/set-allowed-actions-repository)`. @@ -19647,7 +18903,7 @@ public enum Operations { /// as well as if GitHub Actions can submit approving pull request reviews. /// For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/workflow/get(actions/get-github-actions-default-workflow-permissions-repository)`. @@ -19792,7 +19048,7 @@ public enum Operations { /// can submit approving pull request reviews. /// For more information, see "[Setting the permissions of the GITHUB_TOKEN for your repository](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#setting-the-permissions-of-the-github_token-for-your-repository)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the repository `administration` permission to use this API. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/permissions/workflow`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/permissions/workflow/put(actions/set-github-actions-default-workflow-permissions-repository)`. @@ -19907,9 +19163,9 @@ public enum Operations { /// /// Lists all self-hosted runners configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/get(actions/list-self-hosted-runners-for-repo)`. @@ -20128,9 +19384,9 @@ public enum Operations { /// /// Lists binaries for the runner application that you can download and run. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners/downloads`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/downloads/get(actions/list-runner-applications-for-repo)`. @@ -20273,9 +19529,9 @@ public enum Operations { /// /// Generates a configuration that can be passed to the runner application at startup. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// The authenticated user must have admin access to the repository. + /// + /// OAuth tokens and personal access tokens (classic) need the`repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/generate-jitconfig`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/generate-jitconfig/post(actions/generate-runner-jitconfig-for-repo)`. @@ -20486,19 +19742,17 @@ public enum Operations { } /// Create a registration token for a repository /// - /// Returns a token that you can pass to the `config` script. The token - /// expires after one hour. + /// Returns a token that you can pass to the `config` script. The token expires after one hour. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to configure your self-hosted runner: /// - /// Example using registration token: + /// ``` + /// ./config.sh --url https://github.com/octo-org --token TOKEN + /// ``` /// - /// Configure your self-hosted runner, replacing `TOKEN` with the registration token provided - /// by this endpoint. + /// Authenticated users must have admin access to the repository to use this endpoint. /// - /// ```config.sh --url https://github.com/octo-org/octo-repo-artifacts --token TOKEN``` + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/registration-token`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/registration-token/post(actions/create-registration-token-for-repo)`. @@ -20639,19 +19893,17 @@ public enum Operations { } /// Create a remove token for a repository /// - /// Returns a token that you can pass to remove a self-hosted runner from - /// a repository. The token expires after one hour. + /// Returns a token that you can pass to the `config` script to remove a self-hosted runner from an repository. The token expires after one hour. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// For example, you can replace `TOKEN` in the following example with the registration token provided by this endpoint to remove your self-hosted runner from an organization: /// - /// Example using remove token: + /// ``` + /// ./config.sh remove --token TOKEN + /// ``` /// - /// To remove your self-hosted runner from a repository, replace TOKEN with - /// the remove token provided by this endpoint. + /// Authenticated users must have admin access to the repository to use this endpoint. /// - /// ```config.sh remove --token TOKEN``` + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/remove-token`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/remove-token/post(actions/create-remove-token-for-repo)`. @@ -20794,9 +20046,9 @@ public enum Operations { /// /// Gets a specific self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/get(actions/get-self-hosted-runner-for-repo)`. @@ -20946,9 +20198,9 @@ public enum Operations { /// /// Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/delete(actions/delete-self-hosted-runner-from-repo)`. @@ -21032,9 +20284,9 @@ public enum Operations { /// /// Lists all labels for a self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/get(actions/list-labels-for-self-hosted-runner-for-repo)`. @@ -21177,11 +20429,11 @@ public enum Operations { } /// Add custom labels to a self-hosted runner for a repository /// - /// Add custom labels to a self-hosted runner configured in a repository. + /// Adds custom labels to a self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the organization to use this endpoint. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/post(actions/add-custom-labels-to-self-hosted-runner-for-repo)`. @@ -21376,9 +20628,9 @@ public enum Operations { /// Remove all previous custom labels and set the new custom labels for a specific /// self-hosted runner configured in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/put(actions/set-custom-labels-for-self-hosted-runner-for-repo)`. @@ -21573,9 +20825,9 @@ public enum Operations { /// Remove all custom labels from a self-hosted runner configured in a /// repository. Returns the remaining read-only labels from the runner. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/delete(actions/remove-all-custom-labels-from-self-hosted-runner-for-repo)`. @@ -21724,9 +20976,9 @@ public enum Operations { /// This endpoint returns a `404 Not Found` status if the custom label is not /// present on the runner. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `administration` permission for repositories and the `organization_self_hosted_runners` permission for organizations. - /// Authenticated users must have admin access to repositories or organizations, or the `manage_runners:enterprise` scope for enterprises, to use these endpoints. + /// Authenticated users must have admin access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runners/{runner_id}/labels/{name}/delete(actions/remove-custom-label-from-self-hosted-runner-for-repo)`. @@ -21901,7 +21153,9 @@ public enum Operations { /// /// Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/get(actions/list-workflow-runs-for-repo)`. @@ -22184,7 +21438,11 @@ public enum Operations { } /// Get a workflow run /// - /// Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/get(actions/get-workflow-run)`. @@ -22350,9 +21608,11 @@ public enum Operations { } /// Delete a workflow run /// - /// Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is - /// private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use - /// this endpoint. + /// Deletes a specific workflow run. + /// + /// Anyone with write access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runs/{run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/delete(actions/delete-workflow-run)`. @@ -22434,7 +21694,9 @@ public enum Operations { } /// Get the review history for a workflow run /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/approvals/get(actions/get-reviews-for-run)`. @@ -22584,7 +21846,7 @@ public enum Operations { /// /// Approves a workflow run for a pull request from a public fork of a first time contributor. For more information, see ["Approving workflow runs from public forks](https://docs.github.com/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/approve`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/approve/post(actions/approve-workflow-run)`. @@ -22778,7 +22040,11 @@ public enum Operations { } /// List workflow run artifacts /// - /// Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Lists artifacts for a workflow run. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/artifacts/get(actions/list-workflow-run-artifacts)`. @@ -23002,10 +22268,11 @@ public enum Operations { } /// Get a workflow run attempt /// - /// Gets a specific workflow run attempt. Anyone with read access to the repository - /// can use this endpoint. If the repository is private you must use an access token - /// with the `repo` scope. GitHub Apps must have the `actions:read` permission to - /// use this endpoint. + /// Gets a specific workflow run attempt. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/get(actions/get-workflow-run-attempt)`. @@ -23178,7 +22445,12 @@ public enum Operations { } /// List jobs for a workflow run attempt /// - /// Lists jobs for a specific workflow run attempt. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// Lists jobs for a specific workflow run attempt. You can use parameters to narrow the list of results. For more information + /// about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/jobs/get(actions/list-jobs-for-workflow-run-attempt)`. @@ -23426,9 +22698,11 @@ public enum Operations { /// Download workflow run attempt logs /// /// Gets a redirect URL to download an archive of log files for a specific workflow run attempt. This link expires after - /// 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to - /// the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. - /// GitHub Apps must have the `actions:read` permission to use this endpoint. + /// 1 minute. Look for `Location:` in the response header to find the URL for the download. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/attempts/{attempt_number}/logs/get(actions/download-workflow-run-attempt-logs)`. @@ -23538,8 +22812,7 @@ public enum Operations { /// /// Cancels a workflow run using its `id`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/cancel/post(actions/cancel-workflow-run)`. @@ -23715,8 +22988,7 @@ public enum Operations { /// **Note:** GitHub Apps can only review their own custom deployment protection rules. /// To approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run). /// - /// If the repository is private, you must use an access token with the `repo` scope. - /// GitHub Apps must have read and write permission for **Deployments** to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule/post(actions/review-custom-gates-for-run)`. @@ -23857,8 +23129,7 @@ public enum Operations { /// Cancels a workflow run and bypasses conditions that would otherwise cause a workflow execution to continue, such as an `always()` condition on a job. /// You should only use this endpoint to cancel a workflow run when the workflow run is not responding to [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel`](/rest/actions/workflow-runs#cancel-a-workflow-run). /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/force-cancel/post(actions/force-cancel-workflow-run)`. @@ -24029,7 +23300,12 @@ public enum Operations { } /// List jobs for a workflow run /// - /// Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// Lists jobs for a workflow run. You can use parameters to narrow the list of results. For more information + /// about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/jobs/get(actions/list-jobs-for-workflow-run)`. @@ -24259,9 +23535,11 @@ public enum Operations { /// Download workflow run logs /// /// Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for - /// `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use - /// this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have - /// the `actions:read` permission to use this endpoint. + /// `Location:` in the response header to find the URL for the download. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/logs/get(actions/download-workflow-run-logs)`. @@ -24362,7 +23640,9 @@ public enum Operations { } /// Delete workflow run logs /// - /// Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// Deletes all logs for a workflow run. + /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/logs/delete(actions/delete-workflow-run-logs)`. @@ -24534,7 +23814,9 @@ public enum Operations { /// /// Get all deployment environments for a workflow run that are waiting for protection rules to pass. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments/get(actions/get-pending-deployments-for-run)`. @@ -24684,7 +23966,9 @@ public enum Operations { /// /// Approve or reject pending deployments that are waiting on approval by a required reviewer. /// - /// Required reviewers with read access to the repository contents and deployments can use this endpoint. Required reviewers must authenticate using an access token with the `repo` scope to use this endpoint. + /// Required reviewers with read access to the repository contents and deployments can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments/post(actions/review-pending-deployments-for-run)`. @@ -24883,7 +24167,9 @@ public enum Operations { } /// Re-run a workflow /// - /// Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// Re-runs your workflow run using its `id`. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/rerun/post(actions/re-run-workflow)`. @@ -25057,7 +24343,9 @@ public enum Operations { } /// Re-run failed jobs from a workflow run /// - /// Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. + /// Re-run all of the failed jobs and their dependent jobs in a workflow run using the `id` of the workflow run. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/rerun-failed-jobs/post(actions/re-run-workflow-failed-jobs)`. @@ -25233,7 +24521,9 @@ public enum Operations { /// /// Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/runs/{run_id}/timing/get(actions/get-workflow-run-usage)`. @@ -25384,10 +24674,10 @@ public enum Operations { /// Lists all secrets available in a repository without revealing their encrypted /// values. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/get(actions/list-repo-secrets)`. public enum actions_sol_list_hyphen_repo_hyphen_secrets { @@ -25600,9 +24890,8 @@ public enum Operations { /// encrypt a secret before you can create or update secrets. /// /// Anyone with read access to the repository can use this endpoint. - /// If the repository is private you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/secrets/public-key`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/public-key/get(actions/get-repo-public-key)`. @@ -25745,9 +25034,9 @@ public enum Operations { /// /// Gets a single repository secret without revealing its encrypted value. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// The authenticated user must have collaborator access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/{secret_name}/get(actions/get-repo-secret)`. @@ -25898,10 +25187,10 @@ public enum Operations { /// Creates or updates a repository secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/{secret_name}/put(actions/create-or-update-repo-secret)`. public enum actions_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret { @@ -26113,10 +25402,10 @@ public enum Operations { /// /// Deletes a secret in a repository using the secret name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/secrets/{secret_name}/delete(actions/delete-repo-secret)`. public enum actions_sol_delete_hyphen_repo_hyphen_secret { @@ -26198,10 +25487,11 @@ public enum Operations { /// List repository variables /// /// Lists all repository variables. - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. + /// /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/variables`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/get(actions/list-repo-variables)`. public enum actions_sol_list_hyphen_repo_hyphen_variables { @@ -26412,10 +25702,10 @@ public enum Operations { /// /// Creates a repository variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/variables`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/post(actions/create-repo-variable)`. public enum actions_sol_create_hyphen_repo_hyphen_variable { @@ -26593,9 +25883,9 @@ public enum Operations { /// /// Gets a specific variable in a repository. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:read` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read variables. + /// The authenticated user must have collaborator access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/{name}/get(actions/get-repo-variable)`. @@ -26745,10 +26035,10 @@ public enum Operations { /// /// Updates a repository variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/{name}/patch(actions/update-repo-variable)`. public enum actions_sol_update_hyphen_repo_hyphen_variable { @@ -26869,10 +26159,10 @@ public enum Operations { /// /// Deletes a repository variable using the variable name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `actions_variables:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/actions/variables/{name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/variables/{name}/delete(actions/delete-repo-variable)`. public enum actions_sol_delete_hyphen_repo_hyphen_variable { @@ -26953,7 +26243,11 @@ public enum Operations { } /// List repository workflows /// - /// Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Lists the workflows in a repository. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/get(actions/list-repo-workflows)`. @@ -27163,7 +26457,12 @@ public enum Operations { } /// Get a workflow /// - /// Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Gets a specific workflow. You can replace `workflow_id` with the workflow + /// file name. For example, you could use `main.yaml`. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/get(actions/get-workflow)`. @@ -27348,7 +26647,7 @@ public enum Operations { /// /// Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable/put(actions/disable-workflow)`. @@ -27469,7 +26768,7 @@ public enum Operations { /// /// You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)." + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches/post(actions/create-workflow-dispatch)`. @@ -27646,7 +26945,7 @@ public enum Operations { /// /// Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable/put(actions/enable-workflow)`. @@ -27765,7 +27064,9 @@ public enum Operations { /// /// List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters). /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. + /// Anyone with read access to the repository can use this endpoint + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs/get(actions/list-workflow-runs)`. @@ -28092,7 +27393,11 @@ public enum Operations { /// /// Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub-hosted runners. Usage is listed for each GitHub-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing/get(actions/get-workflow-usage)`. @@ -28278,10 +27583,10 @@ public enum Operations { /// Lists all secrets available in an environment without revealing their /// encrypted values. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/secrets`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/get(actions/list-environment-secrets)`. public enum actions_sol_list_hyphen_environment_hyphen_secrets { @@ -28494,9 +27799,8 @@ public enum Operations { /// secrets. You need to encrypt a secret before you can create or update secrets. /// /// Anyone with read access to the repository can use this endpoint. - /// If the repository is private you must use an access token with the `repo` scope. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. - /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. + /// + /// If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/public-key/get(actions/get-environment-public-key)`. @@ -28639,10 +27943,10 @@ public enum Operations { /// /// Gets a single environment secret without revealing its encrypted value. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}/get(actions/get-environment-secret)`. public enum actions_sol_get_hyphen_environment_hyphen_secret { @@ -28792,10 +28096,10 @@ public enum Operations { /// Creates or updates an environment secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}/put(actions/create-or-update-environment-secret)`. public enum actions_sol_create_hyphen_or_hyphen_update_hyphen_environment_hyphen_secret { @@ -29007,10 +28311,10 @@ public enum Operations { /// /// Deletes a secret in an environment using the secret name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `secrets` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read secrets. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}/delete(actions/delete-environment-secret)`. public enum actions_sol_delete_hyphen_environment_hyphen_secret { @@ -29093,10 +28397,10 @@ public enum Operations { /// /// Lists all environment variables. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environments:read` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/variables`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/get(actions/list-environment-variables)`. public enum actions_sol_list_hyphen_environment_hyphen_variables { @@ -29307,10 +28611,10 @@ public enum Operations { /// /// Create an environment variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environment:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repositories/{repository_id}/environments/{environment_name}/variables`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/post(actions/create-environment-variable)`. public enum actions_sol_create_hyphen_environment_hyphen_variable { @@ -29488,10 +28792,10 @@ public enum Operations { /// /// Gets a specific variable in an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environments:read` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /repositories/{repository_id}/environments/{environment_name}/variables/{name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/{name}/get(actions/get-environment-variable)`. public enum actions_sol_get_hyphen_environment_hyphen_variable { @@ -29640,10 +28944,10 @@ public enum Operations { /// /// Updates an environment variable that you can reference in a GitHub Actions workflow. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environment:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /repositories/{repository_id}/environments/{environment_name}/variables/{name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/{name}/patch(actions/update-environment-variable)`. public enum actions_sol_update_hyphen_environment_hyphen_variable { @@ -29764,10 +29068,10 @@ public enum Operations { /// /// Deletes an environment variable using the variable name. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. - /// GitHub Apps must have the `environment:write` repository permission to use this endpoint. /// Authenticated users must have collaborator access to a repository to create, update, or read variables. /// + /// OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repositories/{repository_id}/environments/{environment_name}/variables/{name}`. /// - Remark: Generated from `#/paths//repositories/{repository_id}/environments/{environment_name}/variables/{name}/delete(actions/delete-environment-variable)`. public enum actions_sol_delete_hyphen_environment_hyphen_variable { From 00142b26ba899b00eb4ddc2dd581a7dcdffd7b79 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:10:47 +0000 Subject: [PATCH 03/20] Commit via running ake Sources/apps --- Sources/apps/Client.swift | 32 +- Sources/apps/Types.swift | 879 ++------------------------------------ 2 files changed, 52 insertions(+), 859 deletions(-) diff --git a/Sources/apps/Client.swift b/Sources/apps/Client.swift index 1a3ad0293c..a4e98b9213 100644 --- a/Sources/apps/Client.swift +++ b/Sources/apps/Client.swift @@ -825,10 +825,10 @@ public struct Client: APIProtocol { } /// List installations for the authenticated app /// - /// You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - /// /// The permissions the installation has are included under the `permissions` key. /// + /// You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + /// /// - Remark: HTTP `GET /app/installations`. /// - Remark: Generated from `#/paths//app/installations/get(apps/list-installations)`. public func apps_sol_list_hyphen_installations(_ input: Operations.apps_sol_list_hyphen_installations.Input) async throws -> Operations.apps_sol_list_hyphen_installations.Output { @@ -1745,7 +1745,15 @@ public struct Client: APIProtocol { } /// Create a scoped access token /// - /// Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. + /// Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify + /// which repositories the token can access and which permissions are granted to the + /// token. + /// + /// Invalid tokens will return `404 NOT FOUND`. + /// + /// You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) + /// when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + /// as the username and password. /// /// - Remark: HTTP `POST /applications/{client_id}/token/scoped`. /// - Remark: Generated from `#/paths//applications/{client_id}/token/scoped/post(apps/scope-token)`. @@ -1908,8 +1916,6 @@ public struct Client: APIProtocol { /// /// **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). /// - /// If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) of the target app to access this endpoint. - /// /// - Remark: HTTP `GET /apps/{app_slug}`. /// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`. public func apps_sol_get_hyphen_by_hyphen_slug(_ input: Operations.apps_sol_get_hyphen_by_hyphen_slug.Input) async throws -> Operations.apps_sol_get_hyphen_by_hyphen_slug.Output { @@ -2018,8 +2024,6 @@ public struct Client: APIProtocol { /// /// List repositories that an app installation can access. /// - /// You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - /// /// - Remark: HTTP `GET /installation/repositories`. /// - Remark: Generated from `#/paths//installation/repositories/get(apps/list-repos-accessible-to-installation)`. public func apps_sol_list_hyphen_repos_hyphen_accessible_hyphen_to_hyphen_installation(_ input: Operations.apps_sol_list_hyphen_repos_hyphen_accessible_hyphen_to_hyphen_installation.Input) async throws -> Operations.apps_sol_list_hyphen_repos_hyphen_accessible_hyphen_to_hyphen_installation.Output { @@ -2152,8 +2156,6 @@ public struct Client: APIProtocol { /// /// Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. /// - /// You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - /// /// - Remark: HTTP `DELETE /installation/token`. /// - Remark: Generated from `#/paths//installation/token/delete(apps/revoke-installation-access-token)`. public func apps_sol_revoke_hyphen_installation_hyphen_access_hyphen_token(_ input: Operations.apps_sol_revoke_hyphen_installation_hyphen_access_hyphen_token.Input) async throws -> Operations.apps_sol_revoke_hyphen_installation_hyphen_access_hyphen_token.Output { @@ -3099,8 +3101,6 @@ public struct Client: APIProtocol { /// /// Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. /// - /// You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - /// /// The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. /// /// You can find the permissions for the installation under the `permissions` key. @@ -3237,8 +3237,6 @@ public struct Client: APIProtocol { /// /// The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. /// - /// You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - /// /// The access the user has to each repository is included in the hash under the `permissions` key. /// /// - Remark: HTTP `GET /user/installations/{installation_id}/repositories`. @@ -3373,8 +3371,6 @@ public struct Client: APIProtocol { /// /// Add a single repository to an installation. The authenticated user must have admin access to the repository. /// - /// You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - /// /// - Remark: HTTP `PUT /user/installations/{installation_id}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/installations/{installation_id}/repositories/{repository_id}/put(apps/add-repo-to-installation-for-authenticated-user)`. public func apps_sol_add_hyphen_repo_hyphen_to_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.apps_sol_add_hyphen_repo_hyphen_to_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.apps_sol_add_hyphen_repo_hyphen_to_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user.Output { @@ -3466,8 +3462,6 @@ public struct Client: APIProtocol { /// /// Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. /// - /// You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - /// /// - Remark: HTTP `DELETE /user/installations/{installation_id}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/installations/{installation_id}/repositories/{repository_id}/delete(apps/remove-repo-from-installation-for-authenticated-user)`. public func apps_sol_remove_hyphen_repo_hyphen_from_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.apps_sol_remove_hyphen_repo_hyphen_from_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.apps_sol_remove_hyphen_repo_hyphen_from_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user.Output { @@ -3559,7 +3553,7 @@ public struct Client: APIProtocol { } /// List subscriptions for the authenticated user /// - /// Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + /// Lists the active subscriptions for the authenticated user. /// /// - Remark: HTTP `GET /user/marketplace_purchases`. /// - Remark: Generated from `#/paths//user/marketplace_purchases/get(apps/list-subscriptions-for-authenticated-user)`. @@ -3689,7 +3683,7 @@ public struct Client: APIProtocol { } /// List subscriptions for the authenticated user (stubbed) /// - /// Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + /// Lists the active subscriptions for the authenticated user. /// /// - Remark: HTTP `GET /user/marketplace_purchases/stubbed`. /// - Remark: Generated from `#/paths//user/marketplace_purchases/stubbed/get(apps/list-subscriptions-for-authenticated-user-stubbed)`. diff --git a/Sources/apps/Types.swift b/Sources/apps/Types.swift index 4d827893d0..6fee36006c 100644 --- a/Sources/apps/Types.swift +++ b/Sources/apps/Types.swift @@ -81,10 +81,10 @@ public protocol APIProtocol: Sendable { func apps_sol_list_hyphen_installation_hyphen_requests_hyphen_for_hyphen_authenticated_hyphen_app(_ input: Operations.apps_sol_list_hyphen_installation_hyphen_requests_hyphen_for_hyphen_authenticated_hyphen_app.Input) async throws -> Operations.apps_sol_list_hyphen_installation_hyphen_requests_hyphen_for_hyphen_authenticated_hyphen_app.Output /// List installations for the authenticated app /// - /// You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - /// /// The permissions the installation has are included under the `permissions` key. /// + /// You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + /// /// - Remark: HTTP `GET /app/installations`. /// - Remark: Generated from `#/paths//app/installations/get(apps/list-installations)`. func apps_sol_list_hyphen_installations(_ input: Operations.apps_sol_list_hyphen_installations.Input) async throws -> Operations.apps_sol_list_hyphen_installations.Output @@ -164,7 +164,15 @@ public protocol APIProtocol: Sendable { func apps_sol_delete_hyphen_token(_ input: Operations.apps_sol_delete_hyphen_token.Input) async throws -> Operations.apps_sol_delete_hyphen_token.Output /// Create a scoped access token /// - /// Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. + /// Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify + /// which repositories the token can access and which permissions are granted to the + /// token. + /// + /// Invalid tokens will return `404 NOT FOUND`. + /// + /// You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) + /// when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + /// as the username and password. /// /// - Remark: HTTP `POST /applications/{client_id}/token/scoped`. /// - Remark: Generated from `#/paths//applications/{client_id}/token/scoped/post(apps/scope-token)`. @@ -173,8 +181,6 @@ public protocol APIProtocol: Sendable { /// /// **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). /// - /// If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) of the target app to access this endpoint. - /// /// - Remark: HTTP `GET /apps/{app_slug}`. /// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`. func apps_sol_get_hyphen_by_hyphen_slug(_ input: Operations.apps_sol_get_hyphen_by_hyphen_slug.Input) async throws -> Operations.apps_sol_get_hyphen_by_hyphen_slug.Output @@ -182,8 +188,6 @@ public protocol APIProtocol: Sendable { /// /// List repositories that an app installation can access. /// - /// You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - /// /// - Remark: HTTP `GET /installation/repositories`. /// - Remark: Generated from `#/paths//installation/repositories/get(apps/list-repos-accessible-to-installation)`. func apps_sol_list_hyphen_repos_hyphen_accessible_hyphen_to_hyphen_installation(_ input: Operations.apps_sol_list_hyphen_repos_hyphen_accessible_hyphen_to_hyphen_installation.Input) async throws -> Operations.apps_sol_list_hyphen_repos_hyphen_accessible_hyphen_to_hyphen_installation.Output @@ -193,8 +197,6 @@ public protocol APIProtocol: Sendable { /// /// Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. /// - /// You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - /// /// - Remark: HTTP `DELETE /installation/token`. /// - Remark: Generated from `#/paths//installation/token/delete(apps/revoke-installation-access-token)`. func apps_sol_revoke_hyphen_installation_hyphen_access_hyphen_token(_ input: Operations.apps_sol_revoke_hyphen_installation_hyphen_access_hyphen_token.Input) async throws -> Operations.apps_sol_revoke_hyphen_installation_hyphen_access_hyphen_token.Output @@ -274,8 +276,6 @@ public protocol APIProtocol: Sendable { /// /// Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. /// - /// You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - /// /// The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. /// /// You can find the permissions for the installation under the `permissions` key. @@ -289,8 +289,6 @@ public protocol APIProtocol: Sendable { /// /// The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. /// - /// You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - /// /// The access the user has to each repository is included in the hash under the `permissions` key. /// /// - Remark: HTTP `GET /user/installations/{installation_id}/repositories`. @@ -300,8 +298,6 @@ public protocol APIProtocol: Sendable { /// /// Add a single repository to an installation. The authenticated user must have admin access to the repository. /// - /// You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - /// /// - Remark: HTTP `PUT /user/installations/{installation_id}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/installations/{installation_id}/repositories/{repository_id}/put(apps/add-repo-to-installation-for-authenticated-user)`. func apps_sol_add_hyphen_repo_hyphen_to_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.apps_sol_add_hyphen_repo_hyphen_to_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.apps_sol_add_hyphen_repo_hyphen_to_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user.Output @@ -309,21 +305,19 @@ public protocol APIProtocol: Sendable { /// /// Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. /// - /// You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - /// /// - Remark: HTTP `DELETE /user/installations/{installation_id}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/installations/{installation_id}/repositories/{repository_id}/delete(apps/remove-repo-from-installation-for-authenticated-user)`. func apps_sol_remove_hyphen_repo_hyphen_from_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.apps_sol_remove_hyphen_repo_hyphen_from_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.apps_sol_remove_hyphen_repo_hyphen_from_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user.Output /// List subscriptions for the authenticated user /// - /// Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + /// Lists the active subscriptions for the authenticated user. /// /// - Remark: HTTP `GET /user/marketplace_purchases`. /// - Remark: Generated from `#/paths//user/marketplace_purchases/get(apps/list-subscriptions-for-authenticated-user)`. func apps_sol_list_hyphen_subscriptions_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.apps_sol_list_hyphen_subscriptions_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.apps_sol_list_hyphen_subscriptions_hyphen_for_hyphen_authenticated_hyphen_user.Output /// List subscriptions for the authenticated user (stubbed) /// - /// Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + /// Lists the active subscriptions for the authenticated user. /// /// - Remark: HTTP `GET /user/marketplace_purchases/stubbed`. /// - Remark: Generated from `#/paths//user/marketplace_purchases/stubbed/get(apps/list-subscriptions-for-authenticated-user-stubbed)`. @@ -463,10 +457,10 @@ extension APIProtocol { } /// List installations for the authenticated app /// - /// You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - /// /// The permissions the installation has are included under the `permissions` key. /// + /// You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + /// /// - Remark: HTTP `GET /app/installations`. /// - Remark: Generated from `#/paths//app/installations/get(apps/list-installations)`. public func apps_sol_list_hyphen_installations( @@ -636,7 +630,15 @@ extension APIProtocol { } /// Create a scoped access token /// - /// Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. + /// Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify + /// which repositories the token can access and which permissions are granted to the + /// token. + /// + /// Invalid tokens will return `404 NOT FOUND`. + /// + /// You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) + /// when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + /// as the username and password. /// /// - Remark: HTTP `POST /applications/{client_id}/token/scoped`. /// - Remark: Generated from `#/paths//applications/{client_id}/token/scoped/post(apps/scope-token)`. @@ -655,8 +657,6 @@ extension APIProtocol { /// /// **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). /// - /// If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) of the target app to access this endpoint. - /// /// - Remark: HTTP `GET /apps/{app_slug}`. /// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`. public func apps_sol_get_hyphen_by_hyphen_slug( @@ -672,8 +672,6 @@ extension APIProtocol { /// /// List repositories that an app installation can access. /// - /// You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - /// /// - Remark: HTTP `GET /installation/repositories`. /// - Remark: Generated from `#/paths//installation/repositories/get(apps/list-repos-accessible-to-installation)`. public func apps_sol_list_hyphen_repos_hyphen_accessible_hyphen_to_hyphen_installation( @@ -691,8 +689,6 @@ extension APIProtocol { /// /// Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. /// - /// You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - /// /// - Remark: HTTP `DELETE /installation/token`. /// - Remark: Generated from `#/paths//installation/token/delete(apps/revoke-installation-access-token)`. public func apps_sol_revoke_hyphen_installation_hyphen_access_hyphen_token() async throws -> Operations.apps_sol_revoke_hyphen_installation_hyphen_access_hyphen_token.Output { @@ -842,8 +838,6 @@ extension APIProtocol { /// /// Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. /// - /// You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - /// /// The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. /// /// You can find the permissions for the installation under the `permissions` key. @@ -865,8 +859,6 @@ extension APIProtocol { /// /// The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. /// - /// You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - /// /// The access the user has to each repository is included in the hash under the `permissions` key. /// /// - Remark: HTTP `GET /user/installations/{installation_id}/repositories`. @@ -886,8 +878,6 @@ extension APIProtocol { /// /// Add a single repository to an installation. The authenticated user must have admin access to the repository. /// - /// You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - /// /// - Remark: HTTP `PUT /user/installations/{installation_id}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/installations/{installation_id}/repositories/{repository_id}/put(apps/add-repo-to-installation-for-authenticated-user)`. public func apps_sol_add_hyphen_repo_hyphen_to_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user( @@ -903,8 +893,6 @@ extension APIProtocol { /// /// Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. /// - /// You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - /// /// - Remark: HTTP `DELETE /user/installations/{installation_id}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/installations/{installation_id}/repositories/{repository_id}/delete(apps/remove-repo-from-installation-for-authenticated-user)`. public func apps_sol_remove_hyphen_repo_hyphen_from_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user( @@ -918,7 +906,7 @@ extension APIProtocol { } /// List subscriptions for the authenticated user /// - /// Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + /// Lists the active subscriptions for the authenticated user. /// /// - Remark: HTTP `GET /user/marketplace_purchases`. /// - Remark: Generated from `#/paths//user/marketplace_purchases/get(apps/list-subscriptions-for-authenticated-user)`. @@ -933,7 +921,7 @@ extension APIProtocol { } /// List subscriptions for the authenticated user (stubbed) /// - /// Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + /// Lists the active subscriptions for the authenticated user. /// /// - Remark: HTTP `GET /user/marketplace_purchases/stubbed`. /// - Remark: Generated from `#/paths//user/marketplace_purchases/stubbed/get(apps/list-subscriptions-for-authenticated-user-stubbed)`. @@ -3312,8 +3300,6 @@ public enum Components { public var full_name: Swift.String /// - Remark: Generated from `#/components/schemas/repository/license`. public var license: Components.Schemas.nullable_hyphen_license_hyphen_simple? - /// - Remark: Generated from `#/components/schemas/repository/organization`. - public var organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? /// - Remark: Generated from `#/components/schemas/repository/forks`. public var forks: Swift.Int /// - Remark: Generated from `#/components/schemas/repository/permissions`. @@ -3526,767 +3512,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/repository/allow_rebase_merge`. public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository`. - public struct template_repositoryPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/name`. - public var name: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/full_name`. - public var full_name: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner`. - public struct ownerPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/login`. - public var login: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/avatar_url`. - public var avatar_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/gravatar_id`. - public var gravatar_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/followers_url`. - public var followers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/following_url`. - public var following_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/gists_url`. - public var gists_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/starred_url`. - public var starred_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/subscriptions_url`. - public var subscriptions_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/organizations_url`. - public var organizations_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/repos_url`. - public var repos_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/received_events_url`. - public var received_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/type`. - public var _type: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/site_admin`. - public var site_admin: Swift.Bool? - /// Creates a new `ownerPayload`. - /// - /// - Parameters: - /// - login: - /// - id: - /// - node_id: - /// - avatar_url: - /// - gravatar_id: - /// - url: - /// - html_url: - /// - followers_url: - /// - following_url: - /// - gists_url: - /// - starred_url: - /// - subscriptions_url: - /// - organizations_url: - /// - repos_url: - /// - events_url: - /// - received_events_url: - /// - _type: - /// - site_admin: - public init( - login: Swift.String? = nil, - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - avatar_url: Swift.String? = nil, - gravatar_id: Swift.String? = nil, - url: Swift.String? = nil, - html_url: Swift.String? = nil, - followers_url: Swift.String? = nil, - following_url: Swift.String? = nil, - gists_url: Swift.String? = nil, - starred_url: Swift.String? = nil, - subscriptions_url: Swift.String? = nil, - organizations_url: Swift.String? = nil, - repos_url: Swift.String? = nil, - events_url: Swift.String? = nil, - received_events_url: Swift.String? = nil, - _type: Swift.String? = nil, - site_admin: Swift.Bool? = nil - ) { - self.login = login - self.id = id - self.node_id = node_id - self.avatar_url = avatar_url - self.gravatar_id = gravatar_id - self.url = url - self.html_url = html_url - self.followers_url = followers_url - self.following_url = following_url - self.gists_url = gists_url - self.starred_url = starred_url - self.subscriptions_url = subscriptions_url - self.organizations_url = organizations_url - self.repos_url = repos_url - self.events_url = events_url - self.received_events_url = received_events_url - self._type = _type - self.site_admin = site_admin - } - public enum CodingKeys: String, CodingKey { - case login - case id - case node_id - case avatar_url - case gravatar_id - case url - case html_url - case followers_url - case following_url - case gists_url - case starred_url - case subscriptions_url - case organizations_url - case repos_url - case events_url - case received_events_url - case _type = "type" - case site_admin - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner`. - public var owner: Components.Schemas.repository.template_repositoryPayload.ownerPayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/private`. - public var _private: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/description`. - public var description: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/fork`. - public var fork: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/archive_url`. - public var archive_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/assignees_url`. - public var assignees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/blobs_url`. - public var blobs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/branches_url`. - public var branches_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/collaborators_url`. - public var collaborators_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/comments_url`. - public var comments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/commits_url`. - public var commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/compare_url`. - public var compare_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/contents_url`. - public var contents_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/contributors_url`. - public var contributors_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/deployments_url`. - public var deployments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/downloads_url`. - public var downloads_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/forks_url`. - public var forks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_commits_url`. - public var git_commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_refs_url`. - public var git_refs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_tags_url`. - public var git_tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_url`. - public var git_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issue_comment_url`. - public var issue_comment_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issue_events_url`. - public var issue_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issues_url`. - public var issues_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/keys_url`. - public var keys_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/labels_url`. - public var labels_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/languages_url`. - public var languages_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merges_url`. - public var merges_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/milestones_url`. - public var milestones_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/notifications_url`. - public var notifications_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/pulls_url`. - public var pulls_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/releases_url`. - public var releases_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/ssh_url`. - public var ssh_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/stargazers_url`. - public var stargazers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/statuses_url`. - public var statuses_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscribers_url`. - public var subscribers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscription_url`. - public var subscription_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/tags_url`. - public var tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/teams_url`. - public var teams_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/trees_url`. - public var trees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/clone_url`. - public var clone_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/mirror_url`. - public var mirror_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/hooks_url`. - public var hooks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/svn_url`. - public var svn_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/homepage`. - public var homepage: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/language`. - public var language: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/forks_count`. - public var forks_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/stargazers_count`. - public var stargazers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/watchers_count`. - public var watchers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/size`. - public var size: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/default_branch`. - public var default_branch: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/open_issues_count`. - public var open_issues_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/is_template`. - public var is_template: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/topics`. - public var topics: [Swift.String]? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_issues`. - public var has_issues: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_projects`. - public var has_projects: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_wiki`. - public var has_wiki: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_pages`. - public var has_pages: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_downloads`. - public var has_downloads: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/archived`. - public var archived: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/disabled`. - public var disabled: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/visibility`. - public var visibility: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/pushed_at`. - public var pushed_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/created_at`. - public var created_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/updated_at`. - public var updated_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions`. - public struct permissionsPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/admin`. - public var admin: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/maintain`. - public var maintain: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/push`. - public var push: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/triage`. - public var triage: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/pull`. - public var pull: Swift.Bool? - /// Creates a new `permissionsPayload`. - /// - /// - Parameters: - /// - admin: - /// - maintain: - /// - push: - /// - triage: - /// - pull: - public init( - admin: Swift.Bool? = nil, - maintain: Swift.Bool? = nil, - push: Swift.Bool? = nil, - triage: Swift.Bool? = nil, - pull: Swift.Bool? = nil - ) { - self.admin = admin - self.maintain = maintain - self.push = push - self.triage = triage - self.pull = pull - } - public enum CodingKeys: String, CodingKey { - case admin - case maintain - case push - case triage - case pull - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions`. - public var permissions: Components.Schemas.repository.template_repositoryPayload.permissionsPayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_rebase_merge`. - public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/temp_clone_token`. - public var temp_clone_token: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_squash_merge`. - public var allow_squash_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_auto_merge`. - public var allow_auto_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/delete_branch_on_merge`. - public var delete_branch_on_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_update_branch`. - public var allow_update_branch: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/use_squash_pr_title_as_default`. - public var use_squash_pr_title_as_default: Swift.Bool? - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_title`. - @frozen public enum squash_merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case COMMIT_OR_PR_TITLE = "COMMIT_OR_PR_TITLE" - } - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_title`. - public var squash_merge_commit_title: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_titlePayload? - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_message`. - @frozen public enum squash_merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case COMMIT_MESSAGES = "COMMIT_MESSAGES" - case BLANK = "BLANK" - } - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_message`. - public var squash_merge_commit_message: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_messagePayload? - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_title`. - @frozen public enum merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case MERGE_MESSAGE = "MERGE_MESSAGE" - } - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_title`. - public var merge_commit_title: Components.Schemas.repository.template_repositoryPayload.merge_commit_titlePayload? - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_message`. - @frozen public enum merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case PR_TITLE = "PR_TITLE" - case BLANK = "BLANK" - } - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_message`. - public var merge_commit_message: Components.Schemas.repository.template_repositoryPayload.merge_commit_messagePayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_merge_commit`. - public var allow_merge_commit: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/network_count`. - public var network_count: Swift.Int? - /// Creates a new `template_repositoryPayload`. - /// - /// - Parameters: - /// - id: - /// - node_id: - /// - name: - /// - full_name: - /// - owner: - /// - _private: - /// - html_url: - /// - description: - /// - fork: - /// - url: - /// - archive_url: - /// - assignees_url: - /// - blobs_url: - /// - branches_url: - /// - collaborators_url: - /// - comments_url: - /// - commits_url: - /// - compare_url: - /// - contents_url: - /// - contributors_url: - /// - deployments_url: - /// - downloads_url: - /// - events_url: - /// - forks_url: - /// - git_commits_url: - /// - git_refs_url: - /// - git_tags_url: - /// - git_url: - /// - issue_comment_url: - /// - issue_events_url: - /// - issues_url: - /// - keys_url: - /// - labels_url: - /// - languages_url: - /// - merges_url: - /// - milestones_url: - /// - notifications_url: - /// - pulls_url: - /// - releases_url: - /// - ssh_url: - /// - stargazers_url: - /// - statuses_url: - /// - subscribers_url: - /// - subscription_url: - /// - tags_url: - /// - teams_url: - /// - trees_url: - /// - clone_url: - /// - mirror_url: - /// - hooks_url: - /// - svn_url: - /// - homepage: - /// - language: - /// - forks_count: - /// - stargazers_count: - /// - watchers_count: - /// - size: - /// - default_branch: - /// - open_issues_count: - /// - is_template: - /// - topics: - /// - has_issues: - /// - has_projects: - /// - has_wiki: - /// - has_pages: - /// - has_downloads: - /// - archived: - /// - disabled: - /// - visibility: - /// - pushed_at: - /// - created_at: - /// - updated_at: - /// - permissions: - /// - allow_rebase_merge: - /// - temp_clone_token: - /// - allow_squash_merge: - /// - allow_auto_merge: - /// - delete_branch_on_merge: - /// - allow_update_branch: - /// - use_squash_pr_title_as_default: - /// - squash_merge_commit_title: The default value for a squash merge commit title: - /// - squash_merge_commit_message: The default value for a squash merge commit message: - /// - merge_commit_title: The default value for a merge commit title. - /// - merge_commit_message: The default value for a merge commit message. - /// - allow_merge_commit: - /// - subscribers_count: - /// - network_count: - public init( - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - name: Swift.String? = nil, - full_name: Swift.String? = nil, - owner: Components.Schemas.repository.template_repositoryPayload.ownerPayload? = nil, - _private: Swift.Bool? = nil, - html_url: Swift.String? = nil, - description: Swift.String? = nil, - fork: Swift.Bool? = nil, - url: Swift.String? = nil, - archive_url: Swift.String? = nil, - assignees_url: Swift.String? = nil, - blobs_url: Swift.String? = nil, - branches_url: Swift.String? = nil, - collaborators_url: Swift.String? = nil, - comments_url: Swift.String? = nil, - commits_url: Swift.String? = nil, - compare_url: Swift.String? = nil, - contents_url: Swift.String? = nil, - contributors_url: Swift.String? = nil, - deployments_url: Swift.String? = nil, - downloads_url: Swift.String? = nil, - events_url: Swift.String? = nil, - forks_url: Swift.String? = nil, - git_commits_url: Swift.String? = nil, - git_refs_url: Swift.String? = nil, - git_tags_url: Swift.String? = nil, - git_url: Swift.String? = nil, - issue_comment_url: Swift.String? = nil, - issue_events_url: Swift.String? = nil, - issues_url: Swift.String? = nil, - keys_url: Swift.String? = nil, - labels_url: Swift.String? = nil, - languages_url: Swift.String? = nil, - merges_url: Swift.String? = nil, - milestones_url: Swift.String? = nil, - notifications_url: Swift.String? = nil, - pulls_url: Swift.String? = nil, - releases_url: Swift.String? = nil, - ssh_url: Swift.String? = nil, - stargazers_url: Swift.String? = nil, - statuses_url: Swift.String? = nil, - subscribers_url: Swift.String? = nil, - subscription_url: Swift.String? = nil, - tags_url: Swift.String? = nil, - teams_url: Swift.String? = nil, - trees_url: Swift.String? = nil, - clone_url: Swift.String? = nil, - mirror_url: Swift.String? = nil, - hooks_url: Swift.String? = nil, - svn_url: Swift.String? = nil, - homepage: Swift.String? = nil, - language: Swift.String? = nil, - forks_count: Swift.Int? = nil, - stargazers_count: Swift.Int? = nil, - watchers_count: Swift.Int? = nil, - size: Swift.Int? = nil, - default_branch: Swift.String? = nil, - open_issues_count: Swift.Int? = nil, - is_template: Swift.Bool? = nil, - topics: [Swift.String]? = nil, - has_issues: Swift.Bool? = nil, - has_projects: Swift.Bool? = nil, - has_wiki: Swift.Bool? = nil, - has_pages: Swift.Bool? = nil, - has_downloads: Swift.Bool? = nil, - archived: Swift.Bool? = nil, - disabled: Swift.Bool? = nil, - visibility: Swift.String? = nil, - pushed_at: Swift.String? = nil, - created_at: Swift.String? = nil, - updated_at: Swift.String? = nil, - permissions: Components.Schemas.repository.template_repositoryPayload.permissionsPayload? = nil, - allow_rebase_merge: Swift.Bool? = nil, - temp_clone_token: Swift.String? = nil, - allow_squash_merge: Swift.Bool? = nil, - allow_auto_merge: Swift.Bool? = nil, - delete_branch_on_merge: Swift.Bool? = nil, - allow_update_branch: Swift.Bool? = nil, - use_squash_pr_title_as_default: Swift.Bool? = nil, - squash_merge_commit_title: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_titlePayload? = nil, - squash_merge_commit_message: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_messagePayload? = nil, - merge_commit_title: Components.Schemas.repository.template_repositoryPayload.merge_commit_titlePayload? = nil, - merge_commit_message: Components.Schemas.repository.template_repositoryPayload.merge_commit_messagePayload? = nil, - allow_merge_commit: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil - ) { - self.id = id - self.node_id = node_id - self.name = name - self.full_name = full_name - self.owner = owner - self._private = _private - self.html_url = html_url - self.description = description - self.fork = fork - self.url = url - self.archive_url = archive_url - self.assignees_url = assignees_url - self.blobs_url = blobs_url - self.branches_url = branches_url - self.collaborators_url = collaborators_url - self.comments_url = comments_url - self.commits_url = commits_url - self.compare_url = compare_url - self.contents_url = contents_url - self.contributors_url = contributors_url - self.deployments_url = deployments_url - self.downloads_url = downloads_url - self.events_url = events_url - self.forks_url = forks_url - self.git_commits_url = git_commits_url - self.git_refs_url = git_refs_url - self.git_tags_url = git_tags_url - self.git_url = git_url - self.issue_comment_url = issue_comment_url - self.issue_events_url = issue_events_url - self.issues_url = issues_url - self.keys_url = keys_url - self.labels_url = labels_url - self.languages_url = languages_url - self.merges_url = merges_url - self.milestones_url = milestones_url - self.notifications_url = notifications_url - self.pulls_url = pulls_url - self.releases_url = releases_url - self.ssh_url = ssh_url - self.stargazers_url = stargazers_url - self.statuses_url = statuses_url - self.subscribers_url = subscribers_url - self.subscription_url = subscription_url - self.tags_url = tags_url - self.teams_url = teams_url - self.trees_url = trees_url - self.clone_url = clone_url - self.mirror_url = mirror_url - self.hooks_url = hooks_url - self.svn_url = svn_url - self.homepage = homepage - self.language = language - self.forks_count = forks_count - self.stargazers_count = stargazers_count - self.watchers_count = watchers_count - self.size = size - self.default_branch = default_branch - self.open_issues_count = open_issues_count - self.is_template = is_template - self.topics = topics - self.has_issues = has_issues - self.has_projects = has_projects - self.has_wiki = has_wiki - self.has_pages = has_pages - self.has_downloads = has_downloads - self.archived = archived - self.disabled = disabled - self.visibility = visibility - self.pushed_at = pushed_at - self.created_at = created_at - self.updated_at = updated_at - self.permissions = permissions - self.allow_rebase_merge = allow_rebase_merge - self.temp_clone_token = temp_clone_token - self.allow_squash_merge = allow_squash_merge - self.allow_auto_merge = allow_auto_merge - self.delete_branch_on_merge = delete_branch_on_merge - self.allow_update_branch = allow_update_branch - self.use_squash_pr_title_as_default = use_squash_pr_title_as_default - self.squash_merge_commit_title = squash_merge_commit_title - self.squash_merge_commit_message = squash_merge_commit_message - self.merge_commit_title = merge_commit_title - self.merge_commit_message = merge_commit_message - self.allow_merge_commit = allow_merge_commit - self.subscribers_count = subscribers_count - self.network_count = network_count - } - public enum CodingKeys: String, CodingKey { - case id - case node_id - case name - case full_name - case owner - case _private = "private" - case html_url - case description - case fork - case url - case archive_url - case assignees_url - case blobs_url - case branches_url - case collaborators_url - case comments_url - case commits_url - case compare_url - case contents_url - case contributors_url - case deployments_url - case downloads_url - case events_url - case forks_url - case git_commits_url - case git_refs_url - case git_tags_url - case git_url - case issue_comment_url - case issue_events_url - case issues_url - case keys_url - case labels_url - case languages_url - case merges_url - case milestones_url - case notifications_url - case pulls_url - case releases_url - case ssh_url - case stargazers_url - case statuses_url - case subscribers_url - case subscription_url - case tags_url - case teams_url - case trees_url - case clone_url - case mirror_url - case hooks_url - case svn_url - case homepage - case language - case forks_count - case stargazers_count - case watchers_count - case size - case default_branch - case open_issues_count - case is_template - case topics - case has_issues - case has_projects - case has_wiki - case has_pages - case has_downloads - case archived - case disabled - case visibility - case pushed_at - case created_at - case updated_at - case permissions - case allow_rebase_merge - case temp_clone_token - case allow_squash_merge - case allow_auto_merge - case delete_branch_on_merge - case allow_update_branch - case use_squash_pr_title_as_default - case squash_merge_commit_title - case squash_merge_commit_message - case merge_commit_title - case merge_commit_message - case allow_merge_commit - case subscribers_count - case network_count - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository`. - public var template_repository: Components.Schemas.repository.template_repositoryPayload? /// - Remark: Generated from `#/components/schemas/repository/temp_clone_token`. public var temp_clone_token: Swift.String? /// Whether to allow squash merges for pull requests. @@ -4396,10 +3621,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/repository/web_commit_signoff_required`. public var web_commit_signoff_required: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/network_count`. - public var network_count: Swift.Int? /// - Remark: Generated from `#/components/schemas/repository/open_issues`. public var open_issues: Swift.Int /// - Remark: Generated from `#/components/schemas/repository/watchers`. @@ -4420,7 +3641,6 @@ public enum Components { /// - name: The name of the repository. /// - full_name: /// - license: - /// - organization: /// - forks: /// - permissions: /// - owner: @@ -4493,7 +3713,6 @@ public enum Components { /// - created_at: /// - updated_at: /// - allow_rebase_merge: Whether to allow rebase merges for pull requests. - /// - template_repository: /// - temp_clone_token: /// - allow_squash_merge: Whether to allow squash merges for pull requests. /// - allow_auto_merge: Whether to allow Auto-merge to be used on pull requests. @@ -4507,8 +3726,6 @@ public enum Components { /// - allow_merge_commit: Whether to allow merge commits for pull requests. /// - allow_forking: Whether to allow forking this repo /// - web_commit_signoff_required: Whether to require contributors to sign off on web-based commits - /// - subscribers_count: - /// - network_count: /// - open_issues: /// - watchers: /// - master_branch: @@ -4520,7 +3737,6 @@ public enum Components { name: Swift.String, full_name: Swift.String, license: Components.Schemas.nullable_hyphen_license_hyphen_simple? = nil, - organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? = nil, forks: Swift.Int, permissions: Components.Schemas.repository.permissionsPayload? = nil, owner: Components.Schemas.simple_hyphen_user, @@ -4593,7 +3809,6 @@ public enum Components { created_at: Foundation.Date? = nil, updated_at: Foundation.Date? = nil, allow_rebase_merge: Swift.Bool? = nil, - template_repository: Components.Schemas.repository.template_repositoryPayload? = nil, temp_clone_token: Swift.String? = nil, allow_squash_merge: Swift.Bool? = nil, allow_auto_merge: Swift.Bool? = nil, @@ -4607,8 +3822,6 @@ public enum Components { allow_merge_commit: Swift.Bool? = nil, allow_forking: Swift.Bool? = nil, web_commit_signoff_required: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil, open_issues: Swift.Int, watchers: Swift.Int, master_branch: Swift.String? = nil, @@ -4620,7 +3833,6 @@ public enum Components { self.name = name self.full_name = full_name self.license = license - self.organization = organization self.forks = forks self.permissions = permissions self.owner = owner @@ -4693,7 +3905,6 @@ public enum Components { self.created_at = created_at self.updated_at = updated_at self.allow_rebase_merge = allow_rebase_merge - self.template_repository = template_repository self.temp_clone_token = temp_clone_token self.allow_squash_merge = allow_squash_merge self.allow_auto_merge = allow_auto_merge @@ -4707,8 +3918,6 @@ public enum Components { self.allow_merge_commit = allow_merge_commit self.allow_forking = allow_forking self.web_commit_signoff_required = web_commit_signoff_required - self.subscribers_count = subscribers_count - self.network_count = network_count self.open_issues = open_issues self.watchers = watchers self.master_branch = master_branch @@ -4721,7 +3930,6 @@ public enum Components { case name case full_name case license - case organization case forks case permissions case owner @@ -4794,7 +4002,6 @@ public enum Components { case created_at case updated_at case allow_rebase_merge - case template_repository case temp_clone_token case allow_squash_merge case allow_auto_merge @@ -4808,8 +4015,6 @@ public enum Components { case allow_merge_commit case allow_forking case web_commit_signoff_required - case subscribers_count - case network_count case open_issues case watchers case master_branch @@ -7189,10 +6394,10 @@ public enum Operations { } /// List installations for the authenticated app /// - /// You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - /// /// The permissions the installation has are included under the `permissions` key. /// + /// You must use a [JWT](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. + /// /// - Remark: HTTP `GET /app/installations`. /// - Remark: Generated from `#/paths//app/installations/get(apps/list-installations)`. public enum apps_sol_list_hyphen_installations { @@ -8887,7 +8092,15 @@ public enum Operations { } /// Create a scoped access token /// - /// Use a non-scoped user access token to create a repository scoped and/or permission scoped user access token. You can specify which repositories the token can access and which permissions are granted to the token. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App as the username and password. Invalid tokens will return `404 NOT FOUND`. + /// Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify + /// which repositories the token can access and which permissions are granted to the + /// token. + /// + /// Invalid tokens will return `404 NOT FOUND`. + /// + /// You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) + /// when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App + /// as the username and password. /// /// - Remark: HTTP `POST /applications/{client_id}/token/scoped`. /// - Remark: Generated from `#/paths//applications/{client_id}/token/scoped/post(apps/scope-token)`. @@ -9179,8 +8392,6 @@ public enum Operations { /// /// **Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`). /// - /// If the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) of the target app to access this endpoint. - /// /// - Remark: HTTP `GET /apps/{app_slug}`. /// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`. public enum apps_sol_get_hyphen_by_hyphen_slug { @@ -9357,8 +8568,6 @@ public enum Operations { /// /// List repositories that an app installation can access. /// - /// You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - /// /// - Remark: HTTP `GET /installation/repositories`. /// - Remark: Generated from `#/paths//installation/repositories/get(apps/list-repos-accessible-to-installation)`. public enum apps_sol_list_hyphen_repos_hyphen_accessible_hyphen_to_hyphen_installation { @@ -9619,8 +8828,6 @@ public enum Operations { /// /// Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the "[Create an installation access token for an app](https://docs.github.com/rest/apps/apps#create-an-installation-access-token-for-an-app)" endpoint. /// - /// You must use an [installation access token](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint. - /// /// - Remark: HTTP `DELETE /installation/token`. /// - Remark: Generated from `#/paths//installation/token/delete(apps/revoke-installation-access-token)`. public enum apps_sol_revoke_hyphen_installation_hyphen_access_hyphen_token { @@ -11275,8 +10482,6 @@ public enum Operations { /// /// Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. /// - /// You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - /// /// The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. /// /// You can find the permissions for the installation under the `permissions` key. @@ -11535,8 +10740,6 @@ public enum Operations { /// /// The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership. /// - /// You must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. - /// /// The access the user has to each repository is included in the hash under the `permissions` key. /// /// - Remark: HTTP `GET /user/installations/{installation_id}/repositories`. @@ -11815,8 +11018,6 @@ public enum Operations { /// /// Add a single repository to an installation. The authenticated user must have admin access to the repository. /// - /// You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - /// /// - Remark: HTTP `PUT /user/installations/{installation_id}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/installations/{installation_id}/repositories/{repository_id}/put(apps/add-repo-to-installation-for-authenticated-user)`. public enum apps_sol_add_hyphen_repo_hyphen_to_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user { @@ -12003,8 +11204,6 @@ public enum Operations { /// /// Remove a single repository from an installation. The authenticated user must have admin access to the repository. The installation must have the `repository_selection` of `selected`. /// - /// You must use a personal access token (which you can create via the [command line](https://docs.github.com/github/authenticating-to-github/creating-a-personal-access-token) or [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)) to access this endpoint. - /// /// - Remark: HTTP `DELETE /user/installations/{installation_id}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/installations/{installation_id}/repositories/{repository_id}/delete(apps/remove-repo-from-installation-for-authenticated-user)`. public enum apps_sol_remove_hyphen_repo_hyphen_from_hyphen_installation_hyphen_for_hyphen_authenticated_hyphen_user { @@ -12216,7 +11415,7 @@ public enum Operations { } /// List subscriptions for the authenticated user /// - /// Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + /// Lists the active subscriptions for the authenticated user. /// /// - Remark: HTTP `GET /user/marketplace_purchases`. /// - Remark: Generated from `#/paths//user/marketplace_purchases/get(apps/list-subscriptions-for-authenticated-user)`. @@ -12445,7 +11644,7 @@ public enum Operations { } /// List subscriptions for the authenticated user (stubbed) /// - /// Lists the active subscriptions for the authenticated user. GitHub Apps must use a [user access token](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/generating-a-user-access-token-for-a-github-app), created for a user who has authorized your GitHub App, to access this endpoint. OAuth apps must authenticate using an [OAuth token](https://docs.github.com/apps/oauth-apps/building-oauth-apps/authorizing-oauth-apps). + /// Lists the active subscriptions for the authenticated user. /// /// - Remark: HTTP `GET /user/marketplace_purchases/stubbed`. /// - Remark: Generated from `#/paths//user/marketplace_purchases/stubbed/get(apps/list-subscriptions-for-authenticated-user-stubbed)`. From 56e1f4460385211a1c28df7c2f080369fea9d076 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:11:07 +0000 Subject: [PATCH 04/20] Commit via running ake Sources/billing --- Sources/billing/Client.swift | 12 ++++++------ Sources/billing/Types.swift | 36 ++++++++++++++++++------------------ 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/Sources/billing/Client.swift b/Sources/billing/Client.swift index 615ee017a5..73aa1fdf2c 100644 --- a/Sources/billing/Client.swift +++ b/Sources/billing/Client.swift @@ -44,7 +44,7 @@ public struct Client: APIProtocol { /// /// Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// Access tokens must have the `repo` or `admin:org` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/settings/billing/actions`. /// - Remark: Generated from `#/paths//orgs/{org}/settings/billing/actions/get(billing/get-github-actions-billing-org)`. @@ -112,7 +112,7 @@ public struct Client: APIProtocol { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `repo` or `admin:org` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/settings/billing/packages`. /// - Remark: Generated from `#/paths//orgs/{org}/settings/billing/packages/get(billing/get-github-packages-billing-org)`. @@ -180,7 +180,7 @@ public struct Client: APIProtocol { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `repo` or `admin:org` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/settings/billing/shared-storage`. /// - Remark: Generated from `#/paths//orgs/{org}/settings/billing/shared-storage/get(billing/get-shared-storage-billing-org)`. @@ -248,7 +248,7 @@ public struct Client: APIProtocol { /// /// Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// Access tokens must have the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/settings/billing/actions`. /// - Remark: Generated from `#/paths//users/{username}/settings/billing/actions/get(billing/get-github-actions-billing-user)`. @@ -316,7 +316,7 @@ public struct Client: APIProtocol { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/settings/billing/packages`. /// - Remark: Generated from `#/paths//users/{username}/settings/billing/packages/get(billing/get-github-packages-billing-user)`. @@ -384,7 +384,7 @@ public struct Client: APIProtocol { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/settings/billing/shared-storage`. /// - Remark: Generated from `#/paths//users/{username}/settings/billing/shared-storage/get(billing/get-shared-storage-billing-user)`. diff --git a/Sources/billing/Types.swift b/Sources/billing/Types.swift index d7e0282922..9d26a79252 100644 --- a/Sources/billing/Types.swift +++ b/Sources/billing/Types.swift @@ -17,7 +17,7 @@ public protocol APIProtocol: Sendable { /// /// Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// Access tokens must have the `repo` or `admin:org` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/settings/billing/actions`. /// - Remark: Generated from `#/paths//orgs/{org}/settings/billing/actions/get(billing/get-github-actions-billing-org)`. @@ -28,7 +28,7 @@ public protocol APIProtocol: Sendable { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `repo` or `admin:org` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/settings/billing/packages`. /// - Remark: Generated from `#/paths//orgs/{org}/settings/billing/packages/get(billing/get-github-packages-billing-org)`. @@ -39,7 +39,7 @@ public protocol APIProtocol: Sendable { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `repo` or `admin:org` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/settings/billing/shared-storage`. /// - Remark: Generated from `#/paths//orgs/{org}/settings/billing/shared-storage/get(billing/get-shared-storage-billing-org)`. @@ -50,7 +50,7 @@ public protocol APIProtocol: Sendable { /// /// Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// Access tokens must have the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/settings/billing/actions`. /// - Remark: Generated from `#/paths//users/{username}/settings/billing/actions/get(billing/get-github-actions-billing-user)`. @@ -61,7 +61,7 @@ public protocol APIProtocol: Sendable { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/settings/billing/packages`. /// - Remark: Generated from `#/paths//users/{username}/settings/billing/packages/get(billing/get-github-packages-billing-user)`. @@ -72,7 +72,7 @@ public protocol APIProtocol: Sendable { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/settings/billing/shared-storage`. /// - Remark: Generated from `#/paths//users/{username}/settings/billing/shared-storage/get(billing/get-shared-storage-billing-user)`. @@ -87,7 +87,7 @@ extension APIProtocol { /// /// Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// Access tokens must have the `repo` or `admin:org` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/settings/billing/actions`. /// - Remark: Generated from `#/paths//orgs/{org}/settings/billing/actions/get(billing/get-github-actions-billing-org)`. @@ -106,7 +106,7 @@ extension APIProtocol { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `repo` or `admin:org` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/settings/billing/packages`. /// - Remark: Generated from `#/paths//orgs/{org}/settings/billing/packages/get(billing/get-github-packages-billing-org)`. @@ -125,7 +125,7 @@ extension APIProtocol { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `repo` or `admin:org` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/settings/billing/shared-storage`. /// - Remark: Generated from `#/paths//orgs/{org}/settings/billing/shared-storage/get(billing/get-shared-storage-billing-org)`. @@ -144,7 +144,7 @@ extension APIProtocol { /// /// Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// Access tokens must have the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/settings/billing/actions`. /// - Remark: Generated from `#/paths//users/{username}/settings/billing/actions/get(billing/get-github-actions-billing-user)`. @@ -163,7 +163,7 @@ extension APIProtocol { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/settings/billing/packages`. /// - Remark: Generated from `#/paths//users/{username}/settings/billing/packages/get(billing/get-github-packages-billing-user)`. @@ -182,7 +182,7 @@ extension APIProtocol { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/settings/billing/shared-storage`. /// - Remark: Generated from `#/paths//users/{username}/settings/billing/shared-storage/get(billing/get-shared-storage-billing-user)`. @@ -481,7 +481,7 @@ public enum Operations { /// /// Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// Access tokens must have the `repo` or `admin:org` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/settings/billing/actions`. /// - Remark: Generated from `#/paths//orgs/{org}/settings/billing/actions/get(billing/get-github-actions-billing-org)`. @@ -617,7 +617,7 @@ public enum Operations { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `repo` or `admin:org` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/settings/billing/packages`. /// - Remark: Generated from `#/paths//orgs/{org}/settings/billing/packages/get(billing/get-github-packages-billing-org)`. @@ -753,7 +753,7 @@ public enum Operations { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `repo` or `admin:org` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/settings/billing/shared-storage`. /// - Remark: Generated from `#/paths//orgs/{org}/settings/billing/shared-storage/get(billing/get-shared-storage-billing-org)`. @@ -889,7 +889,7 @@ public enum Operations { /// /// Paid minutes only apply to workflows in private repositories that use GitHub-hosted runners. Minutes used is listed for each GitHub-hosted runner operating system. Any job re-runs are also included in the usage. The usage returned includes any minute multipliers for macOS and Windows runners, and is rounded up to the nearest whole minute. For more information, see "[Managing billing for GitHub Actions](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)". /// - /// Access tokens must have the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/settings/billing/actions`. /// - Remark: Generated from `#/paths//users/{username}/settings/billing/actions/get(billing/get-github-actions-billing-user)`. @@ -1025,7 +1025,7 @@ public enum Operations { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/settings/billing/packages`. /// - Remark: Generated from `#/paths//users/{username}/settings/billing/packages/get(billing/get-github-packages-billing-user)`. @@ -1161,7 +1161,7 @@ public enum Operations { /// /// Paid minutes only apply to packages stored for private repositories. For more information, see "[Managing billing for GitHub Packages](https://docs.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-packages)." /// - /// Access tokens must have the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/settings/billing/shared-storage`. /// - Remark: Generated from `#/paths//users/{username}/settings/billing/shared-storage/get(billing/get-shared-storage-billing-user)`. From ed0cef5f5962ca7ab245078950bc16801320d44a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:11:28 +0000 Subject: [PATCH 05/20] Commit via running ake Sources/checks --- Sources/checks/Client.swift | 42 ++++++------ Sources/checks/Types.swift | 126 ++++++++++++++++-------------------- 2 files changed, 76 insertions(+), 92 deletions(-) diff --git a/Sources/checks/Client.swift b/Sources/checks/Client.swift index 10d069e987..74a2ce03de 100644 --- a/Sources/checks/Client.swift +++ b/Sources/checks/Client.swift @@ -42,7 +42,7 @@ public struct Client: APIProtocol { /// /// Creates a new check run for a specific commit in a repository. /// - /// 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. + /// To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. /// /// 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. /// @@ -122,10 +122,10 @@ public struct Client: APIProtocol { /// /// Gets a single check run using its `id`. /// - /// 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. - /// /// **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. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-runs/{check_run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/get(checks/get)`. 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 { /// /// Updates a check run for a specific commit in a repository. /// - /// 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. - /// /// **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. /// + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. + /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/patch(checks/update)`. 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 { /// /// Lists annotations for a check run using the annotation `id`. /// - /// GitHub Apps - /// must have the `checks:read` permission on a private repository or pull access to - /// a public repository to get annotations for a check run. OAuth apps and authenticated - /// users must have the `repo` scope to get annotations for a check run in a private - /// repository. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations`. /// - 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 { /// /// 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. /// - /// 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. - /// /// 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)". /// + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest/post(checks/rerequest-run)`. 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 { /// /// 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)". /// - /// 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. - /// /// **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`. /// + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-suites`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/post(checks/create-suite)`. 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 { /// /// Gets a single check suite using its `id`. /// - /// 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. - /// /// **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`. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-suites/{check_suite_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/get(checks/get-suite)`. 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 { /// /// Lists check runs for a check suite using its `id`. /// - /// 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. - /// /// **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. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs/get(checks/list-for-suite)`. 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 { /// /// 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. /// - /// 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. + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest`. /// - 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 { /// /// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. /// - /// 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. - /// /// **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. /// /// 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. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/commits/{ref}/check-runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/commits/{ref}/check-runs/get(checks/list-for-ref)`. 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 { /// /// Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. /// - /// 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. - /// /// **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`. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/commits/{ref}/check-suites`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/commits/{ref}/check-suites/get(checks/list-suites-for-ref)`. 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 { diff --git a/Sources/checks/Types.swift b/Sources/checks/Types.swift index f1f5109224..df43620de4 100644 --- a/Sources/checks/Types.swift +++ b/Sources/checks/Types.swift @@ -15,7 +15,7 @@ public protocol APIProtocol: Sendable { /// /// Creates a new check run for a specific commit in a repository. /// - /// 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. + /// To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. /// /// 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. /// @@ -28,10 +28,10 @@ public protocol APIProtocol: Sendable { /// /// Gets a single check run using its `id`. /// - /// 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. - /// /// **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. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-runs/{check_run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/get(checks/get)`. func checks_sol_get(_ input: Operations.checks_sol_get.Input) async throws -> Operations.checks_sol_get.Output @@ -39,10 +39,10 @@ public protocol APIProtocol: Sendable { /// /// Updates a check run for a specific commit in a repository. /// - /// 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. - /// /// **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. /// + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. + /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/patch(checks/update)`. func checks_sol_update(_ input: Operations.checks_sol_update.Input) async throws -> Operations.checks_sol_update.Output @@ -50,11 +50,7 @@ public protocol APIProtocol: Sendable { /// /// Lists annotations for a check run using the annotation `id`. /// - /// GitHub Apps - /// must have the `checks:read` permission on a private repository or pull access to - /// a public repository to get annotations for a check run. OAuth apps and authenticated - /// users must have the `repo` scope to get annotations for a check run in a private - /// repository. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/annotations/get(checks/list-annotations)`. @@ -63,10 +59,10 @@ public protocol APIProtocol: Sendable { /// /// 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. /// - /// 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. - /// /// 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)". /// + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest/post(checks/rerequest-run)`. func checks_sol_rerequest_hyphen_run(_ input: Operations.checks_sol_rerequest_hyphen_run.Input) async throws -> Operations.checks_sol_rerequest_hyphen_run.Output @@ -74,10 +70,10 @@ public protocol APIProtocol: Sendable { /// /// 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)". /// - /// 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. - /// /// **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`. /// + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-suites`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/post(checks/create-suite)`. func checks_sol_create_hyphen_suite(_ input: Operations.checks_sol_create_hyphen_suite.Input) async throws -> Operations.checks_sol_create_hyphen_suite.Output @@ -93,10 +89,10 @@ public protocol APIProtocol: Sendable { /// /// Gets a single check suite using its `id`. /// - /// 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. - /// /// **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`. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-suites/{check_suite_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/get(checks/get-suite)`. func checks_sol_get_hyphen_suite(_ input: Operations.checks_sol_get_hyphen_suite.Input) async throws -> Operations.checks_sol_get_hyphen_suite.Output @@ -104,10 +100,10 @@ public protocol APIProtocol: Sendable { /// /// Lists check runs for a check suite using its `id`. /// - /// 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. - /// /// **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. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs/get(checks/list-for-suite)`. 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 @@ -115,7 +111,7 @@ public protocol APIProtocol: Sendable { /// /// 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. /// - /// 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. + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest/post(checks/rerequest-suite)`. @@ -124,12 +120,12 @@ public protocol APIProtocol: Sendable { /// /// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. /// - /// 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. - /// /// **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. /// /// 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. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/commits/{ref}/check-runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/commits/{ref}/check-runs/get(checks/list-for-ref)`. 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 @@ -137,10 +133,10 @@ public protocol APIProtocol: Sendable { /// /// Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. /// - /// 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. - /// /// **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`. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/commits/{ref}/check-suites`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/commits/{ref}/check-suites/get(checks/list-suites-for-ref)`. 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 @@ -152,7 +148,7 @@ extension APIProtocol { /// /// Creates a new check run for a specific commit in a repository. /// - /// 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. + /// To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. /// /// 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. /// @@ -175,10 +171,10 @@ extension APIProtocol { /// /// Gets a single check run using its `id`. /// - /// 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. - /// /// **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. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-runs/{check_run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/get(checks/get)`. public func checks_sol_get( @@ -194,10 +190,10 @@ extension APIProtocol { /// /// Updates a check run for a specific commit in a repository. /// - /// 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. - /// /// **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. /// + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. + /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/patch(checks/update)`. public func checks_sol_update( @@ -215,11 +211,7 @@ extension APIProtocol { /// /// Lists annotations for a check run using the annotation `id`. /// - /// GitHub Apps - /// must have the `checks:read` permission on a private repository or pull access to - /// a public repository to get annotations for a check run. OAuth apps and authenticated - /// users must have the `repo` scope to get annotations for a check run in a private - /// repository. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/annotations/get(checks/list-annotations)`. @@ -238,10 +230,10 @@ extension APIProtocol { /// /// 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. /// - /// 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. - /// /// 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)". /// + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest/post(checks/rerequest-run)`. public func checks_sol_rerequest_hyphen_run( @@ -257,10 +249,10 @@ extension APIProtocol { /// /// 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)". /// - /// 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. - /// /// **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`. /// + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-suites`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/post(checks/create-suite)`. public func checks_sol_create_hyphen_suite( @@ -296,10 +288,10 @@ extension APIProtocol { /// /// Gets a single check suite using its `id`. /// - /// 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. - /// /// **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`. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-suites/{check_suite_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/get(checks/get-suite)`. public func checks_sol_get_hyphen_suite( @@ -315,10 +307,10 @@ extension APIProtocol { /// /// Lists check runs for a check suite using its `id`. /// - /// 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. - /// /// **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. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs/get(checks/list-for-suite)`. public func checks_sol_list_hyphen_for_hyphen_suite( @@ -336,7 +328,7 @@ extension APIProtocol { /// /// 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. /// - /// 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. + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest/post(checks/rerequest-suite)`. @@ -353,12 +345,12 @@ extension APIProtocol { /// /// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. /// - /// 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. - /// /// **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. /// /// 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. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/commits/{ref}/check-runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/commits/{ref}/check-runs/get(checks/list-for-ref)`. public func checks_sol_list_hyphen_for_hyphen_ref( @@ -376,10 +368,10 @@ extension APIProtocol { /// /// Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. /// - /// 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. - /// /// **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`. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/commits/{ref}/check-suites`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/commits/{ref}/check-suites/get(checks/list-suites-for-ref)`. public func checks_sol_list_hyphen_suites_hyphen_for_hyphen_ref( @@ -2706,7 +2698,7 @@ public enum Operations { /// /// Creates a new check run for a specific commit in a repository. /// - /// 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. + /// To create a check run, you must use a GitHub App. OAuth apps and authenticated users are not able to create a check suite. /// /// 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. /// @@ -2977,10 +2969,10 @@ public enum Operations { /// /// Gets a single check run using its `id`. /// - /// 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. - /// /// **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. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-runs/{check_run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/get(checks/get)`. public enum checks_sol_get { @@ -3129,10 +3121,10 @@ public enum Operations { /// /// Updates a check run for a specific commit in a repository. /// - /// 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. - /// /// **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. /// + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. + /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/patch(checks/update)`. public enum checks_sol_update { @@ -3415,11 +3407,7 @@ public enum Operations { /// /// Lists annotations for a check run using the annotation `id`. /// - /// GitHub Apps - /// must have the `checks:read` permission on a private repository or pull access to - /// a public repository to get annotations for a check run. OAuth apps and authenticated - /// users must have the `repo` scope to get annotations for a check run in a private - /// repository. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/annotations/get(checks/list-annotations)`. @@ -3615,10 +3603,10 @@ public enum Operations { /// /// 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. /// - /// 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. - /// /// 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)". /// + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-runs/{check_run_id}/rerequest/post(checks/rerequest-run)`. public enum checks_sol_rerequest_hyphen_run { @@ -3892,10 +3880,10 @@ public enum Operations { /// /// 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)". /// - /// 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. - /// /// **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`. /// + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-suites`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/post(checks/create-suite)`. public enum checks_sol_create_hyphen_suite { @@ -4313,10 +4301,10 @@ public enum Operations { /// /// Gets a single check suite using its `id`. /// - /// 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. - /// /// **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`. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-suites/{check_suite_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/get(checks/get-suite)`. public enum checks_sol_get_hyphen_suite { @@ -4465,10 +4453,10 @@ public enum Operations { /// /// Lists check runs for a check suite using its `id`. /// - /// 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. - /// /// **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. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs/get(checks/list-for-suite)`. public enum checks_sol_list_hyphen_for_hyphen_suite { @@ -4718,7 +4706,7 @@ public enum Operations { /// /// 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. /// - /// 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. + /// OAuth apps and personal access tokens (classic) cannot use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest/post(checks/rerequest-suite)`. @@ -4868,12 +4856,12 @@ public enum Operations { /// /// Lists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. /// - /// 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. - /// /// **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. /// /// 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. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/commits/{ref}/check-runs`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/commits/{ref}/check-runs/get(checks/list-for-ref)`. public enum checks_sol_list_hyphen_for_hyphen_ref { @@ -5128,10 +5116,10 @@ public enum Operations { /// /// Lists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. /// - /// 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. - /// /// **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`. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint on a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/commits/{ref}/check-suites`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/commits/{ref}/check-suites/get(checks/list-suites-for-ref)`. public enum checks_sol_list_hyphen_suites_hyphen_for_hyphen_ref { From 0b8fe4dbc7d9005249759e204ee7ac74e5cf9970 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:11:48 +0000 Subject: [PATCH 06/20] Commit via running ake Sources/code-scanning --- Sources/code-scanning/Client.swift | 57 +++++----- Sources/code-scanning/Types.swift | 171 +++++++++++++++-------------- 2 files changed, 116 insertions(+), 112 deletions(-) diff --git a/Sources/code-scanning/Client.swift b/Sources/code-scanning/Client.swift index 1e8ddeb8dd..ea544637a0 100644 --- a/Sources/code-scanning/Client.swift +++ b/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)`. diff --git a/Sources/code-scanning/Types.swift b/Sources/code-scanning/Types.swift index 7b1cbee278..215f92ffe5 100644 --- a/Sources/code-scanning/Types.swift +++ b/Sources/code-scanning/Types.swift @@ -15,9 +15,9 @@ public protocol APIProtocol: Sendable { /// /// 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)`. @@ -26,25 +26,28 @@ public protocol APIProtocol: Sendable { /// /// 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)`. 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 /// 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)`. func code_hyphen_scanning_sol_get_hyphen_alert(_ input: Operations.code_hyphen_scanning_sol_get_hyphen_alert.Input) async throws -> Operations.code_hyphen_scanning_sol_get_hyphen_alert.Output /// 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)`. @@ -52,8 +55,8 @@ public protocol APIProtocol: Sendable { /// 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)`. @@ -71,12 +74,11 @@ public protocol APIProtocol: Sendable { /// 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)`. 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 @@ -84,9 +86,6 @@ public protocol APIProtocol: Sendable { /// /// 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, @@ -101,15 +100,14 @@ public protocol APIProtocol: Sendable { /// /// - **`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)`. 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 /// 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. @@ -172,6 +170,8 @@ public protocol APIProtocol: Sendable { /// /// 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)`. 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 @@ -179,8 +179,7 @@ public protocol APIProtocol: Sendable { /// /// 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)`. @@ -195,8 +194,7 @@ public protocol APIProtocol: Sendable { /// 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)`. @@ -204,8 +202,8 @@ public protocol APIProtocol: Sendable { /// 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)`. @@ -213,15 +211,15 @@ public protocol APIProtocol: Sendable { /// 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)`. func code_hyphen_scanning_sol_update_hyphen_default_hyphen_setup(_ input: Operations.code_hyphen_scanning_sol_update_hyphen_default_hyphen_setup.Input) async throws -> Operations.code_hyphen_scanning_sol_update_hyphen_default_hyphen_setup.Output /// 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)." @@ -252,12 +250,15 @@ public protocol APIProtocol: Sendable { /// 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)`. 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 /// 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)`. @@ -270,9 +271,9 @@ extension 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)`. @@ -291,12 +292,12 @@ extension 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( @@ -312,7 +313,9 @@ extension 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)`. @@ -327,7 +330,8 @@ extension 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)`. @@ -345,8 +349,8 @@ extension 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)`. @@ -374,12 +378,11 @@ extension 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( @@ -397,9 +400,6 @@ extension 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, @@ -414,6 +414,8 @@ extension 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( @@ -427,10 +429,7 @@ extension 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. @@ -493,6 +492,8 @@ extension 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( @@ -510,8 +511,7 @@ extension 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)`. @@ -534,8 +534,7 @@ extension 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)`. @@ -551,8 +550,8 @@ extension 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)`. @@ -568,8 +567,8 @@ extension 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)`. @@ -586,7 +585,7 @@ extension 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)." @@ -617,6 +616,8 @@ extension 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( @@ -632,7 +633,8 @@ extension 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)`. @@ -3015,9 +3017,9 @@ public enum Operations { /// /// 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)`. @@ -3309,12 +3311,12 @@ public enum Operations { /// /// 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 enum code_hyphen_scanning_sol_list_hyphen_alerts_hyphen_for_hyphen_repo { @@ -3632,7 +3634,9 @@ public enum Operations { } /// 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)`. @@ -3872,7 +3876,8 @@ public enum Operations { } /// 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)`. @@ -4128,8 +4133,8 @@ public enum Operations { /// 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)`. @@ -4391,12 +4396,11 @@ public enum Operations { /// 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 enum code_hyphen_scanning_sol_list_hyphen_recent_hyphen_analyses { @@ -4685,9 +4689,6 @@ public enum Operations { /// /// 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, @@ -4702,6 +4703,8 @@ public enum Operations { /// /// - **`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 enum code_hyphen_scanning_sol_get_hyphen_analysis { @@ -4947,10 +4950,7 @@ public enum Operations { } /// 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. @@ -5013,6 +5013,8 @@ public enum Operations { /// /// 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 enum code_hyphen_scanning_sol_delete_hyphen_analysis { @@ -5277,8 +5279,7 @@ public enum Operations { /// /// 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)`. @@ -5496,8 +5497,7 @@ public enum Operations { /// 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)`. @@ -5738,8 +5738,8 @@ public enum Operations { /// 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)`. @@ -5950,8 +5950,8 @@ public enum Operations { /// 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)`. @@ -6244,7 +6244,7 @@ public enum Operations { } /// 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)." @@ -6275,6 +6275,8 @@ public enum Operations { /// 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 enum code_hyphen_scanning_sol_upload_hyphen_sarif { @@ -6649,7 +6651,8 @@ public enum Operations { } /// 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)`. From cd634499385f3030372255d904797d74a75b45a6 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:12:49 +0000 Subject: [PATCH 07/20] Commit via running ake Sources/dependabot --- Sources/dependabot/Client.swift | 95 +++++++---- Sources/dependabot/Types.swift | 285 ++++++++++++++++++++------------ 2 files changed, 244 insertions(+), 136 deletions(-) diff --git a/Sources/dependabot/Client.swift b/Sources/dependabot/Client.swift index 391c311aa0..7b43bc0897 100644 --- a/Sources/dependabot/Client.swift +++ b/Sources/dependabot/Client.swift @@ -41,10 +41,13 @@ public struct Client: APIProtocol { /// List Dependabot alerts for an enterprise /// /// Lists Dependabot alerts for repositories that are owned by the specified enterprise. - /// To use this endpoint, you must be a member of the enterprise, and you must use an - /// access token with the `repo` scope or `security_events` scope. + /// + /// The authenticated user must be a member of the enterprise to use this endpoint. + /// /// Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, 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)." /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + /// /// - Remark: HTTP `GET /enterprises/{enterprise}/dependabot/alerts`. /// - Remark: Generated from `#/paths//enterprises/{enterprise}/dependabot/alerts/get(dependabot/list-alerts-for-enterprise)`. public func dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_enterprise(_ input: Operations.dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_enterprise.Input) async throws -> Operations.dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_enterprise.Output { @@ -261,11 +264,9 @@ public struct Client: APIProtocol { /// /// Lists Dependabot alerts for an 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. - /// - /// For public repositories, you may instead use the `public_repo` scope. + /// The authenticated user must be an owner or security manager for the organization to use this endpoint. /// - /// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/alerts`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/alerts/get(dependabot/list-alerts-for-org)`. @@ -512,7 +513,10 @@ public struct Client: APIProtocol { } /// List organization secrets /// - /// Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Lists all secrets available in an organization without revealing their + /// encrypted values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/get(dependabot/list-org-secrets)`. @@ -598,7 +602,10 @@ public struct Client: APIProtocol { } /// Get an organization public key /// - /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Gets your public key, which you need to encrypt secrets. You need to + /// encrypt a secret before you can create or update secrets. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/public-key`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/public-key/get(dependabot/get-org-public-key)`. @@ -662,7 +669,9 @@ public struct Client: APIProtocol { } /// Get an organization secret /// - /// Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Gets a single organization secret without revealing its encrypted value. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/get(dependabot/get-org-secret)`. @@ -730,9 +739,7 @@ public struct Client: APIProtocol { /// Creates or updates an organization secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - /// permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/put(dependabot/create-or-update-org-secret)`. @@ -808,7 +815,9 @@ public struct Client: APIProtocol { } /// Delete an organization secret /// - /// Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Deletes a secret in an organization using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/delete(dependabot/delete-org-secret)`. @@ -849,7 +858,10 @@ public struct Client: APIProtocol { } /// List selected repositories for an organization secret /// - /// Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Lists all repositories that have been selected when the `visibility` + /// for repository access to a secret is set to `selected`. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/get(dependabot/list-selected-repos-for-org-secret)`. @@ -928,7 +940,11 @@ public struct Client: APIProtocol { } /// Set selected repositories for an organization secret /// - /// Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Replaces all repositories for an organization secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/put(dependabot/set-selected-repos-for-org-secret)`. @@ -978,7 +994,11 @@ public struct Client: APIProtocol { } /// Add selected repository to an organization secret /// - /// Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Adds a repository to an organization secret when the `visibility` for + /// repository access is set to `selected`. The visibility is set when you [Create or + /// update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}/put(dependabot/add-selected-repo-to-org-secret)`. @@ -1022,7 +1042,11 @@ public struct Client: APIProtocol { } /// Remove selected repository from an organization secret /// - /// Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Removes a repository from an organization secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}/delete(dependabot/remove-selected-repo-from-org-secret)`. @@ -1066,9 +1090,7 @@ public struct Client: APIProtocol { } /// List Dependabot alerts for a repository /// - /// 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. - /// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/alerts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/get(dependabot/list-alerts-for-repo)`. @@ -1330,9 +1352,7 @@ public struct Client: APIProtocol { } /// Get a Dependabot 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. - /// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/{alert_number}/get(dependabot/get-alert)`. @@ -1444,11 +1464,9 @@ public struct Client: APIProtocol { } /// Update a Dependabot 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. - /// GitHub Apps must have **Dependabot alerts** write permission to use this endpoint. + /// The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." /// - /// To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/{alert_number}/patch(dependabot/update-alert)`. @@ -1642,7 +1660,10 @@ public struct Client: APIProtocol { } /// List repository secrets /// - /// Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Lists all secrets available in a repository without revealing their encrypted + /// values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/get(dependabot/list-repo-secrets)`. @@ -1729,7 +1750,11 @@ public struct Client: APIProtocol { } /// Get a repository public key /// - /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Gets your public key, which you need to encrypt secrets. You need to + /// encrypt a secret before you can create or update secrets. Anyone with read access + /// to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets/public-key`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/public-key/get(dependabot/get-repo-public-key)`. @@ -1794,7 +1819,9 @@ public struct Client: APIProtocol { } /// Get a repository secret /// - /// Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Gets a single repository secret without revealing its encrypted value. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/get(dependabot/get-repo-secret)`. @@ -1863,9 +1890,7 @@ public struct Client: APIProtocol { /// Creates or updates a repository secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - /// permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/put(dependabot/create-or-update-repo-secret)`. @@ -1942,7 +1967,9 @@ public struct Client: APIProtocol { } /// Delete a repository secret /// - /// Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Deletes a secret in a repository using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/delete(dependabot/delete-repo-secret)`. diff --git a/Sources/dependabot/Types.swift b/Sources/dependabot/Types.swift index 34876e9e75..11d0376e2e 100644 --- a/Sources/dependabot/Types.swift +++ b/Sources/dependabot/Types.swift @@ -14,10 +14,13 @@ public protocol APIProtocol: Sendable { /// List Dependabot alerts for an enterprise /// /// Lists Dependabot alerts for repositories that are owned by the specified enterprise. - /// To use this endpoint, you must be a member of the enterprise, and you must use an - /// access token with the `repo` scope or `security_events` scope. + /// + /// The authenticated user must be a member of the enterprise to use this endpoint. + /// /// Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, 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)." /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + /// /// - Remark: HTTP `GET /enterprises/{enterprise}/dependabot/alerts`. /// - Remark: Generated from `#/paths//enterprises/{enterprise}/dependabot/alerts/get(dependabot/list-alerts-for-enterprise)`. func dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_enterprise(_ input: Operations.dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_enterprise.Input) async throws -> Operations.dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_enterprise.Output @@ -25,32 +28,38 @@ public protocol APIProtocol: Sendable { /// /// Lists Dependabot alerts for an 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. - /// - /// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/alerts`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/alerts/get(dependabot/list-alerts-for-org)`. func dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_org(_ input: Operations.dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_org.Input) async throws -> Operations.dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_org.Output /// List organization secrets /// - /// Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Lists all secrets available in an organization without revealing their + /// encrypted values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/get(dependabot/list-org-secrets)`. func dependabot_sol_list_hyphen_org_hyphen_secrets(_ input: Operations.dependabot_sol_list_hyphen_org_hyphen_secrets.Input) async throws -> Operations.dependabot_sol_list_hyphen_org_hyphen_secrets.Output /// Get an organization public key /// - /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Gets your public key, which you need to encrypt secrets. You need to + /// encrypt a secret before you can create or update secrets. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/public-key`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/public-key/get(dependabot/get-org-public-key)`. func dependabot_sol_get_hyphen_org_hyphen_public_hyphen_key(_ input: Operations.dependabot_sol_get_hyphen_org_hyphen_public_hyphen_key.Input) async throws -> Operations.dependabot_sol_get_hyphen_org_hyphen_public_hyphen_key.Output /// Get an organization secret /// - /// Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Gets a single organization secret without revealing its encrypted value. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/get(dependabot/get-org-secret)`. @@ -60,94 +69,112 @@ public protocol APIProtocol: Sendable { /// Creates or updates an organization secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - /// permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/put(dependabot/create-or-update-org-secret)`. func dependabot_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret(_ input: Operations.dependabot_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret.Input) async throws -> Operations.dependabot_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret.Output /// Delete an organization secret /// - /// Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Deletes a secret in an organization using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/delete(dependabot/delete-org-secret)`. func dependabot_sol_delete_hyphen_org_hyphen_secret(_ input: Operations.dependabot_sol_delete_hyphen_org_hyphen_secret.Input) async throws -> Operations.dependabot_sol_delete_hyphen_org_hyphen_secret.Output /// List selected repositories for an organization secret /// - /// Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Lists all repositories that have been selected when the `visibility` + /// for repository access to a secret is set to `selected`. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/get(dependabot/list-selected-repos-for-org-secret)`. func dependabot_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret(_ input: Operations.dependabot_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Input) async throws -> Operations.dependabot_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Output /// Set selected repositories for an organization secret /// - /// Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Replaces all repositories for an organization secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/put(dependabot/set-selected-repos-for-org-secret)`. func dependabot_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret(_ input: Operations.dependabot_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Input) async throws -> Operations.dependabot_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Output /// Add selected repository to an organization secret /// - /// Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Adds a repository to an organization secret when the `visibility` for + /// repository access is set to `selected`. The visibility is set when you [Create or + /// update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}/put(dependabot/add-selected-repo-to-org-secret)`. func dependabot_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret(_ input: Operations.dependabot_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret.Input) async throws -> Operations.dependabot_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret.Output /// Remove selected repository from an organization secret /// - /// Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Removes a repository from an organization secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}/delete(dependabot/remove-selected-repo-from-org-secret)`. func dependabot_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret(_ input: Operations.dependabot_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret.Input) async throws -> Operations.dependabot_sol_remove_hyphen_selected_hyphen_repo_hyphen_from_hyphen_org_hyphen_secret.Output /// List Dependabot alerts for a repository /// - /// 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. - /// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/alerts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/get(dependabot/list-alerts-for-repo)`. func dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_repo(_ input: Operations.dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_repo.Input) async throws -> Operations.dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_repo.Output /// Get a Dependabot 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. - /// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/{alert_number}/get(dependabot/get-alert)`. func dependabot_sol_get_hyphen_alert(_ input: Operations.dependabot_sol_get_hyphen_alert.Input) async throws -> Operations.dependabot_sol_get_hyphen_alert.Output /// Update a Dependabot 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. - /// GitHub Apps must have **Dependabot alerts** write permission to use this endpoint. + /// The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." /// - /// To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/{alert_number}/patch(dependabot/update-alert)`. func dependabot_sol_update_hyphen_alert(_ input: Operations.dependabot_sol_update_hyphen_alert.Input) async throws -> Operations.dependabot_sol_update_hyphen_alert.Output /// List repository secrets /// - /// Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Lists all secrets available in a repository without revealing their encrypted + /// values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/get(dependabot/list-repo-secrets)`. func dependabot_sol_list_hyphen_repo_hyphen_secrets(_ input: Operations.dependabot_sol_list_hyphen_repo_hyphen_secrets.Input) async throws -> Operations.dependabot_sol_list_hyphen_repo_hyphen_secrets.Output /// Get a repository public key /// - /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Gets your public key, which you need to encrypt secrets. You need to + /// encrypt a secret before you can create or update secrets. Anyone with read access + /// to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets/public-key`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/public-key/get(dependabot/get-repo-public-key)`. func dependabot_sol_get_hyphen_repo_hyphen_public_hyphen_key(_ input: Operations.dependabot_sol_get_hyphen_repo_hyphen_public_hyphen_key.Input) async throws -> Operations.dependabot_sol_get_hyphen_repo_hyphen_public_hyphen_key.Output /// Get a repository secret /// - /// Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Gets a single repository secret without revealing its encrypted value. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/get(dependabot/get-repo-secret)`. @@ -157,16 +184,16 @@ public protocol APIProtocol: Sendable { /// Creates or updates a repository secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - /// permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/put(dependabot/create-or-update-repo-secret)`. func dependabot_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret(_ input: Operations.dependabot_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret.Input) async throws -> Operations.dependabot_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret.Output /// Delete a repository secret /// - /// Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Deletes a secret in a repository using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/delete(dependabot/delete-repo-secret)`. @@ -178,10 +205,13 @@ extension APIProtocol { /// List Dependabot alerts for an enterprise /// /// Lists Dependabot alerts for repositories that are owned by the specified enterprise. - /// To use this endpoint, you must be a member of the enterprise, and you must use an - /// access token with the `repo` scope or `security_events` scope. + /// + /// The authenticated user must be a member of the enterprise to use this endpoint. + /// /// Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, 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)." /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + /// /// - Remark: HTTP `GET /enterprises/{enterprise}/dependabot/alerts`. /// - Remark: Generated from `#/paths//enterprises/{enterprise}/dependabot/alerts/get(dependabot/list-alerts-for-enterprise)`. public func dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_enterprise( @@ -199,11 +229,9 @@ extension APIProtocol { /// /// Lists Dependabot alerts for an 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. - /// - /// For public repositories, you may instead use the `public_repo` scope. + /// The authenticated user must be an owner or security manager for the organization to use this endpoint. /// - /// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/alerts`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/alerts/get(dependabot/list-alerts-for-org)`. @@ -220,7 +248,10 @@ extension APIProtocol { } /// List organization secrets /// - /// Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Lists all secrets available in an organization without revealing their + /// encrypted values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/get(dependabot/list-org-secrets)`. @@ -237,7 +268,10 @@ extension APIProtocol { } /// Get an organization public key /// - /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Gets your public key, which you need to encrypt secrets. You need to + /// encrypt a secret before you can create or update secrets. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/public-key`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/public-key/get(dependabot/get-org-public-key)`. @@ -252,7 +286,9 @@ extension APIProtocol { } /// Get an organization secret /// - /// Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Gets a single organization secret without revealing its encrypted value. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/get(dependabot/get-org-secret)`. @@ -270,9 +306,7 @@ extension APIProtocol { /// Creates or updates an organization secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - /// permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/put(dependabot/create-or-update-org-secret)`. @@ -289,7 +323,9 @@ extension APIProtocol { } /// Delete an organization secret /// - /// Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Deletes a secret in an organization using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/delete(dependabot/delete-org-secret)`. @@ -298,7 +334,10 @@ extension APIProtocol { } /// List selected repositories for an organization secret /// - /// Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Lists all repositories that have been selected when the `visibility` + /// for repository access to a secret is set to `selected`. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/get(dependabot/list-selected-repos-for-org-secret)`. @@ -315,7 +354,11 @@ extension APIProtocol { } /// Set selected repositories for an organization secret /// - /// Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Replaces all repositories for an organization secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/put(dependabot/set-selected-repos-for-org-secret)`. @@ -330,7 +373,11 @@ extension APIProtocol { } /// Add selected repository to an organization secret /// - /// Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Adds a repository to an organization secret when the `visibility` for + /// repository access is set to `selected`. The visibility is set when you [Create or + /// update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}/put(dependabot/add-selected-repo-to-org-secret)`. @@ -339,7 +386,11 @@ extension APIProtocol { } /// Remove selected repository from an organization secret /// - /// Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Removes a repository from an organization secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}/delete(dependabot/remove-selected-repo-from-org-secret)`. @@ -348,9 +399,7 @@ extension APIProtocol { } /// List Dependabot alerts for a repository /// - /// 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. - /// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/alerts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/get(dependabot/list-alerts-for-repo)`. @@ -367,9 +416,7 @@ extension APIProtocol { } /// Get a Dependabot 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. - /// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/{alert_number}/get(dependabot/get-alert)`. @@ -384,11 +431,9 @@ extension APIProtocol { } /// Update a Dependabot 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. - /// GitHub Apps must have **Dependabot alerts** write permission to use this endpoint. + /// The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." /// - /// To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/{alert_number}/patch(dependabot/update-alert)`. @@ -405,7 +450,10 @@ extension APIProtocol { } /// List repository secrets /// - /// Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Lists all secrets available in a repository without revealing their encrypted + /// values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/get(dependabot/list-repo-secrets)`. @@ -422,7 +470,11 @@ extension APIProtocol { } /// Get a repository public key /// - /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Gets your public key, which you need to encrypt secrets. You need to + /// encrypt a secret before you can create or update secrets. Anyone with read access + /// to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets/public-key`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/public-key/get(dependabot/get-repo-public-key)`. @@ -437,7 +489,9 @@ extension APIProtocol { } /// Get a repository secret /// - /// Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Gets a single repository secret without revealing its encrypted value. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/get(dependabot/get-repo-secret)`. @@ -455,9 +509,7 @@ extension APIProtocol { /// Creates or updates a repository secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - /// permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/put(dependabot/create-or-update-repo-secret)`. @@ -474,7 +526,9 @@ extension APIProtocol { } /// Delete a repository secret /// - /// Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Deletes a secret in a repository using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/delete(dependabot/delete-repo-secret)`. @@ -3549,10 +3603,13 @@ public enum Operations { /// List Dependabot alerts for an enterprise /// /// Lists Dependabot alerts for repositories that are owned by the specified enterprise. - /// To use this endpoint, you must be a member of the enterprise, and you must use an - /// access token with the `repo` scope or `security_events` scope. + /// + /// The authenticated user must be a member of the enterprise to use this endpoint. + /// /// Alerts are only returned for organizations in the enterprise for which you are an organization owner or a security manager. For more information about security managers, 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)." /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. + /// /// - Remark: HTTP `GET /enterprises/{enterprise}/dependabot/alerts`. /// - Remark: Generated from `#/paths//enterprises/{enterprise}/dependabot/alerts/get(dependabot/list-alerts-for-enterprise)`. public enum dependabot_sol_list_hyphen_alerts_hyphen_for_hyphen_enterprise { @@ -3901,11 +3958,9 @@ public enum Operations { /// /// Lists Dependabot alerts for an 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. - /// - /// For public repositories, you may instead use the `public_repo` scope. + /// The authenticated user must be an owner or security manager for the organization to use this endpoint. /// - /// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/alerts`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/alerts/get(dependabot/list-alerts-for-org)`. @@ -4282,7 +4337,10 @@ public enum Operations { } /// List organization secrets /// - /// Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Lists all secrets available in an organization without revealing their + /// encrypted values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/get(dependabot/list-org-secrets)`. @@ -4483,7 +4541,10 @@ public enum Operations { } /// Get an organization public key /// - /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Gets your public key, which you need to encrypt secrets. You need to + /// encrypt a secret before you can create or update secrets. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/public-key`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/public-key/get(dependabot/get-org-public-key)`. @@ -4615,7 +4676,9 @@ public enum Operations { } /// Get an organization secret /// - /// Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Gets a single organization secret without revealing its encrypted value. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/get(dependabot/get-org-secret)`. @@ -4759,9 +4822,7 @@ public enum Operations { /// Creates or updates an organization secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization - /// permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/put(dependabot/create-or-update-org-secret)`. @@ -4989,7 +5050,9 @@ public enum Operations { } /// Delete an organization secret /// - /// Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Deletes a secret in an organization using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/delete(dependabot/delete-org-secret)`. @@ -5064,7 +5127,10 @@ public enum Operations { } /// List selected repositories for an organization secret /// - /// Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Lists all repositories that have been selected when the `visibility` + /// for repository access to a secret is set to `selected`. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/dependabot/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/get(dependabot/list-selected-repos-for-org-secret)`. @@ -5255,7 +5321,11 @@ public enum Operations { } /// Set selected repositories for an organization secret /// - /// Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Replaces all repositories for an organization secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/put(dependabot/set-selected-repos-for-org-secret)`. @@ -5358,7 +5428,11 @@ public enum Operations { } /// Add selected repository to an organization secret /// - /// Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Adds a repository to an organization secret when the `visibility` for + /// repository access is set to `selected`. The visibility is set when you [Create or + /// update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}/put(dependabot/add-selected-repo-to-org-secret)`. @@ -5465,7 +5539,11 @@ public enum Operations { } /// Remove selected repository from an organization secret /// - /// Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` organization permission to use this endpoint. + /// Removes a repository from an organization secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}/delete(dependabot/remove-selected-repo-from-org-secret)`. @@ -5572,9 +5650,7 @@ public enum Operations { } /// List Dependabot alerts for a repository /// - /// 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. - /// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/alerts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/get(dependabot/list-alerts-for-repo)`. @@ -5976,9 +6052,7 @@ public enum Operations { } /// Get a Dependabot 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. - /// GitHub Apps must have **Dependabot alerts** read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/{alert_number}/get(dependabot/get-alert)`. @@ -6198,11 +6272,9 @@ public enum Operations { } /// Update a Dependabot 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. - /// GitHub Apps must have **Dependabot alerts** write permission to use this endpoint. + /// The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." /// - /// To use this endpoint, you must have access to security alerts for the repository. For more information, see "[Granting access to security alerts](https://docs.github.com/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)." + /// OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/dependabot/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/alerts/{alert_number}/patch(dependabot/update-alert)`. @@ -6557,7 +6629,10 @@ public enum Operations { } /// List repository secrets /// - /// Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Lists all secrets available in a repository without revealing their encrypted + /// values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/get(dependabot/list-repo-secrets)`. @@ -6767,7 +6842,11 @@ public enum Operations { } /// Get a repository public key /// - /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Gets your public key, which you need to encrypt secrets. You need to + /// encrypt a secret before you can create or update secrets. Anyone with read access + /// to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the repository is private. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets/public-key`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/public-key/get(dependabot/get-repo-public-key)`. @@ -6908,7 +6987,9 @@ public enum Operations { } /// Get a repository secret /// - /// Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Gets a single repository secret without revealing its encrypted value. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/get(dependabot/get-repo-secret)`. @@ -7059,9 +7140,7 @@ public enum Operations { /// Creates or updates a repository secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository - /// permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/put(dependabot/create-or-update-repo-secret)`. @@ -7272,7 +7351,9 @@ public enum Operations { } /// Delete a repository secret /// - /// Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `dependabot_secrets` repository permission to use this endpoint. + /// Deletes a secret in a repository using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/dependabot/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependabot/secrets/{secret_name}/delete(dependabot/delete-repo-secret)`. From ed034c19aff7503a58c0e924f5a8c2cf05454bed Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:13:10 +0000 Subject: [PATCH 08/20] Commit via running ake Sources/dependency-graph --- Sources/dependency-graph/Client.swift | 6 +++++- Sources/dependency-graph/Types.swift | 18 +++++++++++++++--- 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/Sources/dependency-graph/Client.swift b/Sources/dependency-graph/Client.swift index 55b7a3565c..07f9372df0 100644 --- a/Sources/dependency-graph/Client.swift +++ b/Sources/dependency-graph/Client.swift @@ -282,7 +282,11 @@ public struct Client: APIProtocol { } /// Create a snapshot of dependencies for a repository /// - /// Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to. + /// Create a new snapshot of a repository's dependencies. + /// + /// The authenticated user must have access to the repository. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/dependency-graph/snapshots`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependency-graph/snapshots/post(dependency-graph/create-repository-snapshot)`. diff --git a/Sources/dependency-graph/Types.swift b/Sources/dependency-graph/Types.swift index 354ed63c87..2c08b9d356 100644 --- a/Sources/dependency-graph/Types.swift +++ b/Sources/dependency-graph/Types.swift @@ -27,7 +27,11 @@ public protocol APIProtocol: Sendable { func dependency_hyphen_graph_sol_export_hyphen_sbom(_ input: Operations.dependency_hyphen_graph_sol_export_hyphen_sbom.Input) async throws -> Operations.dependency_hyphen_graph_sol_export_hyphen_sbom.Output /// Create a snapshot of dependencies for a repository /// - /// Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to. + /// Create a new snapshot of a repository's dependencies. + /// + /// The authenticated user must have access to the repository. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/dependency-graph/snapshots`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependency-graph/snapshots/post(dependency-graph/create-repository-snapshot)`. @@ -70,7 +74,11 @@ extension APIProtocol { } /// Create a snapshot of dependencies for a repository /// - /// Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to. + /// Create a new snapshot of a repository's dependencies. + /// + /// The authenticated user must have access to the repository. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/dependency-graph/snapshots`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependency-graph/snapshots/post(dependency-graph/create-repository-snapshot)`. @@ -1590,7 +1598,11 @@ public enum Operations { } /// Create a snapshot of dependencies for a repository /// - /// Create a new snapshot of a repository's dependencies. You must authenticate using an access token with the `repo` scope to use this endpoint for a repository that the requesting user has access to. + /// Create a new snapshot of a repository's dependencies. + /// + /// The authenticated user must have access to the repository. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/dependency-graph/snapshots`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dependency-graph/snapshots/post(dependency-graph/create-repository-snapshot)`. From 98f3c5495b9e5026313503fe5da9fb48cb737ec4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:16:31 +0000 Subject: [PATCH 09/20] Commit via running ake Sources/oidc --- Sources/oidc/Client.swift | 8 ++++---- Sources/oidc/Types.swift | 24 ++++++++++++------------ 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/Sources/oidc/Client.swift b/Sources/oidc/Client.swift index e482446ca8..6fb85531d4 100644 --- a/Sources/oidc/Client.swift +++ b/Sources/oidc/Client.swift @@ -41,8 +41,8 @@ public struct Client: APIProtocol { /// Get the customization template for an OIDC subject claim for an organization /// /// Gets the customization template for an OpenID Connect (OIDC) subject claim. - /// You must authenticate using an access token with the `read:org` scope to use this endpoint. - /// GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/oidc/customization/sub/get(oidc/get-oidc-custom-sub-template-for-org)`. @@ -107,8 +107,8 @@ public struct Client: APIProtocol { /// Set the customization template for an OIDC subject claim for an organization /// /// Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - /// You must authenticate using an access token with the `write:org` scope to use this endpoint. - /// GitHub Apps must have the `admin:org` permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/oidc/customization/sub/put(oidc/update-oidc-custom-sub-template-for-org)`. diff --git a/Sources/oidc/Types.swift b/Sources/oidc/Types.swift index 0628f57486..fe0bab05c2 100644 --- a/Sources/oidc/Types.swift +++ b/Sources/oidc/Types.swift @@ -14,8 +14,8 @@ public protocol APIProtocol: Sendable { /// Get the customization template for an OIDC subject claim for an organization /// /// Gets the customization template for an OpenID Connect (OIDC) subject claim. - /// You must authenticate using an access token with the `read:org` scope to use this endpoint. - /// GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/oidc/customization/sub/get(oidc/get-oidc-custom-sub-template-for-org)`. @@ -23,8 +23,8 @@ public protocol APIProtocol: Sendable { /// Set the customization template for an OIDC subject claim for an organization /// /// Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - /// You must authenticate using an access token with the `write:org` scope to use this endpoint. - /// GitHub Apps must have the `admin:org` permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/oidc/customization/sub/put(oidc/update-oidc-custom-sub-template-for-org)`. @@ -36,8 +36,8 @@ extension APIProtocol { /// Get the customization template for an OIDC subject claim for an organization /// /// Gets the customization template for an OpenID Connect (OIDC) subject claim. - /// You must authenticate using an access token with the `read:org` scope to use this endpoint. - /// GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/oidc/customization/sub/get(oidc/get-oidc-custom-sub-template-for-org)`. @@ -53,8 +53,8 @@ extension APIProtocol { /// Set the customization template for an OIDC subject claim for an organization /// /// Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - /// You must authenticate using an access token with the `write:org` scope to use this endpoint. - /// GitHub Apps must have the `admin:org` permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/oidc/customization/sub/put(oidc/update-oidc-custom-sub-template-for-org)`. @@ -229,8 +229,8 @@ public enum Operations { /// Get the customization template for an OIDC subject claim for an organization /// /// Gets the customization template for an OpenID Connect (OIDC) subject claim. - /// You must authenticate using an access token with the `read:org` scope to use this endpoint. - /// GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/oidc/customization/sub/get(oidc/get-oidc-custom-sub-template-for-org)`. @@ -363,8 +363,8 @@ public enum Operations { /// Set the customization template for an OIDC subject claim for an organization /// /// Creates or updates the customization template for an OpenID Connect (OIDC) subject claim. - /// You must authenticate using an access token with the `write:org` scope to use this endpoint. - /// GitHub Apps must have the `admin:org` permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/actions/oidc/customization/sub`. /// - Remark: Generated from `#/paths//orgs/{org}/actions/oidc/customization/sub/put(oidc/update-oidc-custom-sub-template-for-org)`. From 0ac4986c2541ebd98b5aa58a466592bf6028b0be Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:16:52 +0000 Subject: [PATCH 10/20] Commit via running ake Sources/orgs --- Sources/orgs/Client.swift | 225 ++++++------ Sources/orgs/Types.swift | 700 ++++++++++++++++++-------------------- 2 files changed, 446 insertions(+), 479 deletions(-) diff --git a/Sources/orgs/Client.swift b/Sources/orgs/Client.swift index 80f7ecaca5..8f10f530c5 100644 --- a/Sources/orgs/Client.swift +++ b/Sources/orgs/Client.swift @@ -128,9 +128,15 @@ public struct Client: APIProtocol { } /// Get an organization /// - /// To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + /// Gets information about an organization. /// - /// GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + /// When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + /// + /// To see the full details about an organization, the authenticated user must be an organization owner. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + /// + /// To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. /// /// - Remark: HTTP `GET /orgs/{org}`. /// - Remark: Generated from `#/paths//orgs/{org}/get(orgs/get)`. @@ -218,7 +224,11 @@ public struct Client: APIProtocol { /// /// **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). /// - /// Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. + /// Updates the organization's profile and member privileges. + /// + /// The authenticated user must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /orgs/{org}`. /// - Remark: Generated from `#/paths//orgs/{org}/patch(orgs/update)`. @@ -1317,7 +1327,7 @@ public struct Client: APIProtocol { /// /// Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." /// - /// Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/get(orgs/get-webhook-config-for-org)`. @@ -1384,7 +1394,7 @@ public struct Client: APIProtocol { /// /// Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." /// - /// Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/patch(orgs/update-webhook-config-for-org)`. @@ -1904,7 +1914,12 @@ public struct Client: APIProtocol { } /// List app installations for an organization /// - /// Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. + /// Lists all GitHub Apps in an organization. The installation count includes + /// all GitHub Apps installed on repositories in the organization. + /// + /// The authenticated user must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/installations`. /// - Remark: Generated from `#/paths//orgs/{org}/installations/get(orgs/list-app-installations)`. @@ -3010,8 +3025,7 @@ public struct Client: APIProtocol { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-fine-grained-permissions`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-fine-grained-permissions/get(orgs/list-organization-fine-grained-permissions)`. @@ -3119,17 +3133,14 @@ public struct Client: APIProtocol { } /// Get all organization roles for an organization /// - /// Lists the organization roles available in this organization. + /// Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)`. @@ -3237,17 +3248,14 @@ public struct Client: APIProtocol { } /// Create a custom organization role /// - /// Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + /// Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - /// - /// For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/organization-roles`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/post(orgs/create-custom-organization-role)`. @@ -3386,12 +3394,11 @@ public struct Client: APIProtocol { } /// Remove all organization roles for a team /// - /// Removes all assigned organization roles from a team. + /// Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/delete(orgs/revoke-all-org-roles-team)`. @@ -3432,11 +3439,11 @@ public struct Client: APIProtocol { } /// Assign an organization role to a team /// - /// Assigns an organization role to a team in an organization. - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read-write permission to use this endpoint. + /// Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// The authenticated user must be an administrator for the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/{role_id}/put(orgs/assign-team-to-org-role)`. @@ -3482,12 +3489,11 @@ public struct Client: APIProtocol { } /// Remove an organization role from a team /// - /// Removes an organization role from a team. + /// Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/{role_id}/delete(orgs/revoke-org-role-team)`. @@ -3529,12 +3535,11 @@ public struct Client: APIProtocol { } /// Remove all organization roles for a user /// - /// Revokes all assigned organization roles from a user. + /// Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/users/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/delete(orgs/revoke-all-org-roles-user)`. @@ -3575,11 +3580,11 @@ public struct Client: APIProtocol { } /// Assign an organization role to a user /// - /// Assigns an organization role to a member of an organization. - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read-write permission to use this endpoint. + /// Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/organization-roles/users/{username}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/{role_id}/put(orgs/assign-user-to-org-role)`. @@ -3625,12 +3630,11 @@ public struct Client: APIProtocol { } /// Remove an organization role from a user /// - /// Remove an organization role from a user. + /// Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/users/{username}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/{role_id}/delete(orgs/revoke-org-role-user)`. @@ -3672,17 +3676,14 @@ public struct Client: APIProtocol { } /// Get an organization role /// - /// Gets an organization role that is available to this organization. + /// Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)`. @@ -3791,17 +3792,15 @@ public struct Client: APIProtocol { } /// Update a custom organization role /// - /// Updates an existing custom organization role. Permission changes will apply to all assignees. + /// Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - /// - /// For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/patch(orgs/patch-custom-organization-role)`. @@ -3941,17 +3940,14 @@ public struct Client: APIProtocol { } /// Delete a custom organization role. /// - /// Deletes a custom organization role. + /// Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - /// - /// For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/delete(orgs/delete-custom-organization-role)`. @@ -3992,12 +3988,11 @@ public struct Client: APIProtocol { } /// List teams that are assigned to an organization role /// - /// Lists the teams that are assigned to an organization role. + /// Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read permission to use this endpoint. + /// To use this endpoint, you must be an administrator for the organization. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}/teams`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/teams/get(orgs/list-org-role-teams)`. @@ -4088,12 +4083,11 @@ public struct Client: APIProtocol { } /// List users that are assigned to an organization role /// - /// Lists organization members that are assigned to an organization role. + /// Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read permission to use this endpoint. + /// To use this endpoint, you must be an administrator for the organization. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}/users`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/users/get(orgs/list-org-role-users)`. @@ -4446,10 +4440,9 @@ public struct Client: APIProtocol { } /// List requests to access organization resources with fine-grained personal access tokens /// - /// Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: read` permission. + /// Lists requests from organization members to access organization resources with a fine-grained personal access token. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-token-requests`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/get(orgs/list-pat-grant-requests)`. @@ -4672,10 +4665,9 @@ public struct Client: APIProtocol { } /// Review requests to access organization resources with fine-grained personal access tokens /// - /// Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: write` permission. + /// Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-token-requests`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/post(orgs/review-pat-grant-requests-in-bulk)`. @@ -4836,10 +4828,9 @@ public struct Client: APIProtocol { } /// Review a request to access organization resources with a fine-grained personal access token /// - /// Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: write` permission. + /// Approves or denies a pending request to access organization resources via a fine-grained personal access token. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-token-requests/{pat_request_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/{pat_request_id}/post(orgs/review-pat-grant-request)`. @@ -4981,10 +4972,9 @@ public struct Client: APIProtocol { } /// List repositories requested to be accessed by a fine-grained personal access token /// - /// Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: read` permission. + /// Lists the repositories a fine-grained personal access token request is requesting access to. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories/get(orgs/list-pat-grant-request-repositories)`. @@ -5137,10 +5127,9 @@ public struct Client: APIProtocol { } /// List fine-grained personal access tokens with access to organization resources /// - /// Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: read` permission. + /// Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-tokens`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/get(orgs/list-pat-grants)`. @@ -5363,10 +5352,9 @@ public struct Client: APIProtocol { } /// Update the access to organization resources via fine-grained personal access tokens /// - /// Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: write` permission. + /// Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-tokens`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/post(orgs/update-pat-accesses)`. @@ -5527,10 +5515,9 @@ public struct Client: APIProtocol { } /// Update the access a fine-grained personal access token has to organization resources /// - /// Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: write` permission. + /// Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-tokens/{pat_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/{pat_id}/post(orgs/update-pat-access)`. @@ -5672,10 +5659,9 @@ public struct Client: APIProtocol { } /// List repositories a fine-grained personal access token has access to /// - /// Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: read` permission. + /// Lists the repositories a fine-grained personal access token has access to. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/{pat_id}/repositories/get(orgs/list-pat-grant-repositories)`. @@ -5831,8 +5817,6 @@ public struct Client: APIProtocol { /// Gets all custom properties defined for an organization. /// Organization members can read these properties. /// - /// GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint. - /// /// - Remark: HTTP `GET /orgs/{org}/properties/schema`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/get(orgs/get-all-custom-properties)`. public func orgs_sol_get_hyphen_all_hyphen_custom_hyphen_properties(_ input: Operations.orgs_sol_get_hyphen_all_hyphen_custom_hyphen_properties.Input) async throws -> Operations.orgs_sol_get_hyphen_all_hyphen_custom_hyphen_properties.Output { @@ -5945,8 +5929,6 @@ public struct Client: APIProtocol { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint. - /// /// - Remark: HTTP `PATCH /orgs/{org}/properties/schema`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/patch(orgs/create-or-update-custom-properties)`. public func orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties(_ input: Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties.Input) async throws -> Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties.Output { @@ -6065,8 +6047,6 @@ public struct Client: APIProtocol { /// Gets a custom property that is defined for an organization. /// Organization members can read these properties. /// - /// GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint. - /// /// - Remark: HTTP `GET /orgs/{org}/properties/schema/{custom_property_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/{custom_property_name}/get(orgs/get-custom-property)`. public func orgs_sol_get_hyphen_custom_hyphen_property(_ input: Operations.orgs_sol_get_hyphen_custom_hyphen_property.Input) async throws -> Operations.orgs_sol_get_hyphen_custom_hyphen_property.Output { @@ -6180,8 +6160,6 @@ public struct Client: APIProtocol { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint. - /// /// - Remark: HTTP `PUT /orgs/{org}/properties/schema/{custom_property_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/{custom_property_name}/put(orgs/create-or-update-custom-property)`. public func orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_property(_ input: Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_property.Input) async throws -> Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_property.Output { @@ -6304,8 +6282,6 @@ public struct Client: APIProtocol { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint. - /// /// - Remark: HTTP `DELETE /orgs/{org}/properties/schema/{custom_property_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/{custom_property_name}/delete(orgs/remove-custom-property)`. public func orgs_sol_remove_hyphen_custom_hyphen_property(_ input: Operations.orgs_sol_remove_hyphen_custom_hyphen_property.Input) async throws -> Operations.orgs_sol_remove_hyphen_custom_hyphen_property.Output { @@ -6396,8 +6372,6 @@ public struct Client: APIProtocol { /// Lists organization repositories with all of their custom property values. /// Organization members can read these properties. /// - /// GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint. - /// /// - Remark: HTTP `GET /orgs/{org}/properties/values`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/values/get(orgs/list-custom-properties-values-for-repos)`. public func orgs_sol_list_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos(_ input: Operations.orgs_sol_list_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos.Input) async throws -> Operations.orgs_sol_list_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos.Output { @@ -6544,8 +6518,6 @@ public struct Client: APIProtocol { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:write` organization permission to use this endpoint. - /// /// - Remark: HTTP `PATCH /orgs/{org}/properties/values`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/values/patch(orgs/create-or-update-custom-properties-values-for-repos)`. public func orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos(_ input: Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos.Input) async throws -> Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos.Output { @@ -6627,6 +6599,28 @@ public struct Client: APIProtocol { preconditionFailure("bestContentType chose an invalid content type.") } return .notFound(.init(body: body)) + case 422: + let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) + let body: Components.Responses.validation_failed.Body + let chosenContentType = try converter.bestContentType( + received: contentType, + options: [ + "application/json" + ] + ) + switch chosenContentType { + case "application/json": + body = try await converter.getResponseBodyAsJSON( + Components.Schemas.validation_hyphen_error.self, + from: responseBody, + transforming: { value in + .json(value) + } + ) + default: + preconditionFailure("bestContentType chose an invalid content type.") + } + return .unprocessableContent(.init(body: body)) default: return .undocumented( statusCode: response.status.code, @@ -6882,9 +6876,9 @@ public struct Client: APIProtocol { /// /// Lists teams that are security managers for an organization. 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 administrator or security manager for the organization, and you must use an access token with the `read:org` scope. + /// The authenticated user must be an administrator or security manager for the organization to use this endpoint. /// - /// GitHub Apps must have the `administration` organization read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/security-managers`. /// - Remark: Generated from `#/paths//orgs/{org}/security-managers/get(orgs/list-security-manager-teams)`. @@ -6950,9 +6944,9 @@ public struct Client: APIProtocol { /// /// Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/security-managers/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/security-managers/teams/{team_slug}/put(orgs/add-security-manager-team)`. @@ -6997,9 +6991,9 @@ public struct Client: APIProtocol { /// /// Removes the security manager role from a team for an organization. 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) team from an organization." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/security-managers/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/security-managers/teams/{team_slug}/delete(orgs/remove-security-manager-team)`. @@ -7040,14 +7034,11 @@ public struct Client: APIProtocol { } /// Enable or disable a security feature for an organization /// - /// Enables or disables the specified security feature for all eligible repositories in an organization. + /// Enables or disables the specified security feature for all eligible repositories in an organization. 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 organization owner or be member of a team with the security manager role. - /// A token with the 'write:org' scope is also required. + /// The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. /// - /// GitHub Apps must have the `organization_administration:write` permission to use this endpoint. - /// - /// 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)." + /// OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/{security_product}/{enablement}`. /// - Remark: Generated from `#/paths//orgs/{org}/{security_product}/{enablement}/post(orgs/enable-or-disable-security-product-on-all-org-repos)`. @@ -7510,9 +7501,7 @@ public struct Client: APIProtocol { /// /// List organizations for the authenticated user. /// - /// **OAuth scope requirements** - /// - /// This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + /// For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. /// /// - Remark: HTTP `GET /user/orgs`. /// - Remark: Generated from `#/paths//user/orgs/get(orgs/list-for-authenticated-user)`. diff --git a/Sources/orgs/Types.swift b/Sources/orgs/Types.swift index 9076650ee3..51c9bf8b06 100644 --- a/Sources/orgs/Types.swift +++ b/Sources/orgs/Types.swift @@ -22,9 +22,15 @@ public protocol APIProtocol: Sendable { func orgs_sol_list(_ input: Operations.orgs_sol_list.Input) async throws -> Operations.orgs_sol_list.Output /// Get an organization /// - /// To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + /// Gets information about an organization. /// - /// GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + /// When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + /// + /// To see the full details about an organization, the authenticated user must be an organization owner. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + /// + /// To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. /// /// - Remark: HTTP `GET /orgs/{org}`. /// - Remark: Generated from `#/paths//orgs/{org}/get(orgs/get)`. @@ -33,7 +39,11 @@ public protocol APIProtocol: Sendable { /// /// **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). /// - /// Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. + /// Updates the organization's profile and member privileges. + /// + /// The authenticated user must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /orgs/{org}`. /// - Remark: Generated from `#/paths//orgs/{org}/patch(orgs/update)`. @@ -121,7 +131,7 @@ public protocol APIProtocol: Sendable { /// /// Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." /// - /// Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/get(orgs/get-webhook-config-for-org)`. @@ -130,7 +140,7 @@ public protocol APIProtocol: Sendable { /// /// Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." /// - /// Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/patch(orgs/update-webhook-config-for-org)`. @@ -165,7 +175,12 @@ public protocol APIProtocol: Sendable { func orgs_sol_ping_hyphen_webhook(_ input: Operations.orgs_sol_ping_hyphen_webhook.Input) async throws -> Operations.orgs_sol_ping_hyphen_webhook.Output /// List app installations for an organization /// - /// Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. + /// Lists all GitHub Apps in an organization. The installation count includes + /// all GitHub Apps installed on repositories in the organization. + /// + /// The authenticated user must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/installations`. /// - Remark: Generated from `#/paths//orgs/{org}/installations/get(orgs/list-app-installations)`. @@ -266,187 +281,166 @@ public protocol APIProtocol: Sendable { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-fine-grained-permissions`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-fine-grained-permissions/get(orgs/list-organization-fine-grained-permissions)`. func orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions(_ input: Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Input) async throws -> Operations.orgs_sol_list_hyphen_organization_hyphen_fine_hyphen_grained_hyphen_permissions.Output /// Get all organization roles for an organization /// - /// Lists the organization roles available in this organization. + /// Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)`. func orgs_sol_list_hyphen_org_hyphen_roles(_ input: Operations.orgs_sol_list_hyphen_org_hyphen_roles.Input) async throws -> Operations.orgs_sol_list_hyphen_org_hyphen_roles.Output /// Create a custom organization role /// - /// Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + /// Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - /// - /// For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/organization-roles`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/post(orgs/create-custom-organization-role)`. func orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role(_ input: Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Input) async throws -> Operations.orgs_sol_create_hyphen_custom_hyphen_organization_hyphen_role.Output /// Remove all organization roles for a team /// - /// Removes all assigned organization roles from a team. + /// Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/delete(orgs/revoke-all-org-roles-team)`. func orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_team(_ input: Operations.orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_team.Input) async throws -> Operations.orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_team.Output /// Assign an organization role to a team /// - /// Assigns an organization role to a team in an organization. - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read-write permission to use this endpoint. + /// Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/{role_id}/put(orgs/assign-team-to-org-role)`. func orgs_sol_assign_hyphen_team_hyphen_to_hyphen_org_hyphen_role(_ input: Operations.orgs_sol_assign_hyphen_team_hyphen_to_hyphen_org_hyphen_role.Input) async throws -> Operations.orgs_sol_assign_hyphen_team_hyphen_to_hyphen_org_hyphen_role.Output /// Remove an organization role from a team /// - /// Removes an organization role from a team. + /// Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/{role_id}/delete(orgs/revoke-org-role-team)`. func orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_team(_ input: Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_team.Input) async throws -> Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_team.Output /// Remove all organization roles for a user /// - /// Revokes all assigned organization roles from a user. + /// Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/users/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/delete(orgs/revoke-all-org-roles-user)`. func orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_user(_ input: Operations.orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_user.Input) async throws -> Operations.orgs_sol_revoke_hyphen_all_hyphen_org_hyphen_roles_hyphen_user.Output /// Assign an organization role to a user /// - /// Assigns an organization role to a member of an organization. - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read-write permission to use this endpoint. + /// Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// The authenticated user must be an administrator for the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/organization-roles/users/{username}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/{role_id}/put(orgs/assign-user-to-org-role)`. func orgs_sol_assign_hyphen_user_hyphen_to_hyphen_org_hyphen_role(_ input: Operations.orgs_sol_assign_hyphen_user_hyphen_to_hyphen_org_hyphen_role.Input) async throws -> Operations.orgs_sol_assign_hyphen_user_hyphen_to_hyphen_org_hyphen_role.Output /// Remove an organization role from a user /// - /// Remove an organization role from a user. + /// Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/users/{username}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/{role_id}/delete(orgs/revoke-org-role-user)`. func orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user(_ input: Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user.Input) async throws -> Operations.orgs_sol_revoke_hyphen_org_hyphen_role_hyphen_user.Output /// Get an organization role /// - /// Gets an organization role that is available to this organization. + /// Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)`. func orgs_sol_get_hyphen_org_hyphen_role(_ input: Operations.orgs_sol_get_hyphen_org_hyphen_role.Input) async throws -> Operations.orgs_sol_get_hyphen_org_hyphen_role.Output /// Update a custom organization role /// - /// Updates an existing custom organization role. Permission changes will apply to all assignees. + /// Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - /// - /// For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/patch(orgs/patch-custom-organization-role)`. func orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role(_ input: Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Input) async throws -> Operations.orgs_sol_patch_hyphen_custom_hyphen_organization_hyphen_role.Output /// Delete a custom organization role. /// - /// Deletes a custom organization role. + /// Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - /// - /// For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/delete(orgs/delete-custom-organization-role)`. func orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role(_ input: Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Input) async throws -> Operations.orgs_sol_delete_hyphen_custom_hyphen_organization_hyphen_role.Output /// List teams that are assigned to an organization role /// - /// Lists the teams that are assigned to an organization role. + /// Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read permission to use this endpoint. + /// To use this endpoint, you must be an administrator for the organization. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}/teams`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/teams/get(orgs/list-org-role-teams)`. func orgs_sol_list_hyphen_org_hyphen_role_hyphen_teams(_ input: Operations.orgs_sol_list_hyphen_org_hyphen_role_hyphen_teams.Input) async throws -> Operations.orgs_sol_list_hyphen_org_hyphen_role_hyphen_teams.Output /// List users that are assigned to an organization role /// - /// Lists organization members that are assigned to an organization role. + /// Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read permission to use this endpoint. + /// To use this endpoint, you must be an administrator for the organization. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}/users`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/users/get(orgs/list-org-role-users)`. @@ -474,80 +468,72 @@ public protocol APIProtocol: Sendable { func orgs_sol_remove_hyphen_outside_hyphen_collaborator(_ input: Operations.orgs_sol_remove_hyphen_outside_hyphen_collaborator.Input) async throws -> Operations.orgs_sol_remove_hyphen_outside_hyphen_collaborator.Output /// List requests to access organization resources with fine-grained personal access tokens /// - /// Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: read` permission. + /// Lists requests from organization members to access organization resources with a fine-grained personal access token. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-token-requests`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/get(orgs/list-pat-grant-requests)`. func orgs_sol_list_hyphen_pat_hyphen_grant_hyphen_requests(_ input: Operations.orgs_sol_list_hyphen_pat_hyphen_grant_hyphen_requests.Input) async throws -> Operations.orgs_sol_list_hyphen_pat_hyphen_grant_hyphen_requests.Output /// Review requests to access organization resources with fine-grained personal access tokens /// - /// Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: write` permission. + /// Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-token-requests`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/post(orgs/review-pat-grant-requests-in-bulk)`. func orgs_sol_review_hyphen_pat_hyphen_grant_hyphen_requests_hyphen_in_hyphen_bulk(_ input: Operations.orgs_sol_review_hyphen_pat_hyphen_grant_hyphen_requests_hyphen_in_hyphen_bulk.Input) async throws -> Operations.orgs_sol_review_hyphen_pat_hyphen_grant_hyphen_requests_hyphen_in_hyphen_bulk.Output /// Review a request to access organization resources with a fine-grained personal access token /// - /// Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: write` permission. + /// Approves or denies a pending request to access organization resources via a fine-grained personal access token. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-token-requests/{pat_request_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/{pat_request_id}/post(orgs/review-pat-grant-request)`. func orgs_sol_review_hyphen_pat_hyphen_grant_hyphen_request(_ input: Operations.orgs_sol_review_hyphen_pat_hyphen_grant_hyphen_request.Input) async throws -> Operations.orgs_sol_review_hyphen_pat_hyphen_grant_hyphen_request.Output /// List repositories requested to be accessed by a fine-grained personal access token /// - /// Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: read` permission. + /// Lists the repositories a fine-grained personal access token request is requesting access to. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories/get(orgs/list-pat-grant-request-repositories)`. func orgs_sol_list_hyphen_pat_hyphen_grant_hyphen_request_hyphen_repositories(_ input: Operations.orgs_sol_list_hyphen_pat_hyphen_grant_hyphen_request_hyphen_repositories.Input) async throws -> Operations.orgs_sol_list_hyphen_pat_hyphen_grant_hyphen_request_hyphen_repositories.Output /// List fine-grained personal access tokens with access to organization resources /// - /// Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: read` permission. + /// Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-tokens`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/get(orgs/list-pat-grants)`. func orgs_sol_list_hyphen_pat_hyphen_grants(_ input: Operations.orgs_sol_list_hyphen_pat_hyphen_grants.Input) async throws -> Operations.orgs_sol_list_hyphen_pat_hyphen_grants.Output /// Update the access to organization resources via fine-grained personal access tokens /// - /// Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: write` permission. + /// Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-tokens`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/post(orgs/update-pat-accesses)`. func orgs_sol_update_hyphen_pat_hyphen_accesses(_ input: Operations.orgs_sol_update_hyphen_pat_hyphen_accesses.Input) async throws -> Operations.orgs_sol_update_hyphen_pat_hyphen_accesses.Output /// Update the access a fine-grained personal access token has to organization resources /// - /// Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: write` permission. + /// Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-tokens/{pat_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/{pat_id}/post(orgs/update-pat-access)`. func orgs_sol_update_hyphen_pat_hyphen_access(_ input: Operations.orgs_sol_update_hyphen_pat_hyphen_access.Input) async throws -> Operations.orgs_sol_update_hyphen_pat_hyphen_access.Output /// List repositories a fine-grained personal access token has access to /// - /// Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: read` permission. + /// Lists the repositories a fine-grained personal access token has access to. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/{pat_id}/repositories/get(orgs/list-pat-grant-repositories)`. @@ -557,8 +543,6 @@ public protocol APIProtocol: Sendable { /// Gets all custom properties defined for an organization. /// Organization members can read these properties. /// - /// GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint. - /// /// - Remark: HTTP `GET /orgs/{org}/properties/schema`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/get(orgs/get-all-custom-properties)`. func orgs_sol_get_hyphen_all_hyphen_custom_hyphen_properties(_ input: Operations.orgs_sol_get_hyphen_all_hyphen_custom_hyphen_properties.Input) async throws -> Operations.orgs_sol_get_hyphen_all_hyphen_custom_hyphen_properties.Output @@ -570,8 +554,6 @@ public protocol APIProtocol: Sendable { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint. - /// /// - Remark: HTTP `PATCH /orgs/{org}/properties/schema`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/patch(orgs/create-or-update-custom-properties)`. func orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties(_ input: Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties.Input) async throws -> Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties.Output @@ -580,8 +562,6 @@ public protocol APIProtocol: Sendable { /// Gets a custom property that is defined for an organization. /// Organization members can read these properties. /// - /// GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint. - /// /// - Remark: HTTP `GET /orgs/{org}/properties/schema/{custom_property_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/{custom_property_name}/get(orgs/get-custom-property)`. func orgs_sol_get_hyphen_custom_hyphen_property(_ input: Operations.orgs_sol_get_hyphen_custom_hyphen_property.Input) async throws -> Operations.orgs_sol_get_hyphen_custom_hyphen_property.Output @@ -593,8 +573,6 @@ public protocol APIProtocol: Sendable { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint. - /// /// - Remark: HTTP `PUT /orgs/{org}/properties/schema/{custom_property_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/{custom_property_name}/put(orgs/create-or-update-custom-property)`. func orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_property(_ input: Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_property.Input) async throws -> Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_property.Output @@ -606,8 +584,6 @@ public protocol APIProtocol: Sendable { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint. - /// /// - Remark: HTTP `DELETE /orgs/{org}/properties/schema/{custom_property_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/{custom_property_name}/delete(orgs/remove-custom-property)`. func orgs_sol_remove_hyphen_custom_hyphen_property(_ input: Operations.orgs_sol_remove_hyphen_custom_hyphen_property.Input) async throws -> Operations.orgs_sol_remove_hyphen_custom_hyphen_property.Output @@ -616,8 +592,6 @@ public protocol APIProtocol: Sendable { /// Lists organization repositories with all of their custom property values. /// Organization members can read these properties. /// - /// GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint. - /// /// - Remark: HTTP `GET /orgs/{org}/properties/values`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/values/get(orgs/list-custom-properties-values-for-repos)`. func orgs_sol_list_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos(_ input: Operations.orgs_sol_list_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos.Input) async throws -> Operations.orgs_sol_list_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos.Output @@ -634,8 +608,6 @@ public protocol APIProtocol: Sendable { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:write` organization permission to use this endpoint. - /// /// - Remark: HTTP `PATCH /orgs/{org}/properties/values`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/values/patch(orgs/create-or-update-custom-properties-values-for-repos)`. func orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos(_ input: Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos.Input) async throws -> Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos.Output @@ -673,9 +645,9 @@ public protocol APIProtocol: Sendable { /// /// Lists teams that are security managers for an organization. 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 administrator or security manager for the organization, and you must use an access token with the `read:org` scope. + /// The authenticated user must be an administrator or security manager for the organization to use this endpoint. /// - /// GitHub Apps must have the `administration` organization read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/security-managers`. /// - Remark: Generated from `#/paths//orgs/{org}/security-managers/get(orgs/list-security-manager-teams)`. @@ -684,9 +656,9 @@ public protocol APIProtocol: Sendable { /// /// Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/security-managers/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/security-managers/teams/{team_slug}/put(orgs/add-security-manager-team)`. @@ -695,23 +667,20 @@ public protocol APIProtocol: Sendable { /// /// Removes the security manager role from a team for an organization. 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) team from an organization." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/security-managers/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/security-managers/teams/{team_slug}/delete(orgs/remove-security-manager-team)`. func orgs_sol_remove_hyphen_security_hyphen_manager_hyphen_team(_ input: Operations.orgs_sol_remove_hyphen_security_hyphen_manager_hyphen_team.Input) async throws -> Operations.orgs_sol_remove_hyphen_security_hyphen_manager_hyphen_team.Output /// Enable or disable a security feature for an organization /// - /// Enables or disables the specified security feature for all eligible repositories in an organization. - /// - /// To use this endpoint, you must be an organization owner or be member of a team with the security manager role. - /// A token with the 'write:org' scope is also required. + /// Enables or disables the specified security feature for all eligible repositories in an organization. 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)." /// - /// GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + /// The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. /// - /// 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)." + /// OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/{security_product}/{enablement}`. /// - Remark: Generated from `#/paths//orgs/{org}/{security_product}/{enablement}/post(orgs/enable-or-disable-security-product-on-all-org-repos)`. @@ -741,9 +710,7 @@ public protocol APIProtocol: Sendable { /// /// List organizations for the authenticated user. /// - /// **OAuth scope requirements** - /// - /// This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + /// For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. /// /// - Remark: HTTP `GET /user/orgs`. /// - Remark: Generated from `#/paths//user/orgs/get(orgs/list-for-authenticated-user)`. @@ -780,9 +747,15 @@ extension APIProtocol { } /// Get an organization /// - /// To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + /// Gets information about an organization. + /// + /// When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + /// + /// To see the full details about an organization, the authenticated user must be an organization owner. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. /// - /// GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + /// To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. /// /// - Remark: HTTP `GET /orgs/{org}`. /// - Remark: Generated from `#/paths//orgs/{org}/get(orgs/get)`. @@ -799,7 +772,11 @@ extension APIProtocol { /// /// **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). /// - /// Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. + /// Updates the organization's profile and member privileges. + /// + /// The authenticated user must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /orgs/{org}`. /// - Remark: Generated from `#/paths//orgs/{org}/patch(orgs/update)`. @@ -989,7 +966,7 @@ extension APIProtocol { /// /// Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." /// - /// Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/get(orgs/get-webhook-config-for-org)`. @@ -1006,7 +983,7 @@ extension APIProtocol { /// /// Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." /// - /// Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/patch(orgs/update-webhook-config-for-org)`. @@ -1085,7 +1062,12 @@ extension APIProtocol { } /// List app installations for an organization /// - /// Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. + /// Lists all GitHub Apps in an organization. The installation count includes + /// all GitHub Apps installed on repositories in the organization. + /// + /// The authenticated user must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/installations`. /// - Remark: Generated from `#/paths//orgs/{org}/installations/get(orgs/list-app-installations)`. @@ -1280,8 +1262,7 @@ extension APIProtocol { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-fine-grained-permissions`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-fine-grained-permissions/get(orgs/list-organization-fine-grained-permissions)`. @@ -1296,17 +1277,14 @@ extension APIProtocol { } /// Get all organization roles for an organization /// - /// Lists the organization roles available in this organization. + /// Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)`. @@ -1321,17 +1299,14 @@ extension APIProtocol { } /// Create a custom organization role /// - /// Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + /// Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - /// - /// For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/organization-roles`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/post(orgs/create-custom-organization-role)`. @@ -1348,12 +1323,11 @@ extension APIProtocol { } /// Remove all organization roles for a team /// - /// Removes all assigned organization roles from a team. + /// Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/delete(orgs/revoke-all-org-roles-team)`. @@ -1362,11 +1336,11 @@ extension APIProtocol { } /// Assign an organization role to a team /// - /// Assigns an organization role to a team in an organization. - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read-write permission to use this endpoint. + /// Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/{role_id}/put(orgs/assign-team-to-org-role)`. @@ -1375,12 +1349,11 @@ extension APIProtocol { } /// Remove an organization role from a team /// - /// Removes an organization role from a team. + /// Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/{role_id}/delete(orgs/revoke-org-role-team)`. @@ -1389,12 +1362,11 @@ extension APIProtocol { } /// Remove all organization roles for a user /// - /// Revokes all assigned organization roles from a user. + /// Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/users/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/delete(orgs/revoke-all-org-roles-user)`. @@ -1403,11 +1375,11 @@ extension APIProtocol { } /// Assign an organization role to a user /// - /// Assigns an organization role to a member of an organization. - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read-write permission to use this endpoint. + /// Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// The authenticated user must be an administrator for the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/organization-roles/users/{username}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/{role_id}/put(orgs/assign-user-to-org-role)`. @@ -1416,12 +1388,11 @@ extension APIProtocol { } /// Remove an organization role from a user /// - /// Remove an organization role from a user. + /// Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/users/{username}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/{role_id}/delete(orgs/revoke-org-role-user)`. @@ -1430,17 +1401,14 @@ extension APIProtocol { } /// Get an organization role /// - /// Gets an organization role that is available to this organization. + /// Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)`. @@ -1455,17 +1423,15 @@ extension APIProtocol { } /// Update a custom organization role /// - /// Updates an existing custom organization role. Permission changes will apply to all assignees. + /// Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - /// - /// For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/patch(orgs/patch-custom-organization-role)`. @@ -1482,17 +1448,14 @@ extension APIProtocol { } /// Delete a custom organization role. /// - /// Deletes a custom organization role. + /// Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - /// - /// For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/delete(orgs/delete-custom-organization-role)`. @@ -1501,12 +1464,11 @@ extension APIProtocol { } /// List teams that are assigned to an organization role /// - /// Lists the teams that are assigned to an organization role. + /// Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read permission to use this endpoint. + /// To use this endpoint, you must be an administrator for the organization. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}/teams`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/teams/get(orgs/list-org-role-teams)`. @@ -1523,12 +1485,11 @@ extension APIProtocol { } /// List users that are assigned to an organization role /// - /// Lists organization members that are assigned to an organization role. + /// Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read permission to use this endpoint. + /// To use this endpoint, you must be an administrator for the organization. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}/users`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/users/get(orgs/list-org-role-users)`. @@ -1594,10 +1555,9 @@ extension APIProtocol { } /// List requests to access organization resources with fine-grained personal access tokens /// - /// Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: read` permission. + /// Lists requests from organization members to access organization resources with a fine-grained personal access token. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-token-requests`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/get(orgs/list-pat-grant-requests)`. @@ -1614,10 +1574,9 @@ extension APIProtocol { } /// Review requests to access organization resources with fine-grained personal access tokens /// - /// Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: write` permission. + /// Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-token-requests`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/post(orgs/review-pat-grant-requests-in-bulk)`. @@ -1634,10 +1593,9 @@ extension APIProtocol { } /// Review a request to access organization resources with a fine-grained personal access token /// - /// Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: write` permission. + /// Approves or denies a pending request to access organization resources via a fine-grained personal access token. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-token-requests/{pat_request_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/{pat_request_id}/post(orgs/review-pat-grant-request)`. @@ -1654,10 +1612,9 @@ extension APIProtocol { } /// List repositories requested to be accessed by a fine-grained personal access token /// - /// Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: read` permission. + /// Lists the repositories a fine-grained personal access token request is requesting access to. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories/get(orgs/list-pat-grant-request-repositories)`. @@ -1674,10 +1631,9 @@ extension APIProtocol { } /// List fine-grained personal access tokens with access to organization resources /// - /// Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: read` permission. + /// Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-tokens`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/get(orgs/list-pat-grants)`. @@ -1694,10 +1650,9 @@ extension APIProtocol { } /// Update the access to organization resources via fine-grained personal access tokens /// - /// Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: write` permission. + /// Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-tokens`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/post(orgs/update-pat-accesses)`. @@ -1714,10 +1669,9 @@ extension APIProtocol { } /// Update the access a fine-grained personal access token has to organization resources /// - /// Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: write` permission. + /// Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-tokens/{pat_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/{pat_id}/post(orgs/update-pat-access)`. @@ -1734,10 +1688,9 @@ extension APIProtocol { } /// List repositories a fine-grained personal access token has access to /// - /// Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: read` permission. + /// Lists the repositories a fine-grained personal access token has access to. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/{pat_id}/repositories/get(orgs/list-pat-grant-repositories)`. @@ -1757,8 +1710,6 @@ extension APIProtocol { /// Gets all custom properties defined for an organization. /// Organization members can read these properties. /// - /// GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint. - /// /// - Remark: HTTP `GET /orgs/{org}/properties/schema`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/get(orgs/get-all-custom-properties)`. public func orgs_sol_get_hyphen_all_hyphen_custom_hyphen_properties( @@ -1778,8 +1729,6 @@ extension APIProtocol { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint. - /// /// - Remark: HTTP `PATCH /orgs/{org}/properties/schema`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/patch(orgs/create-or-update-custom-properties)`. public func orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties( @@ -1798,8 +1747,6 @@ extension APIProtocol { /// Gets a custom property that is defined for an organization. /// Organization members can read these properties. /// - /// GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint. - /// /// - Remark: HTTP `GET /orgs/{org}/properties/schema/{custom_property_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/{custom_property_name}/get(orgs/get-custom-property)`. public func orgs_sol_get_hyphen_custom_hyphen_property( @@ -1819,8 +1766,6 @@ extension APIProtocol { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint. - /// /// - Remark: HTTP `PUT /orgs/{org}/properties/schema/{custom_property_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/{custom_property_name}/put(orgs/create-or-update-custom-property)`. public func orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_property( @@ -1842,8 +1787,6 @@ extension APIProtocol { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint. - /// /// - Remark: HTTP `DELETE /orgs/{org}/properties/schema/{custom_property_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/{custom_property_name}/delete(orgs/remove-custom-property)`. public func orgs_sol_remove_hyphen_custom_hyphen_property( @@ -1860,8 +1803,6 @@ extension APIProtocol { /// Lists organization repositories with all of their custom property values. /// Organization members can read these properties. /// - /// GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint. - /// /// - Remark: HTTP `GET /orgs/{org}/properties/values`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/values/get(orgs/list-custom-properties-values-for-repos)`. public func orgs_sol_list_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos( @@ -1888,8 +1829,6 @@ extension APIProtocol { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:write` organization permission to use this endpoint. - /// /// - Remark: HTTP `PATCH /orgs/{org}/properties/values`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/values/patch(orgs/create-or-update-custom-properties-values-for-repos)`. public func orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos( @@ -1959,9 +1898,9 @@ extension APIProtocol { /// /// Lists teams that are security managers for an organization. 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 administrator or security manager for the organization, and you must use an access token with the `read:org` scope. + /// The authenticated user must be an administrator or security manager for the organization to use this endpoint. /// - /// GitHub Apps must have the `administration` organization read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/security-managers`. /// - Remark: Generated from `#/paths//orgs/{org}/security-managers/get(orgs/list-security-manager-teams)`. @@ -1978,9 +1917,9 @@ extension APIProtocol { /// /// Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/security-managers/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/security-managers/teams/{team_slug}/put(orgs/add-security-manager-team)`. @@ -1991,9 +1930,9 @@ extension APIProtocol { /// /// Removes the security manager role from a team for an organization. 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) team from an organization." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/security-managers/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/security-managers/teams/{team_slug}/delete(orgs/remove-security-manager-team)`. @@ -2002,14 +1941,11 @@ extension APIProtocol { } /// Enable or disable a security feature for an organization /// - /// Enables or disables the specified security feature for all eligible repositories in an organization. - /// - /// To use this endpoint, you must be an organization owner or be member of a team with the security manager role. - /// A token with the 'write:org' scope is also required. + /// Enables or disables the specified security feature for all eligible repositories in an organization. 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)." /// - /// GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + /// The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. /// - /// 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)." + /// OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/{security_product}/{enablement}`. /// - Remark: Generated from `#/paths//orgs/{org}/{security_product}/{enablement}/post(orgs/enable-or-disable-security-product-on-all-org-repos)`. @@ -2073,9 +2009,7 @@ extension APIProtocol { /// /// List organizations for the authenticated user. /// - /// **OAuth scope requirements** - /// - /// This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + /// For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. /// /// - Remark: HTTP `GET /user/orgs`. /// - Remark: Generated from `#/paths//user/orgs/get(orgs/list-for-authenticated-user)`. @@ -6385,10 +6319,22 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/org-custom-property/description`. public var description: Swift.String? - /// Ordered list of allowed values of the property + /// An ordered list of the allowed values of the property. + /// The property can have up to 200 allowed values. /// /// - Remark: Generated from `#/components/schemas/org-custom-property/allowed_values`. public var allowed_values: [Swift.String]? + /// Who can edit the values of the property + /// + /// - Remark: Generated from `#/components/schemas/org-custom-property/values_editable_by`. + @frozen public enum values_editable_byPayload: String, Codable, Hashable, Sendable { + case org_actors = "org_actors" + case org_and_repo_actors = "org_and_repo_actors" + } + /// Who can edit the values of the property + /// + /// - Remark: Generated from `#/components/schemas/org-custom-property/values_editable_by`. + public var values_editable_by: Components.Schemas.org_hyphen_custom_hyphen_property.values_editable_byPayload? /// Creates a new `org_hyphen_custom_hyphen_property`. /// /// - Parameters: @@ -6397,14 +6343,16 @@ public enum Components { /// - required: Whether the property is required. /// - default_value: Default value of the property /// - description: Short description of the property - /// - allowed_values: Ordered list of allowed values of the property + /// - allowed_values: An ordered list of the allowed values of the property. + /// - values_editable_by: Who can edit the values of the property public init( property_name: Swift.String, value_type: Components.Schemas.org_hyphen_custom_hyphen_property.value_typePayload, required: Swift.Bool? = nil, default_value: Swift.String? = nil, description: Swift.String? = nil, - allowed_values: [Swift.String]? = nil + allowed_values: [Swift.String]? = nil, + values_editable_by: Components.Schemas.org_hyphen_custom_hyphen_property.values_editable_byPayload? = nil ) { self.property_name = property_name self.value_type = value_type @@ -6412,6 +6360,7 @@ public enum Components { self.default_value = default_value self.description = description self.allowed_values = allowed_values + self.values_editable_by = values_editable_by } public enum CodingKeys: String, CodingKey { case property_name @@ -6420,6 +6369,7 @@ public enum Components { case default_value case description case allowed_values + case values_editable_by } } /// Custom property name and associated value @@ -6433,7 +6383,44 @@ public enum Components { /// The value assigned to the property /// /// - Remark: Generated from `#/components/schemas/custom-property-value/value`. - public var value: Swift.String? + @frozen public enum valuePayload: Codable, Hashable, Sendable { + /// - Remark: Generated from `#/components/schemas/custom-property-value/value/case1`. + case case1(Swift.String) + /// - Remark: Generated from `#/components/schemas/custom-property-value/value/case2`. + case case2([Swift.String]) + public init(from decoder: any Decoder) throws { + var errors: [any Error] = [] + do { + self = .case1(try decoder.decodeFromSingleValueContainer()) + return + } catch { + errors.append(error) + } + do { + self = .case2(try decoder.decodeFromSingleValueContainer()) + return + } catch { + errors.append(error) + } + throw Swift.DecodingError.failedToDecodeOneOfSchema( + type: Self.self, + codingPath: decoder.codingPath, + errors: errors + ) + } + public func encode(to encoder: any Encoder) throws { + switch self { + case let .case1(value): + try encoder.encodeToSingleValueContainer(value) + case let .case2(value): + try encoder.encodeToSingleValueContainer(value) + } + } + } + /// The value assigned to the property + /// + /// - Remark: Generated from `#/components/schemas/custom-property-value/value`. + public var value: Components.Schemas.custom_hyphen_property_hyphen_value.valuePayload? /// Creates a new `custom_hyphen_property_hyphen_value`. /// /// - Parameters: @@ -6441,7 +6428,7 @@ public enum Components { /// - value: The value assigned to the property public init( property_name: Swift.String, - value: Swift.String? = nil + value: Components.Schemas.custom_hyphen_property_hyphen_value.valuePayload? = nil ) { self.property_name = property_name self.value = value @@ -7163,9 +7150,15 @@ public enum Operations { } /// Get an organization /// - /// To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). + /// Gets information about an organization. + /// + /// When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://docs.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/). /// - /// GitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See "[Authenticating with GitHub Apps](https://docs.github.com/apps/building-github-apps/authenticating-with-github-apps/)" for details. For an example response, see 'Response with GitHub plan information' below." + /// To see the full details about an organization, the authenticated user must be an organization owner. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization. + /// + /// To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission. /// /// - Remark: HTTP `GET /orgs/{org}`. /// - Remark: Generated from `#/paths//orgs/{org}/get(orgs/get)`. @@ -7322,7 +7315,11 @@ public enum Operations { /// /// **Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes). /// - /// Enables an authenticated organization owner with the `admin:org` scope or the `repo` scope to update the organization's profile and member privileges. + /// Updates the organization's profile and member privileges. + /// + /// The authenticated user must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /orgs/{org}`. /// - Remark: Generated from `#/paths//orgs/{org}/patch(orgs/update)`. @@ -9830,7 +9827,7 @@ public enum Operations { /// /// Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use "[Get an organization webhook ](/rest/orgs/webhooks#get-an-organization-webhook)." /// - /// Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/get(orgs/get-webhook-config-for-org)`. @@ -9973,7 +9970,7 @@ public enum Operations { /// /// Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)." /// - /// Access tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/patch(orgs/update-webhook-config-for-org)`. @@ -10891,7 +10888,12 @@ public enum Operations { } /// List app installations for an organization /// - /// Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint. + /// Lists all GitHub Apps in an organization. The installation count includes + /// all GitHub Apps installed on repositories in the organization. + /// + /// The authenticated user must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:read` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/installations`. /// - Remark: Generated from `#/paths//orgs/{org}/installations/get(orgs/list-app-installations)`. @@ -13053,8 +13055,7 @@ public enum Operations { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-fine-grained-permissions`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-fine-grained-permissions/get(orgs/list-organization-fine-grained-permissions)`. @@ -13232,17 +13233,14 @@ public enum Operations { } /// Get all organization roles for an organization /// - /// Lists the organization roles available in this organization. + /// Lists the organization roles available in this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/get(orgs/list-org-roles)`. @@ -13447,17 +13445,14 @@ public enum Operations { } /// Create a custom organization role /// - /// Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. + /// Creates a custom organization role that can be assigned to users and teams, granting them specific permissions over the organization. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - /// - /// For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/organization-roles`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/post(orgs/create-custom-organization-role)`. @@ -13702,12 +13697,11 @@ public enum Operations { } /// Remove all organization roles for a team /// - /// Removes all assigned organization roles from a team. + /// Removes all assigned organization roles from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/delete(orgs/revoke-all-org-roles-team)`. @@ -13782,11 +13776,11 @@ public enum Operations { } /// Assign an organization role to a team /// - /// Assigns an organization role to a team in an organization. - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read-write permission to use this endpoint. + /// Assigns an organization role to a team in an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// The authenticated user must be an administrator for the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/{role_id}/put(orgs/assign-team-to-org-role)`. @@ -13922,12 +13916,11 @@ public enum Operations { } /// Remove an organization role from a team /// - /// Removes an organization role from a team. + /// Removes an organization role from a team. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/teams/{team_slug}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/teams/{team_slug}/{role_id}/delete(orgs/revoke-org-role-team)`. @@ -14009,12 +14002,11 @@ public enum Operations { } /// Remove all organization roles for a user /// - /// Revokes all assigned organization roles from a user. + /// Revokes all assigned organization roles from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/users/{username}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/delete(orgs/revoke-all-org-roles-user)`. @@ -14089,11 +14081,11 @@ public enum Operations { } /// Assign an organization role to a user /// - /// Assigns an organization role to a member of an organization. - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read-write permission to use this endpoint. + /// Assigns an organization role to a member of an organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/organization-roles/users/{username}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/{role_id}/put(orgs/assign-user-to-org-role)`. @@ -14229,12 +14221,11 @@ public enum Operations { } /// Remove an organization role from a user /// - /// Remove an organization role from a user. + /// Remove an organization role from a user. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members:write` organization permission to use this endpoint. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/users/{username}/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/users/{username}/{role_id}/delete(orgs/revoke-org-role-user)`. @@ -14316,17 +14307,14 @@ public enum Operations { } /// Get an organization role /// - /// Gets an organization role that is available to this organization. + /// Gets an organization role that is available to this organization. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `read_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:read` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:read` organization permission to use this endpoint. - /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/get(orgs/get-org-role)`. @@ -14513,17 +14501,15 @@ public enum Operations { } /// Update a custom organization role /// - /// Updates an existing custom organization role. Permission changes will apply to all assignees. + /// Updates an existing custom organization role. Permission changes will apply to all assignees. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - /// - /// For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/patch(orgs/patch-custom-organization-role)`. @@ -14777,17 +14763,14 @@ public enum Operations { } /// Delete a custom organization role. /// - /// Deletes a custom organization role. + /// Deletes a custom organization role. For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// /// To use this endpoint, the authenticated user must be one of: /// /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permissions of `write_organization_custom_org_role` in the organization. /// - /// The authenticated user needs an access token with `admin:org` scope or a fine-grained personal access token with the `organization_custom_roles:write` permission to use this endpoint. - /// GitHub Apps must have the `organization_custom_org_roles:write` organization permission to use this endpoint. - /// - /// For more information on custom organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/organization-roles/{role_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/delete(orgs/delete-custom-organization-role)`. @@ -14862,12 +14845,11 @@ public enum Operations { } /// List teams that are assigned to an organization role /// - /// Lists the teams that are assigned to an organization role. + /// Lists the teams that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read permission to use this endpoint. + /// To use this endpoint, you must be an administrator for the organization. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}/teams`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/teams/get(orgs/list-org-role-teams)`. @@ -15108,12 +15090,11 @@ public enum Operations { } /// List users that are assigned to an organization role /// - /// Lists organization members that are assigned to an organization role. + /// Lists organization members that are assigned to an organization role. For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. - /// GitHub Apps must have the `members` organization read permission to use this endpoint. + /// To use this endpoint, you must be an administrator for the organization. /// - /// For more information on organization roles, see "[Managing people's access to your organization with roles](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles)." + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/organization-roles/{role_id}/users`. /// - Remark: Generated from `#/paths//orgs/{org}/organization-roles/{role_id}/users/get(orgs/list-org-role-users)`. @@ -15987,10 +15968,9 @@ public enum Operations { } /// List requests to access organization resources with fine-grained personal access tokens /// - /// Lists requests from organization members to access organization resources with a fine-grained personal access token. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: read` permission. + /// Lists requests from organization members to access organization resources with a fine-grained personal access token. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-token-requests`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/get(orgs/list-pat-grant-requests)`. @@ -16318,10 +16298,9 @@ public enum Operations { } /// Review requests to access organization resources with fine-grained personal access tokens /// - /// Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: write` permission. + /// Approves or denies multiple pending requests to access organization resources via a fine-grained personal access token. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-token-requests`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/post(orgs/review-pat-grant-requests-in-bulk)`. @@ -16568,10 +16547,9 @@ public enum Operations { } /// Review a request to access organization resources with a fine-grained personal access token /// - /// Approves or denies a pending request to access organization resources via a fine-grained personal access token. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: write` permission. + /// Approves or denies a pending request to access organization resources via a fine-grained personal access token. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-token-requests/{pat_request_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/{pat_request_id}/post(orgs/review-pat-grant-request)`. @@ -16819,10 +16797,9 @@ public enum Operations { } /// List repositories requested to be accessed by a fine-grained personal access token /// - /// Lists the repositories a fine-grained personal access token request is requesting access to. Only GitHub Apps can call this API, - /// using the `organization_personal_access_token_requests: read` permission. + /// Lists the repositories a fine-grained personal access token request is requesting access to. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-token-requests/{pat_request_id}/repositories/get(orgs/list-pat-grant-request-repositories)`. @@ -17078,10 +17055,9 @@ public enum Operations { } /// List fine-grained personal access tokens with access to organization resources /// - /// Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: read` permission. + /// Lists approved fine-grained personal access tokens owned by organization members that can access organization resources. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-tokens`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/get(orgs/list-pat-grants)`. @@ -17409,10 +17385,9 @@ public enum Operations { } /// Update the access to organization resources via fine-grained personal access tokens /// - /// Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: write` permission. + /// Updates the access organization members have to organization resources via fine-grained personal access tokens. Limited to revoking a token's existing access. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-tokens`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/post(orgs/update-pat-accesses)`. @@ -17650,10 +17625,9 @@ public enum Operations { } /// Update the access a fine-grained personal access token has to organization resources /// - /// Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: write` permission. + /// Updates the access an organization member has to organization resources via a fine-grained personal access token. Limited to revoking the token's existing access. Limited to revoking a token's existing access. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/personal-access-tokens/{pat_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/{pat_id}/post(orgs/update-pat-access)`. @@ -17890,10 +17864,9 @@ public enum Operations { } /// List repositories a fine-grained personal access token has access to /// - /// Lists the repositories a fine-grained personal access token has access to. Only GitHub Apps can call this API, - /// using the `organization_personal_access_tokens: read` permission. + /// Lists the repositories a fine-grained personal access token has access to. /// - /// **Note**: Fine-grained PATs are in public beta. Related APIs, events, and functionality are subject to change. + /// Only GitHub Apps can use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/personal-access-tokens/{pat_id}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/personal-access-tokens/{pat_id}/repositories/get(orgs/list-pat-grant-repositories)`. @@ -18152,8 +18125,6 @@ public enum Operations { /// Gets all custom properties defined for an organization. /// Organization members can read these properties. /// - /// GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint. - /// /// - Remark: HTTP `GET /orgs/{org}/properties/schema`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/get(orgs/get-all-custom-properties)`. public enum orgs_sol_get_hyphen_all_hyphen_custom_hyphen_properties { @@ -18336,8 +18307,6 @@ public enum Operations { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint. - /// /// - Remark: HTTP `PATCH /orgs/{org}/properties/schema`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/patch(orgs/create-or-update-custom-properties)`. public enum orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties { @@ -18543,8 +18512,6 @@ public enum Operations { /// Gets a custom property that is defined for an organization. /// Organization members can read these properties. /// - /// GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint. - /// /// - Remark: HTTP `GET /orgs/{org}/properties/schema/{custom_property_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/{custom_property_name}/get(orgs/get-custom-property)`. public enum orgs_sol_get_hyphen_custom_hyphen_property { @@ -18736,8 +18703,6 @@ public enum Operations { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint. - /// /// - Remark: HTTP `PUT /orgs/{org}/properties/schema/{custom_property_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/{custom_property_name}/put(orgs/create-or-update-custom-property)`. public enum orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_property { @@ -18806,7 +18771,8 @@ public enum Operations { /// /// - Remark: Generated from `#/paths/orgs/{org}/properties/schema/{custom_property_name}/PUT/requestBody/json/description`. public var description: Swift.String? - /// Ordered list of allowed values of the property + /// An ordered list of the allowed values of the property. + /// The property can have up to 200 allowed values. /// /// - Remark: Generated from `#/paths/orgs/{org}/properties/schema/{custom_property_name}/PUT/requestBody/json/allowed_values`. public var allowed_values: [Swift.String]? @@ -18817,7 +18783,7 @@ public enum Operations { /// - required: Whether the property is required. /// - default_value: Default value of the property /// - description: Short description of the property - /// - allowed_values: Ordered list of allowed values of the property + /// - allowed_values: An ordered list of the allowed values of the property. public init( value_type: Operations.orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_property.Input.Body.jsonPayload.value_typePayload, required: Swift.Bool? = nil, @@ -18996,8 +18962,6 @@ public enum Operations { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_definitions_manager` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:admin` organization permission to use this endpoint. - /// /// - Remark: HTTP `DELETE /orgs/{org}/properties/schema/{custom_property_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/schema/{custom_property_name}/delete(orgs/remove-custom-property)`. public enum orgs_sol_remove_hyphen_custom_hyphen_property { @@ -19158,8 +19122,6 @@ public enum Operations { /// Lists organization repositories with all of their custom property values. /// Organization members can read these properties. /// - /// GitHub Apps must have the `organization_custom_properties:read` organization permission to use this endpoint. - /// /// - Remark: HTTP `GET /orgs/{org}/properties/values`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/values/get(orgs/list-custom-properties-values-for-repos)`. public enum orgs_sol_list_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos { @@ -19400,8 +19362,6 @@ public enum Operations { /// - An administrator for the organization. /// - A user, or a user on a team, with the fine-grained permission of `custom_properties_org_values_editor` in the organization. /// - /// GitHub Apps must have the `organization_custom_properties:write` organization permission to use this endpoint. - /// /// - Remark: HTTP `PATCH /orgs/{org}/properties/values`. /// - Remark: Generated from `#/paths//orgs/{org}/properties/values/patch(orgs/create-or-update-custom-properties-values-for-repos)`. public enum orgs_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values_hyphen_for_hyphen_repos { @@ -19557,6 +19517,29 @@ public enum Operations { } } } + /// Validation failed, or the endpoint has been spammed. + /// + /// - Remark: Generated from `#/paths//orgs/{org}/properties/values/patch(orgs/create-or-update-custom-properties-values-for-repos)/responses/422`. + /// + /// HTTP response code: `422 unprocessableContent`. + case unprocessableContent(Components.Responses.validation_failed) + /// The associated value of the enum case if `self` is `.unprocessableContent`. + /// + /// - Throws: An error if `self` is not `.unprocessableContent`. + /// - SeeAlso: `.unprocessableContent`. + public var unprocessableContent: Components.Responses.validation_failed { + get throws { + switch self { + case let .unprocessableContent(response): + return response + default: + try throwUnexpectedResponseStatus( + expectedStatus: "unprocessableContent", + response: self + ) + } + } + } /// Undocumented response. /// /// A response with a code that is not documented in the OpenAPI document. @@ -20089,9 +20072,9 @@ public enum Operations { /// /// Lists teams that are security managers for an organization. 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 administrator or security manager for the organization, and you must use an access token with the `read:org` scope. + /// The authenticated user must be an administrator or security manager for the organization to use this endpoint. /// - /// GitHub Apps must have the `administration` organization read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/security-managers`. /// - Remark: Generated from `#/paths//orgs/{org}/security-managers/get(orgs/list-security-manager-teams)`. @@ -20225,9 +20208,9 @@ public enum Operations { /// /// Adds a team as a security manager for an organization. For more information, see "[Managing security for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization) for an organization." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `write:org` scope. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/security-managers/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/security-managers/teams/{team_slug}/put(orgs/add-security-manager-team)`. @@ -20331,9 +20314,9 @@ public enum Operations { /// /// Removes the security manager role from a team for an organization. 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) team from an organization." /// - /// To use this endpoint, you must be an administrator for the organization, and you must use an access token with the `admin:org` scope. + /// The authenticated user must be an administrator for the organization to use this endpoint. /// - /// GitHub Apps must have the `administration` organization read-write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/security-managers/teams/{team_slug}`. /// - Remark: Generated from `#/paths//orgs/{org}/security-managers/teams/{team_slug}/delete(orgs/remove-security-manager-team)`. @@ -20408,14 +20391,11 @@ public enum Operations { } /// Enable or disable a security feature for an organization /// - /// Enables or disables the specified security feature for all eligible repositories in an organization. - /// - /// To use this endpoint, you must be an organization owner or be member of a team with the security manager role. - /// A token with the 'write:org' scope is also required. + /// Enables or disables the specified security feature for all eligible repositories in an organization. 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)." /// - /// GitHub Apps must have the `organization_administration:write` permission to use this endpoint. + /// The authenticated user must be an organization owner or be member of a team with the security manager role to use this endpoint. /// - /// 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)." + /// OAuth app tokens and personal access tokens (classic) need the `write:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/{security_product}/{enablement}`. /// - Remark: Generated from `#/paths//orgs/{org}/{security_product}/{enablement}/post(orgs/enable-or-disable-security-product-on-all-org-repos)`. @@ -21256,9 +21236,7 @@ public enum Operations { /// /// List organizations for the authenticated user. /// - /// **OAuth scope requirements** - /// - /// This only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response. + /// For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response. /// /// - Remark: HTTP `GET /user/orgs`. /// - Remark: Generated from `#/paths//user/orgs/get(orgs/list-for-authenticated-user)`. From 1a8706abfbba0f3c37ed17a15cfbc9652a167c68 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:17:13 +0000 Subject: [PATCH 11/20] Commit via running ake Sources/packages --- Sources/packages/Client.swift | 93 ++++++------ Sources/packages/Types.swift | 279 ++++++++++++++++++---------------- 2 files changed, 192 insertions(+), 180 deletions(-) diff --git a/Sources/packages/Client.swift b/Sources/packages/Client.swift index 2813ed5d1d..05b645285f 100644 --- a/Sources/packages/Client.swift +++ b/Sources/packages/Client.swift @@ -41,7 +41,8 @@ public struct Client: APIProtocol { /// Get list of conflicting packages during Docker migration for organization /// /// Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/docker/conflicts`. /// - Remark: Generated from `#/paths//orgs/{org}/docker/conflicts/get(packages/list-docker-migration-conflicting-packages-for-organization)`. @@ -151,7 +152,7 @@ public struct Client: APIProtocol { /// /// Lists packages in an organization readable by the user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/get(packages/list-packages-for-organization)`. @@ -291,7 +292,7 @@ public struct Client: APIProtocol { /// /// Gets a specific package in an organization. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/get(packages/get-package-for-organization)`. @@ -359,9 +360,9 @@ public struct Client: APIProtocol { /// /// Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /orgs/{org}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/delete(packages/delete-package-for-org)`. @@ -479,9 +480,9 @@ public struct Client: APIProtocol { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /orgs/{org}/packages/{package_type}/{package_name}/restore`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/restore/post(packages/restore-package-for-org)`. @@ -602,7 +603,7 @@ public struct Client: APIProtocol { /// /// Lists package versions for a package owned by an organization. /// - /// If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages/{package_type}/{package_name}/versions`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/get(packages/get-all-package-versions-for-package-owned-by-org)`. @@ -757,7 +758,7 @@ public struct Client: APIProtocol { /// /// Gets a specific package version in an organization. /// - /// You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/get(packages/get-package-version-for-organization)`. @@ -826,9 +827,9 @@ public struct Client: APIProtocol { /// /// Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/delete(packages/delete-package-version-for-org)`. @@ -947,9 +948,9 @@ public struct Client: APIProtocol { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore/post(packages/restore-package-version-for-org)`. @@ -1063,7 +1064,8 @@ public struct Client: APIProtocol { /// Get list of conflicting packages during Docker migration for authenticated-user /// /// Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/docker/conflicts`. /// - Remark: Generated from `#/paths//user/docker/conflicts/get(packages/list-docker-migration-conflicting-packages-for-authenticated-user)`. @@ -1127,7 +1129,7 @@ public struct Client: APIProtocol { /// /// Lists packages owned by the authenticated user within the user's namespace. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages`. /// - Remark: Generated from `#/paths//user/packages/get(packages/list-packages-for-authenticated-user)`. @@ -1221,7 +1223,7 @@ public struct Client: APIProtocol { /// /// Gets a specific package for a package owned by the authenticated user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/get(packages/get-package-for-authenticated-user)`. @@ -1288,8 +1290,7 @@ public struct Client: APIProtocol { /// /// Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. - /// If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /user/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/delete(packages/delete-package-for-authenticated-user)`. @@ -1406,7 +1407,7 @@ public struct Client: APIProtocol { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /user/packages/{package_type}/{package_name}/restore`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/restore/post(packages/restore-package-for-authenticated-user)`. @@ -1526,7 +1527,7 @@ public struct Client: APIProtocol { /// /// Lists package versions for a package owned by the authenticated user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages/{package_type}/{package_name}/versions`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/get(packages/get-all-package-versions-for-package-owned-by-authenticated-user)`. @@ -1680,7 +1681,7 @@ public struct Client: APIProtocol { /// /// Gets a specific package version for a package owned by the authenticated user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/{package_version_id}/get(packages/get-package-version-for-authenticated-user)`. @@ -1748,8 +1749,9 @@ public struct Client: APIProtocol { /// /// Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. - /// If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/{package_version_id}/delete(packages/delete-package-version-for-authenticated-user)`. @@ -1867,7 +1869,7 @@ public struct Client: APIProtocol { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore/post(packages/restore-package-version-for-authenticated-user)`. @@ -1980,7 +1982,8 @@ public struct Client: APIProtocol { /// Get list of conflicting packages during Docker migration for user /// /// Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/docker/conflicts`. /// - Remark: Generated from `#/paths//users/{username}/docker/conflicts/get(packages/list-docker-migration-conflicting-packages-for-user)`. @@ -2090,7 +2093,7 @@ public struct Client: APIProtocol { /// /// Lists all packages in a user's namespace for which the requesting user has access. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages`. /// - Remark: Generated from `#/paths//users/{username}/packages/get(packages/list-packages-for-user)`. @@ -2230,7 +2233,7 @@ public struct Client: APIProtocol { /// /// Gets a specific package metadata for a public package owned by a user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/get(packages/get-package-for-user)`. @@ -2298,9 +2301,9 @@ public struct Client: APIProtocol { /// /// Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /users/{username}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/delete(packages/delete-package-for-user)`. @@ -2418,9 +2421,9 @@ public struct Client: APIProtocol { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /users/{username}/packages/{package_type}/{package_name}/restore`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/restore/post(packages/restore-package-for-user)`. @@ -2541,7 +2544,7 @@ public struct Client: APIProtocol { /// /// Lists package versions for a public package owned by a specified user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages/{package_type}/{package_name}/versions`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/get(packages/get-all-package-versions-for-package-owned-by-user)`. @@ -2675,7 +2678,7 @@ public struct Client: APIProtocol { /// /// Gets a specific package version for a public package owned by a specified user. /// - /// At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/get(packages/get-package-version-for-user)`. @@ -2744,9 +2747,9 @@ public struct Client: APIProtocol { /// /// Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/delete(packages/delete-package-version-for-user)`. @@ -2865,9 +2868,9 @@ public struct Client: APIProtocol { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore/post(packages/restore-package-version-for-user)`. diff --git a/Sources/packages/Types.swift b/Sources/packages/Types.swift index 67b3f6e013..9eaab52dc6 100644 --- a/Sources/packages/Types.swift +++ b/Sources/packages/Types.swift @@ -14,7 +14,8 @@ public protocol APIProtocol: Sendable { /// Get list of conflicting packages during Docker migration for organization /// /// Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/docker/conflicts`. /// - Remark: Generated from `#/paths//orgs/{org}/docker/conflicts/get(packages/list-docker-migration-conflicting-packages-for-organization)`. @@ -23,7 +24,7 @@ public protocol APIProtocol: Sendable { /// /// Lists packages in an organization readable by the user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/get(packages/list-packages-for-organization)`. @@ -32,7 +33,7 @@ public protocol APIProtocol: Sendable { /// /// Gets a specific package in an organization. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/get(packages/get-package-for-organization)`. @@ -41,9 +42,9 @@ public protocol APIProtocol: Sendable { /// /// Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /orgs/{org}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/delete(packages/delete-package-for-org)`. @@ -56,9 +57,9 @@ public protocol APIProtocol: Sendable { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /orgs/{org}/packages/{package_type}/{package_name}/restore`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/restore/post(packages/restore-package-for-org)`. @@ -67,7 +68,7 @@ public protocol APIProtocol: Sendable { /// /// Lists package versions for a package owned by an organization. /// - /// If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages/{package_type}/{package_name}/versions`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/get(packages/get-all-package-versions-for-package-owned-by-org)`. @@ -76,7 +77,7 @@ public protocol APIProtocol: Sendable { /// /// Gets a specific package version in an organization. /// - /// You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/get(packages/get-package-version-for-organization)`. @@ -85,9 +86,9 @@ public protocol APIProtocol: Sendable { /// /// Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/delete(packages/delete-package-version-for-org)`. @@ -100,9 +101,9 @@ public protocol APIProtocol: Sendable { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore/post(packages/restore-package-version-for-org)`. @@ -110,7 +111,8 @@ public protocol APIProtocol: Sendable { /// Get list of conflicting packages during Docker migration for authenticated-user /// /// Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/docker/conflicts`. /// - Remark: Generated from `#/paths//user/docker/conflicts/get(packages/list-docker-migration-conflicting-packages-for-authenticated-user)`. @@ -119,7 +121,7 @@ public protocol APIProtocol: Sendable { /// /// Lists packages owned by the authenticated user within the user's namespace. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages`. /// - Remark: Generated from `#/paths//user/packages/get(packages/list-packages-for-authenticated-user)`. @@ -128,7 +130,7 @@ public protocol APIProtocol: Sendable { /// /// Gets a specific package for a package owned by the authenticated user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/get(packages/get-package-for-authenticated-user)`. @@ -137,8 +139,7 @@ public protocol APIProtocol: Sendable { /// /// Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. - /// If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /user/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/delete(packages/delete-package-for-authenticated-user)`. @@ -151,7 +152,7 @@ public protocol APIProtocol: Sendable { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /user/packages/{package_type}/{package_name}/restore`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/restore/post(packages/restore-package-for-authenticated-user)`. @@ -160,7 +161,7 @@ public protocol APIProtocol: Sendable { /// /// Lists package versions for a package owned by the authenticated user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages/{package_type}/{package_name}/versions`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/get(packages/get-all-package-versions-for-package-owned-by-authenticated-user)`. @@ -169,7 +170,7 @@ public protocol APIProtocol: Sendable { /// /// Gets a specific package version for a package owned by the authenticated user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/{package_version_id}/get(packages/get-package-version-for-authenticated-user)`. @@ -178,8 +179,9 @@ public protocol APIProtocol: Sendable { /// /// Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. - /// If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/{package_version_id}/delete(packages/delete-package-version-for-authenticated-user)`. @@ -192,7 +194,7 @@ public protocol APIProtocol: Sendable { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore/post(packages/restore-package-version-for-authenticated-user)`. @@ -200,7 +202,8 @@ public protocol APIProtocol: Sendable { /// Get list of conflicting packages during Docker migration for user /// /// Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/docker/conflicts`. /// - Remark: Generated from `#/paths//users/{username}/docker/conflicts/get(packages/list-docker-migration-conflicting-packages-for-user)`. @@ -209,7 +212,7 @@ public protocol APIProtocol: Sendable { /// /// Lists all packages in a user's namespace for which the requesting user has access. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages`. /// - Remark: Generated from `#/paths//users/{username}/packages/get(packages/list-packages-for-user)`. @@ -218,7 +221,7 @@ public protocol APIProtocol: Sendable { /// /// Gets a specific package metadata for a public package owned by a user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/get(packages/get-package-for-user)`. @@ -227,9 +230,9 @@ public protocol APIProtocol: Sendable { /// /// Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /users/{username}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/delete(packages/delete-package-for-user)`. @@ -242,9 +245,9 @@ public protocol APIProtocol: Sendable { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /users/{username}/packages/{package_type}/{package_name}/restore`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/restore/post(packages/restore-package-for-user)`. @@ -253,7 +256,7 @@ public protocol APIProtocol: Sendable { /// /// Lists package versions for a public package owned by a specified user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages/{package_type}/{package_name}/versions`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/get(packages/get-all-package-versions-for-package-owned-by-user)`. @@ -262,7 +265,7 @@ public protocol APIProtocol: Sendable { /// /// Gets a specific package version for a public package owned by a specified user. /// - /// At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/get(packages/get-package-version-for-user)`. @@ -271,9 +274,9 @@ public protocol APIProtocol: Sendable { /// /// Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/delete(packages/delete-package-version-for-user)`. @@ -286,9 +289,9 @@ public protocol APIProtocol: Sendable { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore/post(packages/restore-package-version-for-user)`. @@ -300,7 +303,8 @@ extension APIProtocol { /// Get list of conflicting packages during Docker migration for organization /// /// Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/docker/conflicts`. /// - Remark: Generated from `#/paths//orgs/{org}/docker/conflicts/get(packages/list-docker-migration-conflicting-packages-for-organization)`. @@ -317,7 +321,7 @@ extension APIProtocol { /// /// Lists packages in an organization readable by the user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/get(packages/list-packages-for-organization)`. @@ -336,7 +340,7 @@ extension APIProtocol { /// /// Gets a specific package in an organization. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/get(packages/get-package-for-organization)`. @@ -353,9 +357,9 @@ extension APIProtocol { /// /// Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /orgs/{org}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/delete(packages/delete-package-for-org)`. @@ -376,9 +380,9 @@ extension APIProtocol { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /orgs/{org}/packages/{package_type}/{package_name}/restore`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/restore/post(packages/restore-package-for-org)`. @@ -397,7 +401,7 @@ extension APIProtocol { /// /// Lists package versions for a package owned by an organization. /// - /// If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages/{package_type}/{package_name}/versions`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/get(packages/get-all-package-versions-for-package-owned-by-org)`. @@ -416,7 +420,7 @@ extension APIProtocol { /// /// Gets a specific package version in an organization. /// - /// You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/get(packages/get-package-version-for-organization)`. @@ -433,9 +437,9 @@ extension APIProtocol { /// /// Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/delete(packages/delete-package-version-for-org)`. @@ -456,9 +460,9 @@ extension APIProtocol { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore/post(packages/restore-package-version-for-org)`. @@ -474,7 +478,8 @@ extension APIProtocol { /// Get list of conflicting packages during Docker migration for authenticated-user /// /// Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/docker/conflicts`. /// - Remark: Generated from `#/paths//user/docker/conflicts/get(packages/list-docker-migration-conflicting-packages-for-authenticated-user)`. @@ -485,7 +490,7 @@ extension APIProtocol { /// /// Lists packages owned by the authenticated user within the user's namespace. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages`. /// - Remark: Generated from `#/paths//user/packages/get(packages/list-packages-for-authenticated-user)`. @@ -502,7 +507,7 @@ extension APIProtocol { /// /// Gets a specific package for a package owned by the authenticated user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/get(packages/get-package-for-authenticated-user)`. @@ -519,8 +524,7 @@ extension APIProtocol { /// /// Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. - /// If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /user/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/delete(packages/delete-package-for-authenticated-user)`. @@ -541,7 +545,7 @@ extension APIProtocol { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /user/packages/{package_type}/{package_name}/restore`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/restore/post(packages/restore-package-for-authenticated-user)`. @@ -560,7 +564,7 @@ extension APIProtocol { /// /// Lists package versions for a package owned by the authenticated user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages/{package_type}/{package_name}/versions`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/get(packages/get-all-package-versions-for-package-owned-by-authenticated-user)`. @@ -579,7 +583,7 @@ extension APIProtocol { /// /// Gets a specific package version for a package owned by the authenticated user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/{package_version_id}/get(packages/get-package-version-for-authenticated-user)`. @@ -596,8 +600,9 @@ extension APIProtocol { /// /// Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. - /// If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/{package_version_id}/delete(packages/delete-package-version-for-authenticated-user)`. @@ -618,7 +623,7 @@ extension APIProtocol { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore/post(packages/restore-package-version-for-authenticated-user)`. @@ -634,7 +639,8 @@ extension APIProtocol { /// Get list of conflicting packages during Docker migration for user /// /// Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/docker/conflicts`. /// - Remark: Generated from `#/paths//users/{username}/docker/conflicts/get(packages/list-docker-migration-conflicting-packages-for-user)`. @@ -651,7 +657,7 @@ extension APIProtocol { /// /// Lists all packages in a user's namespace for which the requesting user has access. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages`. /// - Remark: Generated from `#/paths//users/{username}/packages/get(packages/list-packages-for-user)`. @@ -670,7 +676,7 @@ extension APIProtocol { /// /// Gets a specific package metadata for a public package owned by a user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/get(packages/get-package-for-user)`. @@ -687,9 +693,9 @@ extension APIProtocol { /// /// Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /users/{username}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/delete(packages/delete-package-for-user)`. @@ -710,9 +716,9 @@ extension APIProtocol { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /users/{username}/packages/{package_type}/{package_name}/restore`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/restore/post(packages/restore-package-for-user)`. @@ -731,7 +737,7 @@ extension APIProtocol { /// /// Lists package versions for a public package owned by a specified user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages/{package_type}/{package_name}/versions`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/get(packages/get-all-package-versions-for-package-owned-by-user)`. @@ -748,7 +754,7 @@ extension APIProtocol { /// /// Gets a specific package version for a public package owned by a specified user. /// - /// At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/get(packages/get-package-version-for-user)`. @@ -765,9 +771,9 @@ extension APIProtocol { /// /// Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/delete(packages/delete-package-version-for-user)`. @@ -788,9 +794,9 @@ extension APIProtocol { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore/post(packages/restore-package-version-for-user)`. @@ -2321,7 +2327,8 @@ public enum Operations { /// Get list of conflicting packages during Docker migration for organization /// /// Lists all packages that are in a specific organization, are readable by the requesting user, and that encountered a conflict during a Docker migration. - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/docker/conflicts`. /// - Remark: Generated from `#/paths//orgs/{org}/docker/conflicts/get(packages/list-docker-migration-conflicting-packages-for-organization)`. @@ -2501,7 +2508,7 @@ public enum Operations { /// /// Lists packages in an organization readable by the user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/get(packages/list-packages-for-organization)`. @@ -2763,7 +2770,7 @@ public enum Operations { /// /// Gets a specific package in an organization. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/get(packages/get-package-for-organization)`. @@ -2922,9 +2929,9 @@ public enum Operations { /// /// Deletes an entire package in an organization. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /orgs/{org}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/delete(packages/delete-package-for-org)`. @@ -3132,9 +3139,9 @@ public enum Operations { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /orgs/{org}/packages/{package_type}/{package_name}/restore`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/restore/post(packages/restore-package-for-org)`. @@ -3356,7 +3363,7 @@ public enum Operations { /// /// Lists package versions for a package owned by an organization. /// - /// If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint if the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages/{package_type}/{package_name}/versions`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/get(packages/get-all-package-versions-for-package-owned-by-org)`. @@ -3623,7 +3630,7 @@ public enum Operations { /// /// Gets a specific package version in an organization. /// - /// You must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/get(packages/get-package-version-for-organization)`. @@ -3789,9 +3796,9 @@ public enum Operations { /// /// Deletes a specific package version in an organization. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/delete(packages/delete-package-version-for-org)`. @@ -4006,9 +4013,9 @@ public enum Operations { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must also have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore`. /// - Remark: Generated from `#/paths//orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore/post(packages/restore-package-version-for-org)`. @@ -4218,7 +4225,8 @@ public enum Operations { /// Get list of conflicting packages during Docker migration for authenticated-user /// /// Lists all packages that are owned by the authenticated user within the user's namespace, and that encountered a conflict during a Docker migration. - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/docker/conflicts`. /// - Remark: Generated from `#/paths//user/docker/conflicts/get(packages/list-docker-migration-conflicting-packages-for-authenticated-user)`. @@ -4332,7 +4340,7 @@ public enum Operations { /// /// Lists packages owned by the authenticated user within the user's namespace. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages`. /// - Remark: Generated from `#/paths//user/packages/get(packages/list-packages-for-authenticated-user)`. @@ -4530,7 +4538,7 @@ public enum Operations { /// /// Gets a specific package for a package owned by the authenticated user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/get(packages/get-package-for-authenticated-user)`. @@ -4682,8 +4690,7 @@ public enum Operations { /// /// Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. - /// If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /user/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/delete(packages/delete-package-for-authenticated-user)`. @@ -4884,7 +4891,7 @@ public enum Operations { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /user/packages/{package_type}/{package_name}/restore`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/restore/post(packages/restore-package-for-authenticated-user)`. @@ -5099,7 +5106,7 @@ public enum Operations { /// /// Lists package versions for a package owned by the authenticated user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages/{package_type}/{package_name}/versions`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/get(packages/get-all-package-versions-for-package-owned-by-authenticated-user)`. @@ -5359,7 +5366,7 @@ public enum Operations { /// /// Gets a specific package version for a package owned by the authenticated user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /user/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/{package_version_id}/get(packages/get-package-version-for-authenticated-user)`. @@ -5518,8 +5525,9 @@ public enum Operations { /// /// Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must have admin permissions in the organization and authenticate using an access token with the `read:packages` and `delete:packages` scopes. - /// If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// The authenticated user must have admin permissions in the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /user/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/{package_version_id}/delete(packages/delete-package-version-for-authenticated-user)`. @@ -5727,7 +5735,7 @@ public enum Operations { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore`. /// - Remark: Generated from `#/paths//user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore/post(packages/restore-package-version-for-authenticated-user)`. @@ -5930,7 +5938,8 @@ public enum Operations { /// Get list of conflicting packages during Docker migration for user /// /// Lists all packages that are in a specific user's namespace, that the requesting user has access to, and that encountered a conflict during Docker migration. - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. /// /// - Remark: HTTP `GET /users/{username}/docker/conflicts`. /// - Remark: Generated from `#/paths//users/{username}/docker/conflicts/get(packages/list-docker-migration-conflicting-packages-for-user)`. @@ -6110,7 +6119,7 @@ public enum Operations { /// /// Lists all packages in a user's namespace for which the requesting user has access. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages`. /// - Remark: Generated from `#/paths//users/{username}/packages/get(packages/list-packages-for-user)`. @@ -6372,7 +6381,7 @@ public enum Operations { /// /// Gets a specific package metadata for a public package owned by a user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/get(packages/get-package-for-user)`. @@ -6531,9 +6540,9 @@ public enum Operations { /// /// Deletes an entire package for a user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /users/{username}/packages/{package_type}/{package_name}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/delete(packages/delete-package-for-user)`. @@ -6741,9 +6750,9 @@ public enum Operations { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /users/{username}/packages/{package_type}/{package_name}/restore`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/restore/post(packages/restore-package-for-user)`. @@ -6965,7 +6974,7 @@ public enum Operations { /// /// Lists package versions for a public package owned by a specified user. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages/{package_type}/{package_name}/versions`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/get(packages/get-all-package-versions-for-package-owned-by-user)`. @@ -7193,7 +7202,7 @@ public enum Operations { /// /// Gets a specific package version for a public package owned by a specified user. /// - /// At this time, to use this endpoint, you must authenticate using an access token with the `read:packages` scope. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of GitHub Packages registries that only support repository-scoped permissions, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `GET /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/get(packages/get-package-version-for-user)`. @@ -7359,9 +7368,9 @@ public enum Operations { /// /// Deletes a specific package version for a user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `delete:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to delete. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `DELETE /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/delete(packages/delete-package-version-for-user)`. @@ -7576,9 +7585,9 @@ public enum Operations { /// - The package was deleted within the last 30 days. /// - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this scenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first. /// - /// To use this endpoint, you must authenticate using an access token with the `read:packages` and `write:packages` scopes. In addition: - /// - If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, your token must also include the `repo` scope. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." - /// - If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, you must have admin permissions to the package whose version you want to restore. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// If the `package_type` belongs to a GitHub Packages registry that supports granular permissions, the authenticated user must have admin permissions to the package. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)." + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)." /// /// - Remark: HTTP `POST /users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore`. /// - Remark: Generated from `#/paths//users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore/post(packages/restore-package-version-for-user)`. From dd2cd255d76ebaa539f9ca496f524bab05e9951b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:18:14 +0000 Subject: [PATCH 12/20] Commit via running ake Sources/rate-limit --- Sources/rate-limit/Client.swift | 2 +- Sources/rate-limit/Types.swift | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Sources/rate-limit/Client.swift b/Sources/rate-limit/Client.swift index b3eb6a6978..9dab4b9d31 100644 --- a/Sources/rate-limit/Client.swift +++ b/Sources/rate-limit/Client.swift @@ -44,7 +44,7 @@ public struct Client: APIProtocol { /// /// Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: /// * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - /// * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + /// * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." /// * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." /// * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." /// * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." diff --git a/Sources/rate-limit/Types.swift b/Sources/rate-limit/Types.swift index 7c6078fcf0..20af1bbebd 100644 --- a/Sources/rate-limit/Types.swift +++ b/Sources/rate-limit/Types.swift @@ -17,7 +17,7 @@ public protocol APIProtocol: Sendable { /// /// Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: /// * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - /// * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + /// * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." /// * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." /// * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." /// * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." @@ -41,7 +41,7 @@ extension APIProtocol { /// /// Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: /// * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - /// * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + /// * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." /// * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." /// * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." /// * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." @@ -300,7 +300,7 @@ public enum Operations { /// /// Some categories of endpoints have custom rate limits that are separate from the rate limit governing the other REST API endpoints. For this reason, the API response categorizes your rate limit. Under `resources`, you'll see objects relating to different categories: /// * The `core` object provides your rate limit status for all non-search-related resources in the REST API. - /// * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search)." + /// * The `search` object provides your rate limit status for the REST API for searching (excluding code searches). For more information, see "[Search](https://docs.github.com/rest/search/search)." /// * The `code_search` object provides your rate limit status for the REST API for searching code. For more information, see "[Search code](https://docs.github.com/rest/search/search#search-code)." /// * The `graphql` object provides your rate limit status for the GraphQL API. For more information, see "[Resource limitations](https://docs.github.com/graphql/overview/resource-limitations#rate-limit)." /// * The `integration_manifest` object provides your rate limit status for the `POST /app-manifests/{code}/conversions` operation. For more information, see "[Creating a GitHub App from a manifest](https://docs.github.com/apps/creating-github-apps/setting-up-a-github-app/creating-a-github-app-from-a-manifest#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration)." From f215410b99427b325991f7bb5916a1718d569e61 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:18:34 +0000 Subject: [PATCH 13/20] Commit via running ake Sources/reactions --- Sources/reactions/Client.swift | 48 ++++++++--- Sources/reactions/Types.swift | 144 ++++++++++++++++++++++++++------- 2 files changed, 152 insertions(+), 40 deletions(-) diff --git a/Sources/reactions/Client.swift b/Sources/reactions/Client.swift index 7d44547bba..b8abadb7cb 100644 --- a/Sources/reactions/Client.swift +++ b/Sources/reactions/Client.swift @@ -40,10 +40,12 @@ public struct Client: APIProtocol { } /// List reactions for a team discussion comment /// - /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/get(reactions/list-for-team-discussion-comment-in-org)`. public func reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output { @@ -138,10 +140,14 @@ public struct Client: APIProtocol { } /// Create reaction for a team discussion comment /// - /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/post(reactions/create-for-team-discussion-comment-in-org)`. public func reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output { @@ -240,7 +246,9 @@ public struct Client: APIProtocol { /// /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. /// - /// Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}/delete(reactions/delete-for-team-discussion-comment)`. @@ -284,10 +292,12 @@ public struct Client: APIProtocol { } /// List reactions for a team discussion /// - /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/get(reactions/list-for-team-discussion-in-org)`. public func reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org.Output { @@ -381,10 +391,14 @@ public struct Client: APIProtocol { } /// Create reaction for a team discussion /// - /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/post(reactions/create-for-team-discussion-in-org)`. public func reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org.Output { @@ -482,7 +496,9 @@ public struct Client: APIProtocol { /// /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. /// - /// Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}/delete(reactions/delete-for-team-discussion)`. @@ -1954,7 +1970,9 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. /// - /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions/get(reactions/list-for-team-discussion-comment-legacy)`. @@ -2052,7 +2070,11 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. /// - /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions/post(reactions/create-for-team-discussion-comment-legacy)`. @@ -2130,7 +2152,9 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. /// - /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/reactions/get(reactions/list-for-team-discussion-legacy)`. @@ -2227,7 +2251,11 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. /// - /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `POST /teams/{team_id}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/reactions/post(reactions/create-for-team-discussion-legacy)`. diff --git a/Sources/reactions/Types.swift b/Sources/reactions/Types.swift index 23860b0060..f62657db49 100644 --- a/Sources/reactions/Types.swift +++ b/Sources/reactions/Types.swift @@ -13,19 +13,25 @@ import struct Foundation.Date public protocol APIProtocol: Sendable { /// List reactions for a team discussion comment /// - /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/get(reactions/list-for-team-discussion-comment-in-org)`. func reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output /// Create reaction for a team discussion comment /// - /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/post(reactions/create-for-team-discussion-comment-in-org)`. func reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output @@ -33,26 +39,34 @@ public protocol APIProtocol: Sendable { /// /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. /// - /// Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}/delete(reactions/delete-for-team-discussion-comment)`. func reactions_sol_delete_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment(_ input: Operations.reactions_sol_delete_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment.Input) async throws -> Operations.reactions_sol_delete_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment.Output /// List reactions for a team discussion /// - /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/get(reactions/list-for-team-discussion-in-org)`. func reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org.Output /// Create reaction for a team discussion /// - /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/post(reactions/create-for-team-discussion-in-org)`. func reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org.Output @@ -60,7 +74,9 @@ public protocol APIProtocol: Sendable { /// /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. /// - /// Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}/delete(reactions/delete-for-team-discussion)`. @@ -184,7 +200,9 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. /// - /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions/get(reactions/list-for-team-discussion-comment-legacy)`. @@ -194,7 +212,11 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. /// - /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions/post(reactions/create-for-team-discussion-comment-legacy)`. @@ -204,7 +226,9 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. /// - /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/reactions/get(reactions/list-for-team-discussion-legacy)`. @@ -214,7 +238,11 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. /// - /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `POST /teams/{team_id}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/reactions/post(reactions/create-for-team-discussion-legacy)`. @@ -226,10 +254,12 @@ public protocol APIProtocol: Sendable { extension APIProtocol { /// List reactions for a team discussion comment /// - /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/get(reactions/list-for-team-discussion-comment-in-org)`. public func reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org( @@ -245,10 +275,14 @@ extension APIProtocol { } /// Create reaction for a team discussion comment /// - /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/post(reactions/create-for-team-discussion-comment-in-org)`. public func reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org( @@ -266,7 +300,9 @@ extension APIProtocol { /// /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. /// - /// Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}/delete(reactions/delete-for-team-discussion-comment)`. @@ -275,10 +311,12 @@ extension APIProtocol { } /// List reactions for a team discussion /// - /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/get(reactions/list-for-team-discussion-in-org)`. public func reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org( @@ -294,10 +332,14 @@ extension APIProtocol { } /// Create reaction for a team discussion /// - /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/post(reactions/create-for-team-discussion-in-org)`. public func reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org( @@ -315,7 +357,9 @@ extension APIProtocol { /// /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. /// - /// Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}/delete(reactions/delete-for-team-discussion)`. @@ -551,7 +595,9 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. /// - /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions/get(reactions/list-for-team-discussion-comment-legacy)`. @@ -571,7 +617,11 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. /// - /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions/post(reactions/create-for-team-discussion-comment-legacy)`. @@ -591,7 +641,9 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. /// - /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/reactions/get(reactions/list-for-team-discussion-legacy)`. @@ -611,7 +663,11 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. /// - /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `POST /teams/{team_id}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/reactions/post(reactions/create-for-team-discussion-legacy)`. @@ -1158,10 +1214,12 @@ public enum Components { public enum Operations { /// List reactions for a team discussion comment /// - /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/get(reactions/list-for-team-discussion-comment-in-org)`. public enum reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org { @@ -1379,10 +1437,14 @@ public enum Operations { } /// Create reaction for a team discussion comment /// - /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/post(reactions/create-for-team-discussion-comment-in-org)`. public enum reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org { @@ -1628,7 +1690,9 @@ public enum Operations { /// /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`. /// - /// Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}/delete(reactions/delete-for-team-discussion-comment)`. @@ -1724,10 +1788,12 @@ public enum Operations { } /// List reactions for a team discussion /// - /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/get(reactions/list-for-team-discussion-in-org)`. public enum reactions_sol_list_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org { @@ -1938,10 +2004,14 @@ public enum Operations { } /// Create reaction for a team discussion /// - /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/post(reactions/create-for-team-discussion-in-org)`. public enum reactions_sol_create_hyphen_for_hyphen_team_hyphen_discussion_hyphen_in_hyphen_org { @@ -2180,7 +2250,9 @@ public enum Operations { /// /// **Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`. /// - /// Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}/delete(reactions/delete-for-team-discussion)`. @@ -5225,7 +5297,9 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment) endpoint. /// - /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions/get(reactions/list-for-team-discussion-comment-legacy)`. @@ -5439,7 +5513,11 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Create reaction for a team discussion comment](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment)" endpoint. /// - /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + /// Create a reaction to a [team discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion comment. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `POST /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions/post(reactions/create-for-team-discussion-comment-legacy)`. @@ -5628,7 +5706,9 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion) endpoint. /// - /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List the reactions to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/reactions/get(reactions/list-for-team-discussion-legacy)`. @@ -5835,7 +5915,11 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion) endpoint. /// - /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + /// Create a reaction to a [team discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion). + /// + /// A response with an HTTP `200` status means that you already added the reaction type to this team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `POST /teams/{team_id}/discussions/{discussion_number}/reactions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/reactions/post(reactions/create-for-team-discussion-legacy)`. From 55d94239456605025396a33972043f6381183b05 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:18:56 +0000 Subject: [PATCH 14/20] Commit via running ake Sources/repos --- Sources/repos/Client.swift | 193 ++-- Sources/repos/Types.swift | 2102 +++++------------------------------- 2 files changed, 377 insertions(+), 1918 deletions(-) diff --git a/Sources/repos/Client.swift b/Sources/repos/Client.swift index c0c630a9b1..9df8fe9989 100644 --- a/Sources/repos/Client.swift +++ b/Sources/repos/Client.swift @@ -151,12 +151,7 @@ public struct Client: APIProtocol { /// /// Creates a new repository in the specified organization. The authenticated user must be a member of the organization. /// - /// **OAuth scope requirements** - /// - /// When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - /// - /// * `public_repo` scope or `repo` scope to create a public repository - /// * `repo` scope to create a private repository + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. /// /// - Remark: HTTP `POST /orgs/{org}/repos`. /// - Remark: Generated from `#/paths//orgs/{org}/repos/post(repos/create-in-org)`. @@ -1396,11 +1391,13 @@ public struct Client: APIProtocol { } /// Delete a repository /// - /// Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + /// Deleting a repository requires admin access. /// /// If an organization owner has configured the organization to prevent members from deleting organization-owned /// repositories, you will get a `403 Forbidden` response. /// + /// OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/delete(repos/delete)`. public func repos_sol_delete(_ input: Operations.repos_sol_delete.Input) async throws -> Operations.repos_sol_delete.Output { @@ -4226,7 +4223,7 @@ public struct Client: APIProtocol { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/get(repos/get-apps-with-access-to-protected-branch)`. @@ -4316,7 +4313,7 @@ public struct Client: APIProtocol { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/post(repos/add-app-access-restrictions)`. @@ -4417,7 +4414,7 @@ public struct Client: APIProtocol { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/put(repos/set-app-access-restrictions)`. @@ -4518,7 +4515,7 @@ public struct Client: APIProtocol { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/delete(repos/remove-app-access-restrictions)`. @@ -5419,17 +5416,9 @@ public struct Client: APIProtocol { /// /// **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". /// - /// The permissions required to use this endpoint depends on whether you are renaming the default branch. - /// - /// To rename a non-default branch: + /// The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. /// - /// * Users must have push access. - /// * GitHub Apps must have the `contents:write` repository permission. - /// - /// To rename the default branch: - /// - /// * Users must have admin or owner permissions. - /// * GitHub Apps must have the `contents:write` and `administration:write` repository permissions. + /// In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/branches/{branch}/rename`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/rename/post(repos/rename-branch)`. @@ -5653,9 +5642,9 @@ public struct Client: APIProtocol { /// /// Team members will include the members of child teams. /// - /// You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - /// endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - /// endpoint. + /// The authenticated user must have push access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/collaborators`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/collaborators/get(repos/list-collaborators)`. @@ -5782,9 +5771,9 @@ public struct Client: APIProtocol { /// /// Team members will include the members of child teams. /// - /// You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - /// endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - /// endpoint. + /// The authenticated user must have push access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/collaborators/{username}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/collaborators/{username}/get(repos/check-collaborator)`. @@ -8046,10 +8035,12 @@ public struct Client: APIProtocol { } /// Create or update file contents /// - /// Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. + /// Creates a new file or replaces an existing file in a repository. /// /// **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. + /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/contents/{path}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/contents/{path}/put(repos/create-or-update-file-contents)`. public func repos_sol_create_hyphen_or_hyphen_update_hyphen_file_hyphen_contents(_ input: Operations.repos_sol_create_hyphen_or_hyphen_update_hyphen_file_hyphen_contents.Input) async throws -> Operations.repos_sol_create_hyphen_or_hyphen_update_hyphen_file_hyphen_contents.Output { @@ -8665,8 +8656,6 @@ public struct Client: APIProtocol { /// be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an /// application with debugging enabled. /// - /// Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - /// /// Merged branch response: /// /// You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating @@ -8688,6 +8677,8 @@ public struct Client: APIProtocol { /// This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` /// status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/deployments/post(repos/create-deployment)`. public func repos_sol_create_hyphen_deployment(_ input: Operations.repos_sol_create_hyphen_deployment.Input) async throws -> Operations.repos_sol_create_hyphen_deployment.Output { @@ -8892,7 +8883,7 @@ public struct Client: APIProtocol { } /// Delete a deployment /// - /// If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. + /// If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. /// /// To set a deployment as inactive, you must: /// @@ -8901,6 +8892,8 @@ public struct Client: APIProtocol { /// /// For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/deployments/{deployment_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/deployments/{deployment_id}/delete(repos/delete-deployment)`. public func repos_sol_delete_hyphen_deployment(_ input: Operations.repos_sol_delete_hyphen_deployment.Input) async throws -> Operations.repos_sol_delete_hyphen_deployment.Output { @@ -9101,7 +9094,7 @@ public struct Client: APIProtocol { /// /// Users with `push` access can create deployment statuses for a given deployment. /// - /// GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/deployments/{deployment_id}/statuses/post(repos/create-deployment-status)`. @@ -9299,13 +9292,10 @@ public struct Client: APIProtocol { /// /// The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. /// - /// This endpoint requires write access to the repository by providing either: - /// - /// - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - /// - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - /// /// This input example shows how you can use the `client_payload` as a test to debug your workflow. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/dispatches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dispatches/post(repos/create-dispatch-event)`. public func repos_sol_create_hyphen_dispatch_hyphen_event(_ input: Operations.repos_sol_create_hyphen_dispatch_hyphen_event.Input) async throws -> Operations.repos_sol_create_hyphen_dispatch_hyphen_event.Output { @@ -9382,7 +9372,9 @@ public struct Client: APIProtocol { /// /// Lists the environments for a repository. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/get(repos/get-all-environments)`. @@ -9463,9 +9455,9 @@ public struct Client: APIProtocol { /// /// **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." /// - /// Anyone with read access to the repository can use this endpoint. If the - /// repository is private, you must use an access token with the `repo` scope. GitHub - /// Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/get(repos/get-environment)`. @@ -9537,7 +9529,7 @@ public struct Client: APIProtocol { /// /// **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/environments/{environment_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/put(repos/create-or-update-environment)`. @@ -9636,7 +9628,7 @@ public struct Client: APIProtocol { } /// Delete an environment /// - /// You must authenticate using an access token with the repo scope to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/environments/{environment_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/delete(repos/delete-an-environment)`. @@ -9680,7 +9672,9 @@ public struct Client: APIProtocol { /// /// Lists the deployment branch policies for an environment. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/get(repos/list-deployment-branch-policies)`. @@ -9762,7 +9756,7 @@ public struct Client: APIProtocol { /// /// Creates a deployment branch or tag policy for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/post(repos/create-deployment-branch-policy)`. @@ -9843,7 +9837,9 @@ public struct Client: APIProtocol { /// /// Gets a deployment branch or tag policy for an environment. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}/get(repos/get-deployment-branch-policy)`. @@ -9912,7 +9908,7 @@ public struct Client: APIProtocol { /// /// Updates a deployment branch or tag policy for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}/put(repos/update-deployment-branch-policy)`. @@ -9990,7 +9986,7 @@ public struct Client: APIProtocol { /// /// Deletes a deployment branch or tag policy for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}/delete(repos/delete-deployment-branch-policy)`. @@ -10033,10 +10029,12 @@ public struct Client: APIProtocol { } /// Get all deployment protection rules for an environment /// - /// Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + /// Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// /// For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/get(repos/get-all-deployment-protection-rules)`. public func repos_sol_get_hyphen_all_hyphen_deployment_hyphen_protection_hyphen_rules(_ input: Operations.repos_sol_get_hyphen_all_hyphen_deployment_hyphen_protection_hyphen_rules.Input) async throws -> Operations.repos_sol_get_hyphen_all_hyphen_deployment_hyphen_protection_hyphen_rules.Output { @@ -10103,10 +10101,12 @@ public struct Client: APIProtocol { /// /// Enable a custom deployment protection rule for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// The authenticated user must have admin or owner permissions to the repository to use this endpoint. /// /// For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/post(repos/create-deployment-protection-rule)`. public func repos_sol_create_hyphen_deployment_hyphen_protection_hyphen_rule(_ input: Operations.repos_sol_create_hyphen_deployment_hyphen_protection_hyphen_rule.Input) async throws -> Operations.repos_sol_create_hyphen_deployment_hyphen_protection_hyphen_rule.Output { @@ -10180,12 +10180,14 @@ public struct Client: APIProtocol { } /// List custom deployment rule integrations available for an environment /// - /// Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. + /// Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. /// /// For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// /// For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps/get(repos/list-custom-deployment-rule-integrations)`. public func repos_sol_list_hyphen_custom_hyphen_deployment_hyphen_rule_hyphen_integrations(_ input: Operations.repos_sol_list_hyphen_custom_hyphen_deployment_hyphen_rule_hyphen_integrations.Input) async throws -> Operations.repos_sol_list_hyphen_custom_hyphen_deployment_hyphen_rule_hyphen_integrations.Output { @@ -10264,10 +10266,12 @@ public struct Client: APIProtocol { } /// Get a custom deployment protection rule /// - /// Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + /// Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// /// For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}/get(repos/get-custom-deployment-protection-rule)`. public func repos_sol_get_hyphen_custom_hyphen_deployment_hyphen_protection_hyphen_rule(_ input: Operations.repos_sol_get_hyphen_custom_hyphen_deployment_hyphen_protection_hyphen_rule.Input) async throws -> Operations.repos_sol_get_hyphen_custom_hyphen_deployment_hyphen_protection_hyphen_rule.Output { @@ -10335,7 +10339,9 @@ public struct Client: APIProtocol { /// /// Disables a custom deployment protection rule for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". + /// The authenticated user must have admin or owner permissions to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}/delete(repos/disable-deployment-protection-rule)`. @@ -11213,7 +11219,7 @@ public struct Client: APIProtocol { /// /// Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." /// - /// Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/hooks/{hook_id}/config/get(repos/get-webhook-config-for-repo)`. @@ -11281,7 +11287,7 @@ public struct Client: APIProtocol { /// /// Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." /// - /// Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + /// OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/hooks/{hook_id}/config/patch(repos/update-webhook-config-for-repo)`. @@ -12662,7 +12668,7 @@ public struct Client: APIProtocol { /// /// Gets information about a GitHub Pages site. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/get(repos/get-pages)`. @@ -12751,7 +12757,9 @@ public struct Client: APIProtocol { /// /// Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/post(repos/create-pages-site)`. @@ -12871,7 +12879,9 @@ public struct Client: APIProtocol { /// /// Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/put(repos/update-information-about-pages-site)`. @@ -13002,7 +13012,9 @@ public struct Client: APIProtocol { /// /// Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/delete(repos/delete-pages-site)`. @@ -13115,7 +13127,7 @@ public struct Client: APIProtocol { /// /// Lists builts of a GitHub Pages site. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/builds`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/builds/get(repos/list-pages-builds)`. @@ -13271,7 +13283,7 @@ public struct Client: APIProtocol { /// /// Gets information about the single most recent build of a GitHub Pages site. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/builds/latest`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/builds/latest/get(repos/get-latest-pages-build)`. @@ -13338,7 +13350,7 @@ public struct Client: APIProtocol { /// /// Gets information about a GitHub Pages build. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/builds/{build_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/builds/{build_id}/get(repos/get-pages-build)`. @@ -13406,7 +13418,7 @@ public struct Client: APIProtocol { /// /// Create a GitHub Pages deployment for a repository. /// - /// Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. + /// The authenticated user must have write permission to the repository. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pages/deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/deployments/post(repos/create-pages-deployment)`. @@ -13557,7 +13569,7 @@ public struct Client: APIProtocol { /// /// Gets the current status of a GitHub Pages deployment. /// - /// Users must have read permission for the GitHub Pages site. GitHub Apps must have the `pages:read` permission. + /// The authenticated user must have read permission for the GitHub Pages site. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/get(repos/get-pages-deployment)`. @@ -13647,7 +13659,7 @@ public struct Client: APIProtocol { /// /// Cancels a GitHub Pages deployment. /// - /// Users must have write permissions for the GitHub Pages site. GitHub Apps must have the `pages:write` permission to use this endpoint. + /// The authenticated user must have write permissions for the GitHub Pages site. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel/post(repos/cancel-pages-deployment)`. @@ -13719,7 +13731,9 @@ public struct Client: APIProtocol { /// /// The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/health`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/health/get(repos/get-pages-health-check)`. @@ -13987,8 +14001,6 @@ public struct Client: APIProtocol { /// Gets all custom property values that are set for a repository. /// Users with read access to the repository can use this endpoint. /// - /// GitHub Apps must have the `metadata:read` repository permission to use this endpoint. - /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/properties/values`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/properties/values/get(repos/get-custom-properties-values)`. public func repos_sol_get_hyphen_custom_hyphen_properties_hyphen_values(_ input: Operations.repos_sol_get_hyphen_custom_hyphen_properties_hyphen_values.Input) async throws -> Operations.repos_sol_get_hyphen_custom_hyphen_properties_hyphen_values.Output { @@ -14101,8 +14113,6 @@ public struct Client: APIProtocol { /// /// Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. /// - /// GitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint. - /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/properties/values`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/properties/values/patch(repos/create-or-update-custom-properties-values)`. public func repos_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values(_ input: Operations.repos_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values.Input) async throws -> Operations.repos_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values.Output { @@ -14185,6 +14195,28 @@ public struct Client: APIProtocol { preconditionFailure("bestContentType chose an invalid content type.") } return .notFound(.init(body: body)) + case 422: + let contentType = converter.extractContentTypeIfPresent(in: response.headerFields) + let body: Components.Responses.validation_failed.Body + let chosenContentType = try converter.bestContentType( + received: contentType, + options: [ + "application/json" + ] + ) + switch chosenContentType { + case "application/json": + body = try await converter.getResponseBodyAsJSON( + Components.Schemas.validation_hyphen_error.self, + from: responseBody, + transforming: { value in + .json(value) + } + ) + default: + preconditionFailure("bestContentType chose an invalid content type.") + } + return .unprocessableContent(.init(body: body)) default: return .undocumented( statusCode: response.status.code, @@ -17462,11 +17494,7 @@ public struct Client: APIProtocol { /// /// For a public repository, a team is listed only if that team added the public repository explicitly. /// - /// Personal access tokens require the following scopes: - /// * `public_repo` to call this endpoint on a public repository - /// * `repo` to call this endpoint on a private repository (this scope also includes public repositories) - /// - /// This endpoint is not compatible with fine-grained personal access tokens. + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/teams`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/teams/get(repos/list-teams)`. @@ -18153,7 +18181,6 @@ public struct Client: APIProtocol { /// Transfer a repository /// /// A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - /// You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/transfer`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/transfer/post(repos/transfer)`. @@ -18407,12 +18434,7 @@ public struct Client: APIProtocol { /// /// Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. /// - /// **OAuth scope requirements** - /// - /// When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - /// - /// * `public_repo` scope or `repo` scope to create a public repository - /// * `repo` scope to create a private repository + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. /// /// - Remark: HTTP `POST /repos/{template_owner}/{template_repo}/generate`. /// - Remark: Generated from `#/paths//repos/{template_owner}/{template_repo}/generate/post(repos/create-using-template)`. @@ -18796,12 +18818,7 @@ public struct Client: APIProtocol { /// /// Creates a new repository for the authenticated user. /// - /// **OAuth scope requirements** - /// - /// When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - /// - /// * `public_repo` scope or `repo` scope to create a public repository - /// * `repo` scope to create a private repository + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. /// /// - Remark: HTTP `POST /user/repos`. /// - Remark: Generated from `#/paths//user/repos/post(repos/create-for-authenticated-user)`. diff --git a/Sources/repos/Types.swift b/Sources/repos/Types.swift index 71be43f7b1..361a8491a1 100644 --- a/Sources/repos/Types.swift +++ b/Sources/repos/Types.swift @@ -24,12 +24,7 @@ public protocol APIProtocol: Sendable { /// /// Creates a new repository in the specified organization. The authenticated user must be a member of the organization. /// - /// **OAuth scope requirements** - /// - /// When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - /// - /// * `public_repo` scope or `repo` scope to create a public repository - /// * `repo` scope to create a private repository + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. /// /// - Remark: HTTP `POST /orgs/{org}/repos`. /// - Remark: Generated from `#/paths//orgs/{org}/repos/post(repos/create-in-org)`. @@ -103,11 +98,13 @@ public protocol APIProtocol: Sendable { func repos_sol_update(_ input: Operations.repos_sol_update.Input) async throws -> Operations.repos_sol_update.Output /// Delete a repository /// - /// Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + /// Deleting a repository requires admin access. /// /// If an organization owner has configured the organization to prevent members from deleting organization-owned /// repositories, you will get a `403 Forbidden` response. /// + /// OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/delete(repos/delete)`. func repos_sol_delete(_ input: Operations.repos_sol_delete.Input) async throws -> Operations.repos_sol_delete.Output @@ -367,7 +364,7 @@ public protocol APIProtocol: Sendable { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/get(repos/get-apps-with-access-to-protected-branch)`. @@ -376,7 +373,7 @@ public protocol APIProtocol: Sendable { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/post(repos/add-app-access-restrictions)`. @@ -385,7 +382,7 @@ public protocol APIProtocol: Sendable { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/put(repos/set-app-access-restrictions)`. @@ -394,7 +391,7 @@ public protocol APIProtocol: Sendable { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/delete(repos/remove-app-access-restrictions)`. @@ -489,17 +486,9 @@ public protocol APIProtocol: Sendable { /// /// **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". /// - /// The permissions required to use this endpoint depends on whether you are renaming the default branch. - /// - /// To rename a non-default branch: - /// - /// * Users must have push access. - /// * GitHub Apps must have the `contents:write` repository permission. + /// The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. /// - /// To rename the default branch: - /// - /// * Users must have admin or owner permissions. - /// * GitHub Apps must have the `contents:write` and `administration:write` repository permissions. + /// In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/branches/{branch}/rename`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/rename/post(repos/rename-branch)`. @@ -522,9 +511,9 @@ public protocol APIProtocol: Sendable { /// /// Team members will include the members of child teams. /// - /// You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - /// endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - /// endpoint. + /// The authenticated user must have push access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/collaborators`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/collaborators/get(repos/list-collaborators)`. @@ -535,9 +524,9 @@ public protocol APIProtocol: Sendable { /// /// Team members will include the members of child teams. /// - /// You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - /// endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - /// endpoint. + /// The authenticated user must have push access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/collaborators/{username}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/collaborators/{username}/get(repos/check-collaborator)`. @@ -911,10 +900,12 @@ public protocol APIProtocol: Sendable { func repos_sol_get_hyphen_content(_ input: Operations.repos_sol_get_hyphen_content.Input) async throws -> Operations.repos_sol_get_hyphen_content.Output /// Create or update file contents /// - /// Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. + /// Creates a new file or replaces an existing file in a repository. /// /// **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. + /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/contents/{path}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/contents/{path}/put(repos/create-or-update-file-contents)`. func repos_sol_create_hyphen_or_hyphen_update_hyphen_file_hyphen_contents(_ input: Operations.repos_sol_create_hyphen_or_hyphen_update_hyphen_file_hyphen_contents.Input) async throws -> Operations.repos_sol_create_hyphen_or_hyphen_update_hyphen_file_hyphen_contents.Output @@ -977,8 +968,6 @@ public protocol APIProtocol: Sendable { /// be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an /// application with debugging enabled. /// - /// Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - /// /// Merged branch response: /// /// You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating @@ -1000,6 +989,8 @@ public protocol APIProtocol: Sendable { /// This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` /// status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/deployments/post(repos/create-deployment)`. func repos_sol_create_hyphen_deployment(_ input: Operations.repos_sol_create_hyphen_deployment.Input) async throws -> Operations.repos_sol_create_hyphen_deployment.Output @@ -1010,7 +1001,7 @@ public protocol APIProtocol: Sendable { func repos_sol_get_hyphen_deployment(_ input: Operations.repos_sol_get_hyphen_deployment.Input) async throws -> Operations.repos_sol_get_hyphen_deployment.Output /// Delete a deployment /// - /// If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. + /// If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. /// /// To set a deployment as inactive, you must: /// @@ -1019,6 +1010,8 @@ public protocol APIProtocol: Sendable { /// /// For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/deployments/{deployment_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/deployments/{deployment_id}/delete(repos/delete-deployment)`. func repos_sol_delete_hyphen_deployment(_ input: Operations.repos_sol_delete_hyphen_deployment.Input) async throws -> Operations.repos_sol_delete_hyphen_deployment.Output @@ -1033,7 +1026,7 @@ public protocol APIProtocol: Sendable { /// /// Users with `push` access can create deployment statuses for a given deployment. /// - /// GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/deployments/{deployment_id}/statuses/post(repos/create-deployment-status)`. @@ -1051,13 +1044,10 @@ public protocol APIProtocol: Sendable { /// /// The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. /// - /// This endpoint requires write access to the repository by providing either: - /// - /// - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - /// - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - /// /// This input example shows how you can use the `client_payload` as a test to debug your workflow. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/dispatches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dispatches/post(repos/create-dispatch-event)`. func repos_sol_create_hyphen_dispatch_hyphen_event(_ input: Operations.repos_sol_create_hyphen_dispatch_hyphen_event.Input) async throws -> Operations.repos_sol_create_hyphen_dispatch_hyphen_event.Output @@ -1065,7 +1055,9 @@ public protocol APIProtocol: Sendable { /// /// Lists the environments for a repository. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/get(repos/get-all-environments)`. @@ -1074,9 +1066,9 @@ public protocol APIProtocol: Sendable { /// /// **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." /// - /// Anyone with read access to the repository can use this endpoint. If the - /// repository is private, you must use an access token with the `repo` scope. GitHub - /// Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/get(repos/get-environment)`. @@ -1089,14 +1081,14 @@ public protocol APIProtocol: Sendable { /// /// **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/environments/{environment_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/put(repos/create-or-update-environment)`. func repos_sol_create_hyphen_or_hyphen_update_hyphen_environment(_ input: Operations.repos_sol_create_hyphen_or_hyphen_update_hyphen_environment.Input) async throws -> Operations.repos_sol_create_hyphen_or_hyphen_update_hyphen_environment.Output /// Delete an environment /// - /// You must authenticate using an access token with the repo scope to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/environments/{environment_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/delete(repos/delete-an-environment)`. @@ -1105,7 +1097,9 @@ public protocol APIProtocol: Sendable { /// /// Lists the deployment branch policies for an environment. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/get(repos/list-deployment-branch-policies)`. @@ -1114,7 +1108,7 @@ public protocol APIProtocol: Sendable { /// /// Creates a deployment branch or tag policy for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/post(repos/create-deployment-branch-policy)`. @@ -1123,7 +1117,9 @@ public protocol APIProtocol: Sendable { /// /// Gets a deployment branch or tag policy for an environment. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}/get(repos/get-deployment-branch-policy)`. @@ -1132,7 +1128,7 @@ public protocol APIProtocol: Sendable { /// /// Updates a deployment branch or tag policy for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}/put(repos/update-deployment-branch-policy)`. @@ -1141,17 +1137,19 @@ public protocol APIProtocol: Sendable { /// /// Deletes a deployment branch or tag policy for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}/delete(repos/delete-deployment-branch-policy)`. func repos_sol_delete_hyphen_deployment_hyphen_branch_hyphen_policy(_ input: Operations.repos_sol_delete_hyphen_deployment_hyphen_branch_hyphen_policy.Input) async throws -> Operations.repos_sol_delete_hyphen_deployment_hyphen_branch_hyphen_policy.Output /// Get all deployment protection rules for an environment /// - /// Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + /// Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// /// For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/get(repos/get-all-deployment-protection-rules)`. func repos_sol_get_hyphen_all_hyphen_deployment_hyphen_protection_hyphen_rules(_ input: Operations.repos_sol_get_hyphen_all_hyphen_deployment_hyphen_protection_hyphen_rules.Input) async throws -> Operations.repos_sol_get_hyphen_all_hyphen_deployment_hyphen_protection_hyphen_rules.Output @@ -1159,30 +1157,36 @@ public protocol APIProtocol: Sendable { /// /// Enable a custom deployment protection rule for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// The authenticated user must have admin or owner permissions to the repository to use this endpoint. /// /// For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/post(repos/create-deployment-protection-rule)`. func repos_sol_create_hyphen_deployment_hyphen_protection_hyphen_rule(_ input: Operations.repos_sol_create_hyphen_deployment_hyphen_protection_hyphen_rule.Input) async throws -> Operations.repos_sol_create_hyphen_deployment_hyphen_protection_hyphen_rule.Output /// List custom deployment rule integrations available for an environment /// - /// Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. + /// Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. /// /// For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// /// For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps/get(repos/list-custom-deployment-rule-integrations)`. func repos_sol_list_hyphen_custom_hyphen_deployment_hyphen_rule_hyphen_integrations(_ input: Operations.repos_sol_list_hyphen_custom_hyphen_deployment_hyphen_rule_hyphen_integrations.Input) async throws -> Operations.repos_sol_list_hyphen_custom_hyphen_deployment_hyphen_rule_hyphen_integrations.Output /// Get a custom deployment protection rule /// - /// Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + /// Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// /// For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}/get(repos/get-custom-deployment-protection-rule)`. func repos_sol_get_hyphen_custom_hyphen_deployment_hyphen_protection_hyphen_rule(_ input: Operations.repos_sol_get_hyphen_custom_hyphen_deployment_hyphen_protection_hyphen_rule.Input) async throws -> Operations.repos_sol_get_hyphen_custom_hyphen_deployment_hyphen_protection_hyphen_rule.Output @@ -1190,7 +1194,9 @@ public protocol APIProtocol: Sendable { /// /// Disables a custom deployment protection rule for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". + /// The authenticated user must have admin or owner permissions to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}/delete(repos/disable-deployment-protection-rule)`. @@ -1249,7 +1255,7 @@ public protocol APIProtocol: Sendable { /// /// Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." /// - /// Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/hooks/{hook_id}/config/get(repos/get-webhook-config-for-repo)`. @@ -1258,7 +1264,7 @@ public protocol APIProtocol: Sendable { /// /// Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." /// - /// Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + /// OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/hooks/{hook_id}/config/patch(repos/update-webhook-config-for-repo)`. @@ -1364,7 +1370,7 @@ public protocol APIProtocol: Sendable { /// /// Gets information about a GitHub Pages site. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/get(repos/get-pages)`. @@ -1373,7 +1379,9 @@ public protocol APIProtocol: Sendable { /// /// Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/post(repos/create-pages-site)`. @@ -1382,7 +1390,9 @@ public protocol APIProtocol: Sendable { /// /// Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/put(repos/update-information-about-pages-site)`. @@ -1391,7 +1401,9 @@ public protocol APIProtocol: Sendable { /// /// Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/delete(repos/delete-pages-site)`. @@ -1400,7 +1412,7 @@ public protocol APIProtocol: Sendable { /// /// Lists builts of a GitHub Pages site. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/builds`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/builds/get(repos/list-pages-builds)`. @@ -1418,7 +1430,7 @@ public protocol APIProtocol: Sendable { /// /// Gets information about the single most recent build of a GitHub Pages site. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/builds/latest`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/builds/latest/get(repos/get-latest-pages-build)`. @@ -1427,7 +1439,7 @@ public protocol APIProtocol: Sendable { /// /// Gets information about a GitHub Pages build. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/builds/{build_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/builds/{build_id}/get(repos/get-pages-build)`. @@ -1436,7 +1448,7 @@ public protocol APIProtocol: Sendable { /// /// Create a GitHub Pages deployment for a repository. /// - /// Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. + /// The authenticated user must have write permission to the repository. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pages/deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/deployments/post(repos/create-pages-deployment)`. @@ -1445,7 +1457,7 @@ public protocol APIProtocol: Sendable { /// /// Gets the current status of a GitHub Pages deployment. /// - /// Users must have read permission for the GitHub Pages site. GitHub Apps must have the `pages:read` permission. + /// The authenticated user must have read permission for the GitHub Pages site. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/get(repos/get-pages-deployment)`. @@ -1454,7 +1466,7 @@ public protocol APIProtocol: Sendable { /// /// Cancels a GitHub Pages deployment. /// - /// Users must have write permissions for the GitHub Pages site. GitHub Apps must have the `pages:write` permission to use this endpoint. + /// The authenticated user must have write permissions for the GitHub Pages site. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel/post(repos/cancel-pages-deployment)`. @@ -1465,7 +1477,9 @@ public protocol APIProtocol: Sendable { /// /// The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/health`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/health/get(repos/get-pages-health-check)`. @@ -1489,8 +1503,6 @@ public protocol APIProtocol: Sendable { /// Gets all custom property values that are set for a repository. /// Users with read access to the repository can use this endpoint. /// - /// GitHub Apps must have the `metadata:read` repository permission to use this endpoint. - /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/properties/values`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/properties/values/get(repos/get-custom-properties-values)`. func repos_sol_get_hyphen_custom_hyphen_properties_hyphen_values(_ input: Operations.repos_sol_get_hyphen_custom_hyphen_properties_hyphen_values.Input) async throws -> Operations.repos_sol_get_hyphen_custom_hyphen_properties_hyphen_values.Output @@ -1501,8 +1513,6 @@ public protocol APIProtocol: Sendable { /// /// Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. /// - /// GitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint. - /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/properties/values`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/properties/values/patch(repos/create-or-update-custom-properties-values)`. func repos_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values(_ input: Operations.repos_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values.Input) async throws -> Operations.repos_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values.Output @@ -1819,11 +1829,7 @@ public protocol APIProtocol: Sendable { /// /// For a public repository, a team is listed only if that team added the public repository explicitly. /// - /// Personal access tokens require the following scopes: - /// * `public_repo` to call this endpoint on a public repository - /// * `repo` to call this endpoint on a private repository (this scope also includes public repositories) - /// - /// This endpoint is not compatible with fine-grained personal access tokens. + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/teams`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/teams/get(repos/list-teams)`. @@ -1869,7 +1875,6 @@ public protocol APIProtocol: Sendable { /// Transfer a repository /// /// A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - /// You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/transfer`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/transfer/post(repos/transfer)`. @@ -1912,12 +1917,7 @@ public protocol APIProtocol: Sendable { /// /// Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. /// - /// **OAuth scope requirements** - /// - /// When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - /// - /// * `public_repo` scope or `repo` scope to create a public repository - /// * `repo` scope to create a private repository + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. /// /// - Remark: HTTP `POST /repos/{template_owner}/{template_repo}/generate`. /// - Remark: Generated from `#/paths//repos/{template_owner}/{template_repo}/generate/post(repos/create-using-template)`. @@ -1946,12 +1946,7 @@ public protocol APIProtocol: Sendable { /// /// Creates a new repository for the authenticated user. /// - /// **OAuth scope requirements** - /// - /// When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - /// - /// * `public_repo` scope or `repo` scope to create a public repository - /// * `repo` scope to create a private repository + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. /// /// - Remark: HTTP `POST /user/repos`. /// - Remark: Generated from `#/paths//user/repos/post(repos/create-for-authenticated-user)`. @@ -2007,12 +2002,7 @@ extension APIProtocol { /// /// Creates a new repository in the specified organization. The authenticated user must be a member of the organization. /// - /// **OAuth scope requirements** - /// - /// When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - /// - /// * `public_repo` scope or `repo` scope to create a public repository - /// * `repo` scope to create a private repository + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. /// /// - Remark: HTTP `POST /orgs/{org}/repos`. /// - Remark: Generated from `#/paths//orgs/{org}/repos/post(repos/create-in-org)`. @@ -2178,11 +2168,13 @@ extension APIProtocol { } /// Delete a repository /// - /// Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + /// Deleting a repository requires admin access. /// /// If an organization owner has configured the organization to prevent members from deleting organization-owned /// repositories, you will get a `403 Forbidden` response. /// + /// OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/delete(repos/delete)`. public func repos_sol_delete( @@ -2692,7 +2684,7 @@ extension APIProtocol { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/get(repos/get-apps-with-access-to-protected-branch)`. @@ -2709,7 +2701,7 @@ extension APIProtocol { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/post(repos/add-app-access-restrictions)`. @@ -2728,7 +2720,7 @@ extension APIProtocol { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/put(repos/set-app-access-restrictions)`. @@ -2747,7 +2739,7 @@ extension APIProtocol { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/delete(repos/remove-app-access-restrictions)`. @@ -2928,17 +2920,9 @@ extension APIProtocol { /// /// **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". /// - /// The permissions required to use this endpoint depends on whether you are renaming the default branch. - /// - /// To rename a non-default branch: - /// - /// * Users must have push access. - /// * GitHub Apps must have the `contents:write` repository permission. - /// - /// To rename the default branch: + /// The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. /// - /// * Users must have admin or owner permissions. - /// * GitHub Apps must have the `contents:write` and `administration:write` repository permissions. + /// In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/branches/{branch}/rename`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/rename/post(repos/rename-branch)`. @@ -2981,9 +2965,9 @@ extension APIProtocol { /// /// Team members will include the members of child teams. /// - /// You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - /// endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - /// endpoint. + /// The authenticated user must have push access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/collaborators`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/collaborators/get(repos/list-collaborators)`. @@ -3004,9 +2988,9 @@ extension APIProtocol { /// /// Team members will include the members of child teams. /// - /// You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - /// endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - /// endpoint. + /// The authenticated user must have push access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/collaborators/{username}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/collaborators/{username}/get(repos/check-collaborator)`. @@ -3550,10 +3534,12 @@ extension APIProtocol { } /// Create or update file contents /// - /// Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. + /// Creates a new file or replaces an existing file in a repository. /// /// **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. + /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/contents/{path}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/contents/{path}/put(repos/create-or-update-file-contents)`. public func repos_sol_create_hyphen_or_hyphen_update_hyphen_file_hyphen_contents( @@ -3656,8 +3642,6 @@ extension APIProtocol { /// be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an /// application with debugging enabled. /// - /// Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - /// /// Merged branch response: /// /// You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating @@ -3679,6 +3663,8 @@ extension APIProtocol { /// This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` /// status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/deployments/post(repos/create-deployment)`. public func repos_sol_create_hyphen_deployment( @@ -3707,7 +3693,7 @@ extension APIProtocol { } /// Delete a deployment /// - /// If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. + /// If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. /// /// To set a deployment as inactive, you must: /// @@ -3716,6 +3702,8 @@ extension APIProtocol { /// /// For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/deployments/{deployment_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/deployments/{deployment_id}/delete(repos/delete-deployment)`. public func repos_sol_delete_hyphen_deployment( @@ -3748,7 +3736,7 @@ extension APIProtocol { /// /// Users with `push` access can create deployment statuses for a given deployment. /// - /// GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/deployments/{deployment_id}/statuses/post(repos/create-deployment-status)`. @@ -3784,13 +3772,10 @@ extension APIProtocol { /// /// The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. /// - /// This endpoint requires write access to the repository by providing either: - /// - /// - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - /// - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - /// /// This input example shows how you can use the `client_payload` as a test to debug your workflow. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/dispatches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dispatches/post(repos/create-dispatch-event)`. public func repos_sol_create_hyphen_dispatch_hyphen_event( @@ -3808,7 +3793,9 @@ extension APIProtocol { /// /// Lists the environments for a repository. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/get(repos/get-all-environments)`. @@ -3827,9 +3814,9 @@ extension APIProtocol { /// /// **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." /// - /// Anyone with read access to the repository can use this endpoint. If the - /// repository is private, you must use an access token with the `repo` scope. GitHub - /// Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/get(repos/get-environment)`. @@ -3850,7 +3837,7 @@ extension APIProtocol { /// /// **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/environments/{environment_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/put(repos/create-or-update-environment)`. @@ -3867,7 +3854,7 @@ extension APIProtocol { } /// Delete an environment /// - /// You must authenticate using an access token with the repo scope to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/environments/{environment_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/delete(repos/delete-an-environment)`. @@ -3878,7 +3865,9 @@ extension APIProtocol { /// /// Lists the deployment branch policies for an environment. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/get(repos/list-deployment-branch-policies)`. @@ -3897,7 +3886,7 @@ extension APIProtocol { /// /// Creates a deployment branch or tag policy for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/post(repos/create-deployment-branch-policy)`. @@ -3916,7 +3905,9 @@ extension APIProtocol { /// /// Gets a deployment branch or tag policy for an environment. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}/get(repos/get-deployment-branch-policy)`. @@ -3933,7 +3924,7 @@ extension APIProtocol { /// /// Updates a deployment branch or tag policy for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}/put(repos/update-deployment-branch-policy)`. @@ -3952,7 +3943,7 @@ extension APIProtocol { /// /// Deletes a deployment branch or tag policy for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}/delete(repos/delete-deployment-branch-policy)`. @@ -3961,10 +3952,12 @@ extension APIProtocol { } /// Get all deployment protection rules for an environment /// - /// Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + /// Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// /// For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/get(repos/get-all-deployment-protection-rules)`. public func repos_sol_get_hyphen_all_hyphen_deployment_hyphen_protection_hyphen_rules( @@ -3980,10 +3973,12 @@ extension APIProtocol { /// /// Enable a custom deployment protection rule for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// The authenticated user must have admin or owner permissions to the repository to use this endpoint. /// /// For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/post(repos/create-deployment-protection-rule)`. public func repos_sol_create_hyphen_deployment_hyphen_protection_hyphen_rule( @@ -3999,12 +3994,14 @@ extension APIProtocol { } /// List custom deployment rule integrations available for an environment /// - /// Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. + /// Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. /// /// For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// /// For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps/get(repos/list-custom-deployment-rule-integrations)`. public func repos_sol_list_hyphen_custom_hyphen_deployment_hyphen_rule_hyphen_integrations( @@ -4020,10 +4017,12 @@ extension APIProtocol { } /// Get a custom deployment protection rule /// - /// Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + /// Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// /// For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}/get(repos/get-custom-deployment-protection-rule)`. public func repos_sol_get_hyphen_custom_hyphen_deployment_hyphen_protection_hyphen_rule( @@ -4039,7 +4038,9 @@ extension APIProtocol { /// /// Disables a custom deployment protection rule for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". + /// The authenticated user must have admin or owner permissions to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}/delete(repos/disable-deployment-protection-rule)`. @@ -4166,7 +4167,7 @@ extension APIProtocol { /// /// Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." /// - /// Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/hooks/{hook_id}/config/get(repos/get-webhook-config-for-repo)`. @@ -4183,7 +4184,7 @@ extension APIProtocol { /// /// Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." /// - /// Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + /// OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/hooks/{hook_id}/config/patch(repos/update-webhook-config-for-repo)`. @@ -4421,7 +4422,7 @@ extension APIProtocol { /// /// Gets information about a GitHub Pages site. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/get(repos/get-pages)`. @@ -4438,7 +4439,9 @@ extension APIProtocol { /// /// Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/post(repos/create-pages-site)`. @@ -4457,7 +4460,9 @@ extension APIProtocol { /// /// Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/put(repos/update-information-about-pages-site)`. @@ -4476,7 +4481,9 @@ extension APIProtocol { /// /// Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/delete(repos/delete-pages-site)`. @@ -4493,7 +4500,7 @@ extension APIProtocol { /// /// Lists builts of a GitHub Pages site. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/builds`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/builds/get(repos/list-pages-builds)`. @@ -4529,7 +4536,7 @@ extension APIProtocol { /// /// Gets information about the single most recent build of a GitHub Pages site. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/builds/latest`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/builds/latest/get(repos/get-latest-pages-build)`. @@ -4546,7 +4553,7 @@ extension APIProtocol { /// /// Gets information about a GitHub Pages build. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/builds/{build_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/builds/{build_id}/get(repos/get-pages-build)`. @@ -4563,7 +4570,7 @@ extension APIProtocol { /// /// Create a GitHub Pages deployment for a repository. /// - /// Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. + /// The authenticated user must have write permission to the repository. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pages/deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/deployments/post(repos/create-pages-deployment)`. @@ -4582,7 +4589,7 @@ extension APIProtocol { /// /// Gets the current status of a GitHub Pages deployment. /// - /// Users must have read permission for the GitHub Pages site. GitHub Apps must have the `pages:read` permission. + /// The authenticated user must have read permission for the GitHub Pages site. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/get(repos/get-pages-deployment)`. @@ -4599,7 +4606,7 @@ extension APIProtocol { /// /// Cancels a GitHub Pages deployment. /// - /// Users must have write permissions for the GitHub Pages site. GitHub Apps must have the `pages:write` permission to use this endpoint. + /// The authenticated user must have write permissions for the GitHub Pages site. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel/post(repos/cancel-pages-deployment)`. @@ -4618,7 +4625,9 @@ extension APIProtocol { /// /// The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/health`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/health/get(repos/get-pages-health-check)`. @@ -4666,8 +4675,6 @@ extension APIProtocol { /// Gets all custom property values that are set for a repository. /// Users with read access to the repository can use this endpoint. /// - /// GitHub Apps must have the `metadata:read` repository permission to use this endpoint. - /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/properties/values`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/properties/values/get(repos/get-custom-properties-values)`. public func repos_sol_get_hyphen_custom_hyphen_properties_hyphen_values( @@ -4686,8 +4693,6 @@ extension APIProtocol { /// /// Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. /// - /// GitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint. - /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/properties/values`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/properties/values/patch(repos/create-or-update-custom-properties-values)`. public func repos_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values( @@ -5306,11 +5311,7 @@ extension APIProtocol { /// /// For a public repository, a team is listed only if that team added the public repository explicitly. /// - /// Personal access tokens require the following scopes: - /// * `public_repo` to call this endpoint on a public repository - /// * `repo` to call this endpoint on a private repository (this scope also includes public repositories) - /// - /// This endpoint is not compatible with fine-grained personal access tokens. + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/teams`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/teams/get(repos/list-teams)`. @@ -5422,7 +5423,6 @@ extension APIProtocol { /// Transfer a repository /// /// A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - /// You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/transfer`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/transfer/post(repos/transfer)`. @@ -5483,12 +5483,7 @@ extension APIProtocol { /// /// Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. /// - /// **OAuth scope requirements** - /// - /// When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - /// - /// * `public_repo` scope or `repo` scope to create a public repository - /// * `repo` scope to create a private repository + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. /// /// - Remark: HTTP `POST /repos/{template_owner}/{template_repo}/generate`. /// - Remark: Generated from `#/paths//repos/{template_owner}/{template_repo}/generate/post(repos/create-using-template)`. @@ -5543,12 +5538,7 @@ extension APIProtocol { /// /// Creates a new repository for the authenticated user. /// - /// **OAuth scope requirements** - /// - /// When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - /// - /// * `public_repo` scope or `repo` scope to create a public repository - /// * `repo` scope to create a private repository + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. /// /// - Remark: HTTP `POST /user/repos`. /// - Remark: Generated from `#/paths//user/repos/post(repos/create-for-authenticated-user)`. @@ -6873,8 +6863,6 @@ public enum Components { public var full_name: Swift.String /// - Remark: Generated from `#/components/schemas/repository/license`. public var license: Components.Schemas.nullable_hyphen_license_hyphen_simple? - /// - Remark: Generated from `#/components/schemas/repository/organization`. - public var organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? /// - Remark: Generated from `#/components/schemas/repository/forks`. public var forks: Swift.Int /// - Remark: Generated from `#/components/schemas/repository/permissions`. @@ -7087,767 +7075,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/repository/allow_rebase_merge`. public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository`. - public struct template_repositoryPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/name`. - public var name: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/full_name`. - public var full_name: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner`. - public struct ownerPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/login`. - public var login: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/avatar_url`. - public var avatar_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/gravatar_id`. - public var gravatar_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/followers_url`. - public var followers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/following_url`. - public var following_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/gists_url`. - public var gists_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/starred_url`. - public var starred_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/subscriptions_url`. - public var subscriptions_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/organizations_url`. - public var organizations_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/repos_url`. - public var repos_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/received_events_url`. - public var received_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/type`. - public var _type: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/site_admin`. - public var site_admin: Swift.Bool? - /// Creates a new `ownerPayload`. - /// - /// - Parameters: - /// - login: - /// - id: - /// - node_id: - /// - avatar_url: - /// - gravatar_id: - /// - url: - /// - html_url: - /// - followers_url: - /// - following_url: - /// - gists_url: - /// - starred_url: - /// - subscriptions_url: - /// - organizations_url: - /// - repos_url: - /// - events_url: - /// - received_events_url: - /// - _type: - /// - site_admin: - public init( - login: Swift.String? = nil, - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - avatar_url: Swift.String? = nil, - gravatar_id: Swift.String? = nil, - url: Swift.String? = nil, - html_url: Swift.String? = nil, - followers_url: Swift.String? = nil, - following_url: Swift.String? = nil, - gists_url: Swift.String? = nil, - starred_url: Swift.String? = nil, - subscriptions_url: Swift.String? = nil, - organizations_url: Swift.String? = nil, - repos_url: Swift.String? = nil, - events_url: Swift.String? = nil, - received_events_url: Swift.String? = nil, - _type: Swift.String? = nil, - site_admin: Swift.Bool? = nil - ) { - self.login = login - self.id = id - self.node_id = node_id - self.avatar_url = avatar_url - self.gravatar_id = gravatar_id - self.url = url - self.html_url = html_url - self.followers_url = followers_url - self.following_url = following_url - self.gists_url = gists_url - self.starred_url = starred_url - self.subscriptions_url = subscriptions_url - self.organizations_url = organizations_url - self.repos_url = repos_url - self.events_url = events_url - self.received_events_url = received_events_url - self._type = _type - self.site_admin = site_admin - } - public enum CodingKeys: String, CodingKey { - case login - case id - case node_id - case avatar_url - case gravatar_id - case url - case html_url - case followers_url - case following_url - case gists_url - case starred_url - case subscriptions_url - case organizations_url - case repos_url - case events_url - case received_events_url - case _type = "type" - case site_admin - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner`. - public var owner: Components.Schemas.repository.template_repositoryPayload.ownerPayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/private`. - public var _private: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/description`. - public var description: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/fork`. - public var fork: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/archive_url`. - public var archive_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/assignees_url`. - public var assignees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/blobs_url`. - public var blobs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/branches_url`. - public var branches_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/collaborators_url`. - public var collaborators_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/comments_url`. - public var comments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/commits_url`. - public var commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/compare_url`. - public var compare_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/contents_url`. - public var contents_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/contributors_url`. - public var contributors_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/deployments_url`. - public var deployments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/downloads_url`. - public var downloads_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/forks_url`. - public var forks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_commits_url`. - public var git_commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_refs_url`. - public var git_refs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_tags_url`. - public var git_tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_url`. - public var git_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issue_comment_url`. - public var issue_comment_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issue_events_url`. - public var issue_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issues_url`. - public var issues_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/keys_url`. - public var keys_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/labels_url`. - public var labels_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/languages_url`. - public var languages_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merges_url`. - public var merges_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/milestones_url`. - public var milestones_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/notifications_url`. - public var notifications_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/pulls_url`. - public var pulls_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/releases_url`. - public var releases_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/ssh_url`. - public var ssh_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/stargazers_url`. - public var stargazers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/statuses_url`. - public var statuses_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscribers_url`. - public var subscribers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscription_url`. - public var subscription_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/tags_url`. - public var tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/teams_url`. - public var teams_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/trees_url`. - public var trees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/clone_url`. - public var clone_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/mirror_url`. - public var mirror_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/hooks_url`. - public var hooks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/svn_url`. - public var svn_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/homepage`. - public var homepage: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/language`. - public var language: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/forks_count`. - public var forks_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/stargazers_count`. - public var stargazers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/watchers_count`. - public var watchers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/size`. - public var size: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/default_branch`. - public var default_branch: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/open_issues_count`. - public var open_issues_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/is_template`. - public var is_template: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/topics`. - public var topics: [Swift.String]? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_issues`. - public var has_issues: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_projects`. - public var has_projects: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_wiki`. - public var has_wiki: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_pages`. - public var has_pages: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_downloads`. - public var has_downloads: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/archived`. - public var archived: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/disabled`. - public var disabled: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/visibility`. - public var visibility: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/pushed_at`. - public var pushed_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/created_at`. - public var created_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/updated_at`. - public var updated_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions`. - public struct permissionsPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/admin`. - public var admin: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/maintain`. - public var maintain: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/push`. - public var push: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/triage`. - public var triage: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/pull`. - public var pull: Swift.Bool? - /// Creates a new `permissionsPayload`. - /// - /// - Parameters: - /// - admin: - /// - maintain: - /// - push: - /// - triage: - /// - pull: - public init( - admin: Swift.Bool? = nil, - maintain: Swift.Bool? = nil, - push: Swift.Bool? = nil, - triage: Swift.Bool? = nil, - pull: Swift.Bool? = nil - ) { - self.admin = admin - self.maintain = maintain - self.push = push - self.triage = triage - self.pull = pull - } - public enum CodingKeys: String, CodingKey { - case admin - case maintain - case push - case triage - case pull - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions`. - public var permissions: Components.Schemas.repository.template_repositoryPayload.permissionsPayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_rebase_merge`. - public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/temp_clone_token`. - public var temp_clone_token: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_squash_merge`. - public var allow_squash_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_auto_merge`. - public var allow_auto_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/delete_branch_on_merge`. - public var delete_branch_on_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_update_branch`. - public var allow_update_branch: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/use_squash_pr_title_as_default`. - public var use_squash_pr_title_as_default: Swift.Bool? - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_title`. - @frozen public enum squash_merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case COMMIT_OR_PR_TITLE = "COMMIT_OR_PR_TITLE" - } - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_title`. - public var squash_merge_commit_title: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_titlePayload? - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_message`. - @frozen public enum squash_merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case COMMIT_MESSAGES = "COMMIT_MESSAGES" - case BLANK = "BLANK" - } - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_message`. - public var squash_merge_commit_message: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_messagePayload? - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_title`. - @frozen public enum merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case MERGE_MESSAGE = "MERGE_MESSAGE" - } - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_title`. - public var merge_commit_title: Components.Schemas.repository.template_repositoryPayload.merge_commit_titlePayload? - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_message`. - @frozen public enum merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case PR_TITLE = "PR_TITLE" - case BLANK = "BLANK" - } - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_message`. - public var merge_commit_message: Components.Schemas.repository.template_repositoryPayload.merge_commit_messagePayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_merge_commit`. - public var allow_merge_commit: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/network_count`. - public var network_count: Swift.Int? - /// Creates a new `template_repositoryPayload`. - /// - /// - Parameters: - /// - id: - /// - node_id: - /// - name: - /// - full_name: - /// - owner: - /// - _private: - /// - html_url: - /// - description: - /// - fork: - /// - url: - /// - archive_url: - /// - assignees_url: - /// - blobs_url: - /// - branches_url: - /// - collaborators_url: - /// - comments_url: - /// - commits_url: - /// - compare_url: - /// - contents_url: - /// - contributors_url: - /// - deployments_url: - /// - downloads_url: - /// - events_url: - /// - forks_url: - /// - git_commits_url: - /// - git_refs_url: - /// - git_tags_url: - /// - git_url: - /// - issue_comment_url: - /// - issue_events_url: - /// - issues_url: - /// - keys_url: - /// - labels_url: - /// - languages_url: - /// - merges_url: - /// - milestones_url: - /// - notifications_url: - /// - pulls_url: - /// - releases_url: - /// - ssh_url: - /// - stargazers_url: - /// - statuses_url: - /// - subscribers_url: - /// - subscription_url: - /// - tags_url: - /// - teams_url: - /// - trees_url: - /// - clone_url: - /// - mirror_url: - /// - hooks_url: - /// - svn_url: - /// - homepage: - /// - language: - /// - forks_count: - /// - stargazers_count: - /// - watchers_count: - /// - size: - /// - default_branch: - /// - open_issues_count: - /// - is_template: - /// - topics: - /// - has_issues: - /// - has_projects: - /// - has_wiki: - /// - has_pages: - /// - has_downloads: - /// - archived: - /// - disabled: - /// - visibility: - /// - pushed_at: - /// - created_at: - /// - updated_at: - /// - permissions: - /// - allow_rebase_merge: - /// - temp_clone_token: - /// - allow_squash_merge: - /// - allow_auto_merge: - /// - delete_branch_on_merge: - /// - allow_update_branch: - /// - use_squash_pr_title_as_default: - /// - squash_merge_commit_title: The default value for a squash merge commit title: - /// - squash_merge_commit_message: The default value for a squash merge commit message: - /// - merge_commit_title: The default value for a merge commit title. - /// - merge_commit_message: The default value for a merge commit message. - /// - allow_merge_commit: - /// - subscribers_count: - /// - network_count: - public init( - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - name: Swift.String? = nil, - full_name: Swift.String? = nil, - owner: Components.Schemas.repository.template_repositoryPayload.ownerPayload? = nil, - _private: Swift.Bool? = nil, - html_url: Swift.String? = nil, - description: Swift.String? = nil, - fork: Swift.Bool? = nil, - url: Swift.String? = nil, - archive_url: Swift.String? = nil, - assignees_url: Swift.String? = nil, - blobs_url: Swift.String? = nil, - branches_url: Swift.String? = nil, - collaborators_url: Swift.String? = nil, - comments_url: Swift.String? = nil, - commits_url: Swift.String? = nil, - compare_url: Swift.String? = nil, - contents_url: Swift.String? = nil, - contributors_url: Swift.String? = nil, - deployments_url: Swift.String? = nil, - downloads_url: Swift.String? = nil, - events_url: Swift.String? = nil, - forks_url: Swift.String? = nil, - git_commits_url: Swift.String? = nil, - git_refs_url: Swift.String? = nil, - git_tags_url: Swift.String? = nil, - git_url: Swift.String? = nil, - issue_comment_url: Swift.String? = nil, - issue_events_url: Swift.String? = nil, - issues_url: Swift.String? = nil, - keys_url: Swift.String? = nil, - labels_url: Swift.String? = nil, - languages_url: Swift.String? = nil, - merges_url: Swift.String? = nil, - milestones_url: Swift.String? = nil, - notifications_url: Swift.String? = nil, - pulls_url: Swift.String? = nil, - releases_url: Swift.String? = nil, - ssh_url: Swift.String? = nil, - stargazers_url: Swift.String? = nil, - statuses_url: Swift.String? = nil, - subscribers_url: Swift.String? = nil, - subscription_url: Swift.String? = nil, - tags_url: Swift.String? = nil, - teams_url: Swift.String? = nil, - trees_url: Swift.String? = nil, - clone_url: Swift.String? = nil, - mirror_url: Swift.String? = nil, - hooks_url: Swift.String? = nil, - svn_url: Swift.String? = nil, - homepage: Swift.String? = nil, - language: Swift.String? = nil, - forks_count: Swift.Int? = nil, - stargazers_count: Swift.Int? = nil, - watchers_count: Swift.Int? = nil, - size: Swift.Int? = nil, - default_branch: Swift.String? = nil, - open_issues_count: Swift.Int? = nil, - is_template: Swift.Bool? = nil, - topics: [Swift.String]? = nil, - has_issues: Swift.Bool? = nil, - has_projects: Swift.Bool? = nil, - has_wiki: Swift.Bool? = nil, - has_pages: Swift.Bool? = nil, - has_downloads: Swift.Bool? = nil, - archived: Swift.Bool? = nil, - disabled: Swift.Bool? = nil, - visibility: Swift.String? = nil, - pushed_at: Swift.String? = nil, - created_at: Swift.String? = nil, - updated_at: Swift.String? = nil, - permissions: Components.Schemas.repository.template_repositoryPayload.permissionsPayload? = nil, - allow_rebase_merge: Swift.Bool? = nil, - temp_clone_token: Swift.String? = nil, - allow_squash_merge: Swift.Bool? = nil, - allow_auto_merge: Swift.Bool? = nil, - delete_branch_on_merge: Swift.Bool? = nil, - allow_update_branch: Swift.Bool? = nil, - use_squash_pr_title_as_default: Swift.Bool? = nil, - squash_merge_commit_title: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_titlePayload? = nil, - squash_merge_commit_message: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_messagePayload? = nil, - merge_commit_title: Components.Schemas.repository.template_repositoryPayload.merge_commit_titlePayload? = nil, - merge_commit_message: Components.Schemas.repository.template_repositoryPayload.merge_commit_messagePayload? = nil, - allow_merge_commit: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil - ) { - self.id = id - self.node_id = node_id - self.name = name - self.full_name = full_name - self.owner = owner - self._private = _private - self.html_url = html_url - self.description = description - self.fork = fork - self.url = url - self.archive_url = archive_url - self.assignees_url = assignees_url - self.blobs_url = blobs_url - self.branches_url = branches_url - self.collaborators_url = collaborators_url - self.comments_url = comments_url - self.commits_url = commits_url - self.compare_url = compare_url - self.contents_url = contents_url - self.contributors_url = contributors_url - self.deployments_url = deployments_url - self.downloads_url = downloads_url - self.events_url = events_url - self.forks_url = forks_url - self.git_commits_url = git_commits_url - self.git_refs_url = git_refs_url - self.git_tags_url = git_tags_url - self.git_url = git_url - self.issue_comment_url = issue_comment_url - self.issue_events_url = issue_events_url - self.issues_url = issues_url - self.keys_url = keys_url - self.labels_url = labels_url - self.languages_url = languages_url - self.merges_url = merges_url - self.milestones_url = milestones_url - self.notifications_url = notifications_url - self.pulls_url = pulls_url - self.releases_url = releases_url - self.ssh_url = ssh_url - self.stargazers_url = stargazers_url - self.statuses_url = statuses_url - self.subscribers_url = subscribers_url - self.subscription_url = subscription_url - self.tags_url = tags_url - self.teams_url = teams_url - self.trees_url = trees_url - self.clone_url = clone_url - self.mirror_url = mirror_url - self.hooks_url = hooks_url - self.svn_url = svn_url - self.homepage = homepage - self.language = language - self.forks_count = forks_count - self.stargazers_count = stargazers_count - self.watchers_count = watchers_count - self.size = size - self.default_branch = default_branch - self.open_issues_count = open_issues_count - self.is_template = is_template - self.topics = topics - self.has_issues = has_issues - self.has_projects = has_projects - self.has_wiki = has_wiki - self.has_pages = has_pages - self.has_downloads = has_downloads - self.archived = archived - self.disabled = disabled - self.visibility = visibility - self.pushed_at = pushed_at - self.created_at = created_at - self.updated_at = updated_at - self.permissions = permissions - self.allow_rebase_merge = allow_rebase_merge - self.temp_clone_token = temp_clone_token - self.allow_squash_merge = allow_squash_merge - self.allow_auto_merge = allow_auto_merge - self.delete_branch_on_merge = delete_branch_on_merge - self.allow_update_branch = allow_update_branch - self.use_squash_pr_title_as_default = use_squash_pr_title_as_default - self.squash_merge_commit_title = squash_merge_commit_title - self.squash_merge_commit_message = squash_merge_commit_message - self.merge_commit_title = merge_commit_title - self.merge_commit_message = merge_commit_message - self.allow_merge_commit = allow_merge_commit - self.subscribers_count = subscribers_count - self.network_count = network_count - } - public enum CodingKeys: String, CodingKey { - case id - case node_id - case name - case full_name - case owner - case _private = "private" - case html_url - case description - case fork - case url - case archive_url - case assignees_url - case blobs_url - case branches_url - case collaborators_url - case comments_url - case commits_url - case compare_url - case contents_url - case contributors_url - case deployments_url - case downloads_url - case events_url - case forks_url - case git_commits_url - case git_refs_url - case git_tags_url - case git_url - case issue_comment_url - case issue_events_url - case issues_url - case keys_url - case labels_url - case languages_url - case merges_url - case milestones_url - case notifications_url - case pulls_url - case releases_url - case ssh_url - case stargazers_url - case statuses_url - case subscribers_url - case subscription_url - case tags_url - case teams_url - case trees_url - case clone_url - case mirror_url - case hooks_url - case svn_url - case homepage - case language - case forks_count - case stargazers_count - case watchers_count - case size - case default_branch - case open_issues_count - case is_template - case topics - case has_issues - case has_projects - case has_wiki - case has_pages - case has_downloads - case archived - case disabled - case visibility - case pushed_at - case created_at - case updated_at - case permissions - case allow_rebase_merge - case temp_clone_token - case allow_squash_merge - case allow_auto_merge - case delete_branch_on_merge - case allow_update_branch - case use_squash_pr_title_as_default - case squash_merge_commit_title - case squash_merge_commit_message - case merge_commit_title - case merge_commit_message - case allow_merge_commit - case subscribers_count - case network_count - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository`. - public var template_repository: Components.Schemas.repository.template_repositoryPayload? /// - Remark: Generated from `#/components/schemas/repository/temp_clone_token`. public var temp_clone_token: Swift.String? /// Whether to allow squash merges for pull requests. @@ -7957,10 +7184,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/repository/web_commit_signoff_required`. public var web_commit_signoff_required: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/network_count`. - public var network_count: Swift.Int? /// - Remark: Generated from `#/components/schemas/repository/open_issues`. public var open_issues: Swift.Int /// - Remark: Generated from `#/components/schemas/repository/watchers`. @@ -7981,7 +7204,6 @@ public enum Components { /// - name: The name of the repository. /// - full_name: /// - license: - /// - organization: /// - forks: /// - permissions: /// - owner: @@ -8054,7 +7276,6 @@ public enum Components { /// - created_at: /// - updated_at: /// - allow_rebase_merge: Whether to allow rebase merges for pull requests. - /// - template_repository: /// - temp_clone_token: /// - allow_squash_merge: Whether to allow squash merges for pull requests. /// - allow_auto_merge: Whether to allow Auto-merge to be used on pull requests. @@ -8068,8 +7289,6 @@ public enum Components { /// - allow_merge_commit: Whether to allow merge commits for pull requests. /// - allow_forking: Whether to allow forking this repo /// - web_commit_signoff_required: Whether to require contributors to sign off on web-based commits - /// - subscribers_count: - /// - network_count: /// - open_issues: /// - watchers: /// - master_branch: @@ -8081,7 +7300,6 @@ public enum Components { name: Swift.String, full_name: Swift.String, license: Components.Schemas.nullable_hyphen_license_hyphen_simple? = nil, - organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? = nil, forks: Swift.Int, permissions: Components.Schemas.repository.permissionsPayload? = nil, owner: Components.Schemas.simple_hyphen_user, @@ -8154,7 +7372,6 @@ public enum Components { created_at: Foundation.Date? = nil, updated_at: Foundation.Date? = nil, allow_rebase_merge: Swift.Bool? = nil, - template_repository: Components.Schemas.repository.template_repositoryPayload? = nil, temp_clone_token: Swift.String? = nil, allow_squash_merge: Swift.Bool? = nil, allow_auto_merge: Swift.Bool? = nil, @@ -8168,8 +7385,6 @@ public enum Components { allow_merge_commit: Swift.Bool? = nil, allow_forking: Swift.Bool? = nil, web_commit_signoff_required: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil, open_issues: Swift.Int, watchers: Swift.Int, master_branch: Swift.String? = nil, @@ -8181,7 +7396,6 @@ public enum Components { self.name = name self.full_name = full_name self.license = license - self.organization = organization self.forks = forks self.permissions = permissions self.owner = owner @@ -8254,7 +7468,6 @@ public enum Components { self.created_at = created_at self.updated_at = updated_at self.allow_rebase_merge = allow_rebase_merge - self.template_repository = template_repository self.temp_clone_token = temp_clone_token self.allow_squash_merge = allow_squash_merge self.allow_auto_merge = allow_auto_merge @@ -8268,8 +7481,6 @@ public enum Components { self.allow_merge_commit = allow_merge_commit self.allow_forking = allow_forking self.web_commit_signoff_required = web_commit_signoff_required - self.subscribers_count = subscribers_count - self.network_count = network_count self.open_issues = open_issues self.watchers = watchers self.master_branch = master_branch @@ -8282,7 +7493,6 @@ public enum Components { case name case full_name case license - case organization case forks case permissions case owner @@ -8355,7 +7565,6 @@ public enum Components { case created_at case updated_at case allow_rebase_merge - case template_repository case temp_clone_token case allow_squash_merge case allow_auto_merge @@ -8369,8 +7578,6 @@ public enum Components { case allow_merge_commit case allow_forking case web_commit_signoff_required - case subscribers_count - case network_count case open_issues case watchers case master_branch @@ -9937,8 +9144,6 @@ public enum Components { public var full_name: Swift.String /// - Remark: Generated from `#/components/schemas/nullable-repository/license`. public var license: Components.Schemas.nullable_hyphen_license_hyphen_simple? - /// - Remark: Generated from `#/components/schemas/nullable-repository/organization`. - public var organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? /// - Remark: Generated from `#/components/schemas/nullable-repository/forks`. public var forks: Swift.Int /// - Remark: Generated from `#/components/schemas/nullable-repository/permissions`. @@ -10151,767 +9356,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/nullable-repository/allow_rebase_merge`. public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository`. - public struct template_repositoryPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/name`. - public var name: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/full_name`. - public var full_name: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner`. - public struct ownerPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/login`. - public var login: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/avatar_url`. - public var avatar_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/gravatar_id`. - public var gravatar_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/followers_url`. - public var followers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/following_url`. - public var following_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/gists_url`. - public var gists_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/starred_url`. - public var starred_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/subscriptions_url`. - public var subscriptions_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/organizations_url`. - public var organizations_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/repos_url`. - public var repos_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/received_events_url`. - public var received_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/type`. - public var _type: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/site_admin`. - public var site_admin: Swift.Bool? - /// Creates a new `ownerPayload`. - /// - /// - Parameters: - /// - login: - /// - id: - /// - node_id: - /// - avatar_url: - /// - gravatar_id: - /// - url: - /// - html_url: - /// - followers_url: - /// - following_url: - /// - gists_url: - /// - starred_url: - /// - subscriptions_url: - /// - organizations_url: - /// - repos_url: - /// - events_url: - /// - received_events_url: - /// - _type: - /// - site_admin: - public init( - login: Swift.String? = nil, - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - avatar_url: Swift.String? = nil, - gravatar_id: Swift.String? = nil, - url: Swift.String? = nil, - html_url: Swift.String? = nil, - followers_url: Swift.String? = nil, - following_url: Swift.String? = nil, - gists_url: Swift.String? = nil, - starred_url: Swift.String? = nil, - subscriptions_url: Swift.String? = nil, - organizations_url: Swift.String? = nil, - repos_url: Swift.String? = nil, - events_url: Swift.String? = nil, - received_events_url: Swift.String? = nil, - _type: Swift.String? = nil, - site_admin: Swift.Bool? = nil - ) { - self.login = login - self.id = id - self.node_id = node_id - self.avatar_url = avatar_url - self.gravatar_id = gravatar_id - self.url = url - self.html_url = html_url - self.followers_url = followers_url - self.following_url = following_url - self.gists_url = gists_url - self.starred_url = starred_url - self.subscriptions_url = subscriptions_url - self.organizations_url = organizations_url - self.repos_url = repos_url - self.events_url = events_url - self.received_events_url = received_events_url - self._type = _type - self.site_admin = site_admin - } - public enum CodingKeys: String, CodingKey { - case login - case id - case node_id - case avatar_url - case gravatar_id - case url - case html_url - case followers_url - case following_url - case gists_url - case starred_url - case subscriptions_url - case organizations_url - case repos_url - case events_url - case received_events_url - case _type = "type" - case site_admin - } - } - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner`. - public var owner: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.ownerPayload? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/private`. - public var _private: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/description`. - public var description: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/fork`. - public var fork: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/archive_url`. - public var archive_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/assignees_url`. - public var assignees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/blobs_url`. - public var blobs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/branches_url`. - public var branches_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/collaborators_url`. - public var collaborators_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/comments_url`. - public var comments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/commits_url`. - public var commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/compare_url`. - public var compare_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/contents_url`. - public var contents_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/contributors_url`. - public var contributors_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/deployments_url`. - public var deployments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/downloads_url`. - public var downloads_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/forks_url`. - public var forks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/git_commits_url`. - public var git_commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/git_refs_url`. - public var git_refs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/git_tags_url`. - public var git_tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/git_url`. - public var git_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/issue_comment_url`. - public var issue_comment_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/issue_events_url`. - public var issue_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/issues_url`. - public var issues_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/keys_url`. - public var keys_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/labels_url`. - public var labels_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/languages_url`. - public var languages_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merges_url`. - public var merges_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/milestones_url`. - public var milestones_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/notifications_url`. - public var notifications_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/pulls_url`. - public var pulls_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/releases_url`. - public var releases_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/ssh_url`. - public var ssh_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/stargazers_url`. - public var stargazers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/statuses_url`. - public var statuses_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/subscribers_url`. - public var subscribers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/subscription_url`. - public var subscription_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/tags_url`. - public var tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/teams_url`. - public var teams_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/trees_url`. - public var trees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/clone_url`. - public var clone_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/mirror_url`. - public var mirror_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/hooks_url`. - public var hooks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/svn_url`. - public var svn_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/homepage`. - public var homepage: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/language`. - public var language: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/forks_count`. - public var forks_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/stargazers_count`. - public var stargazers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/watchers_count`. - public var watchers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/size`. - public var size: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/default_branch`. - public var default_branch: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/open_issues_count`. - public var open_issues_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/is_template`. - public var is_template: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/topics`. - public var topics: [Swift.String]? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_issues`. - public var has_issues: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_projects`. - public var has_projects: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_wiki`. - public var has_wiki: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_pages`. - public var has_pages: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_downloads`. - public var has_downloads: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/archived`. - public var archived: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/disabled`. - public var disabled: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/visibility`. - public var visibility: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/pushed_at`. - public var pushed_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/created_at`. - public var created_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/updated_at`. - public var updated_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions`. - public struct permissionsPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/admin`. - public var admin: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/maintain`. - public var maintain: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/push`. - public var push: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/triage`. - public var triage: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/pull`. - public var pull: Swift.Bool? - /// Creates a new `permissionsPayload`. - /// - /// - Parameters: - /// - admin: - /// - maintain: - /// - push: - /// - triage: - /// - pull: - public init( - admin: Swift.Bool? = nil, - maintain: Swift.Bool? = nil, - push: Swift.Bool? = nil, - triage: Swift.Bool? = nil, - pull: Swift.Bool? = nil - ) { - self.admin = admin - self.maintain = maintain - self.push = push - self.triage = triage - self.pull = pull - } - public enum CodingKeys: String, CodingKey { - case admin - case maintain - case push - case triage - case pull - } - } - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions`. - public var permissions: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.permissionsPayload? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_rebase_merge`. - public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/temp_clone_token`. - public var temp_clone_token: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_squash_merge`. - public var allow_squash_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_auto_merge`. - public var allow_auto_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/delete_branch_on_merge`. - public var delete_branch_on_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_update_branch`. - public var allow_update_branch: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/use_squash_pr_title_as_default`. - public var use_squash_pr_title_as_default: Swift.Bool? - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/squash_merge_commit_title`. - @frozen public enum squash_merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case COMMIT_OR_PR_TITLE = "COMMIT_OR_PR_TITLE" - } - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/squash_merge_commit_title`. - public var squash_merge_commit_title: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.squash_merge_commit_titlePayload? - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/squash_merge_commit_message`. - @frozen public enum squash_merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case COMMIT_MESSAGES = "COMMIT_MESSAGES" - case BLANK = "BLANK" - } - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/squash_merge_commit_message`. - public var squash_merge_commit_message: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.squash_merge_commit_messagePayload? - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merge_commit_title`. - @frozen public enum merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case MERGE_MESSAGE = "MERGE_MESSAGE" - } - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merge_commit_title`. - public var merge_commit_title: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.merge_commit_titlePayload? - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merge_commit_message`. - @frozen public enum merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case PR_TITLE = "PR_TITLE" - case BLANK = "BLANK" - } - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merge_commit_message`. - public var merge_commit_message: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.merge_commit_messagePayload? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_merge_commit`. - public var allow_merge_commit: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/network_count`. - public var network_count: Swift.Int? - /// Creates a new `template_repositoryPayload`. - /// - /// - Parameters: - /// - id: - /// - node_id: - /// - name: - /// - full_name: - /// - owner: - /// - _private: - /// - html_url: - /// - description: - /// - fork: - /// - url: - /// - archive_url: - /// - assignees_url: - /// - blobs_url: - /// - branches_url: - /// - collaborators_url: - /// - comments_url: - /// - commits_url: - /// - compare_url: - /// - contents_url: - /// - contributors_url: - /// - deployments_url: - /// - downloads_url: - /// - events_url: - /// - forks_url: - /// - git_commits_url: - /// - git_refs_url: - /// - git_tags_url: - /// - git_url: - /// - issue_comment_url: - /// - issue_events_url: - /// - issues_url: - /// - keys_url: - /// - labels_url: - /// - languages_url: - /// - merges_url: - /// - milestones_url: - /// - notifications_url: - /// - pulls_url: - /// - releases_url: - /// - ssh_url: - /// - stargazers_url: - /// - statuses_url: - /// - subscribers_url: - /// - subscription_url: - /// - tags_url: - /// - teams_url: - /// - trees_url: - /// - clone_url: - /// - mirror_url: - /// - hooks_url: - /// - svn_url: - /// - homepage: - /// - language: - /// - forks_count: - /// - stargazers_count: - /// - watchers_count: - /// - size: - /// - default_branch: - /// - open_issues_count: - /// - is_template: - /// - topics: - /// - has_issues: - /// - has_projects: - /// - has_wiki: - /// - has_pages: - /// - has_downloads: - /// - archived: - /// - disabled: - /// - visibility: - /// - pushed_at: - /// - created_at: - /// - updated_at: - /// - permissions: - /// - allow_rebase_merge: - /// - temp_clone_token: - /// - allow_squash_merge: - /// - allow_auto_merge: - /// - delete_branch_on_merge: - /// - allow_update_branch: - /// - use_squash_pr_title_as_default: - /// - squash_merge_commit_title: The default value for a squash merge commit title: - /// - squash_merge_commit_message: The default value for a squash merge commit message: - /// - merge_commit_title: The default value for a merge commit title. - /// - merge_commit_message: The default value for a merge commit message. - /// - allow_merge_commit: - /// - subscribers_count: - /// - network_count: - public init( - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - name: Swift.String? = nil, - full_name: Swift.String? = nil, - owner: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.ownerPayload? = nil, - _private: Swift.Bool? = nil, - html_url: Swift.String? = nil, - description: Swift.String? = nil, - fork: Swift.Bool? = nil, - url: Swift.String? = nil, - archive_url: Swift.String? = nil, - assignees_url: Swift.String? = nil, - blobs_url: Swift.String? = nil, - branches_url: Swift.String? = nil, - collaborators_url: Swift.String? = nil, - comments_url: Swift.String? = nil, - commits_url: Swift.String? = nil, - compare_url: Swift.String? = nil, - contents_url: Swift.String? = nil, - contributors_url: Swift.String? = nil, - deployments_url: Swift.String? = nil, - downloads_url: Swift.String? = nil, - events_url: Swift.String? = nil, - forks_url: Swift.String? = nil, - git_commits_url: Swift.String? = nil, - git_refs_url: Swift.String? = nil, - git_tags_url: Swift.String? = nil, - git_url: Swift.String? = nil, - issue_comment_url: Swift.String? = nil, - issue_events_url: Swift.String? = nil, - issues_url: Swift.String? = nil, - keys_url: Swift.String? = nil, - labels_url: Swift.String? = nil, - languages_url: Swift.String? = nil, - merges_url: Swift.String? = nil, - milestones_url: Swift.String? = nil, - notifications_url: Swift.String? = nil, - pulls_url: Swift.String? = nil, - releases_url: Swift.String? = nil, - ssh_url: Swift.String? = nil, - stargazers_url: Swift.String? = nil, - statuses_url: Swift.String? = nil, - subscribers_url: Swift.String? = nil, - subscription_url: Swift.String? = nil, - tags_url: Swift.String? = nil, - teams_url: Swift.String? = nil, - trees_url: Swift.String? = nil, - clone_url: Swift.String? = nil, - mirror_url: Swift.String? = nil, - hooks_url: Swift.String? = nil, - svn_url: Swift.String? = nil, - homepage: Swift.String? = nil, - language: Swift.String? = nil, - forks_count: Swift.Int? = nil, - stargazers_count: Swift.Int? = nil, - watchers_count: Swift.Int? = nil, - size: Swift.Int? = nil, - default_branch: Swift.String? = nil, - open_issues_count: Swift.Int? = nil, - is_template: Swift.Bool? = nil, - topics: [Swift.String]? = nil, - has_issues: Swift.Bool? = nil, - has_projects: Swift.Bool? = nil, - has_wiki: Swift.Bool? = nil, - has_pages: Swift.Bool? = nil, - has_downloads: Swift.Bool? = nil, - archived: Swift.Bool? = nil, - disabled: Swift.Bool? = nil, - visibility: Swift.String? = nil, - pushed_at: Swift.String? = nil, - created_at: Swift.String? = nil, - updated_at: Swift.String? = nil, - permissions: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.permissionsPayload? = nil, - allow_rebase_merge: Swift.Bool? = nil, - temp_clone_token: Swift.String? = nil, - allow_squash_merge: Swift.Bool? = nil, - allow_auto_merge: Swift.Bool? = nil, - delete_branch_on_merge: Swift.Bool? = nil, - allow_update_branch: Swift.Bool? = nil, - use_squash_pr_title_as_default: Swift.Bool? = nil, - squash_merge_commit_title: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.squash_merge_commit_titlePayload? = nil, - squash_merge_commit_message: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.squash_merge_commit_messagePayload? = nil, - merge_commit_title: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.merge_commit_titlePayload? = nil, - merge_commit_message: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.merge_commit_messagePayload? = nil, - allow_merge_commit: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil - ) { - self.id = id - self.node_id = node_id - self.name = name - self.full_name = full_name - self.owner = owner - self._private = _private - self.html_url = html_url - self.description = description - self.fork = fork - self.url = url - self.archive_url = archive_url - self.assignees_url = assignees_url - self.blobs_url = blobs_url - self.branches_url = branches_url - self.collaborators_url = collaborators_url - self.comments_url = comments_url - self.commits_url = commits_url - self.compare_url = compare_url - self.contents_url = contents_url - self.contributors_url = contributors_url - self.deployments_url = deployments_url - self.downloads_url = downloads_url - self.events_url = events_url - self.forks_url = forks_url - self.git_commits_url = git_commits_url - self.git_refs_url = git_refs_url - self.git_tags_url = git_tags_url - self.git_url = git_url - self.issue_comment_url = issue_comment_url - self.issue_events_url = issue_events_url - self.issues_url = issues_url - self.keys_url = keys_url - self.labels_url = labels_url - self.languages_url = languages_url - self.merges_url = merges_url - self.milestones_url = milestones_url - self.notifications_url = notifications_url - self.pulls_url = pulls_url - self.releases_url = releases_url - self.ssh_url = ssh_url - self.stargazers_url = stargazers_url - self.statuses_url = statuses_url - self.subscribers_url = subscribers_url - self.subscription_url = subscription_url - self.tags_url = tags_url - self.teams_url = teams_url - self.trees_url = trees_url - self.clone_url = clone_url - self.mirror_url = mirror_url - self.hooks_url = hooks_url - self.svn_url = svn_url - self.homepage = homepage - self.language = language - self.forks_count = forks_count - self.stargazers_count = stargazers_count - self.watchers_count = watchers_count - self.size = size - self.default_branch = default_branch - self.open_issues_count = open_issues_count - self.is_template = is_template - self.topics = topics - self.has_issues = has_issues - self.has_projects = has_projects - self.has_wiki = has_wiki - self.has_pages = has_pages - self.has_downloads = has_downloads - self.archived = archived - self.disabled = disabled - self.visibility = visibility - self.pushed_at = pushed_at - self.created_at = created_at - self.updated_at = updated_at - self.permissions = permissions - self.allow_rebase_merge = allow_rebase_merge - self.temp_clone_token = temp_clone_token - self.allow_squash_merge = allow_squash_merge - self.allow_auto_merge = allow_auto_merge - self.delete_branch_on_merge = delete_branch_on_merge - self.allow_update_branch = allow_update_branch - self.use_squash_pr_title_as_default = use_squash_pr_title_as_default - self.squash_merge_commit_title = squash_merge_commit_title - self.squash_merge_commit_message = squash_merge_commit_message - self.merge_commit_title = merge_commit_title - self.merge_commit_message = merge_commit_message - self.allow_merge_commit = allow_merge_commit - self.subscribers_count = subscribers_count - self.network_count = network_count - } - public enum CodingKeys: String, CodingKey { - case id - case node_id - case name - case full_name - case owner - case _private = "private" - case html_url - case description - case fork - case url - case archive_url - case assignees_url - case blobs_url - case branches_url - case collaborators_url - case comments_url - case commits_url - case compare_url - case contents_url - case contributors_url - case deployments_url - case downloads_url - case events_url - case forks_url - case git_commits_url - case git_refs_url - case git_tags_url - case git_url - case issue_comment_url - case issue_events_url - case issues_url - case keys_url - case labels_url - case languages_url - case merges_url - case milestones_url - case notifications_url - case pulls_url - case releases_url - case ssh_url - case stargazers_url - case statuses_url - case subscribers_url - case subscription_url - case tags_url - case teams_url - case trees_url - case clone_url - case mirror_url - case hooks_url - case svn_url - case homepage - case language - case forks_count - case stargazers_count - case watchers_count - case size - case default_branch - case open_issues_count - case is_template - case topics - case has_issues - case has_projects - case has_wiki - case has_pages - case has_downloads - case archived - case disabled - case visibility - case pushed_at - case created_at - case updated_at - case permissions - case allow_rebase_merge - case temp_clone_token - case allow_squash_merge - case allow_auto_merge - case delete_branch_on_merge - case allow_update_branch - case use_squash_pr_title_as_default - case squash_merge_commit_title - case squash_merge_commit_message - case merge_commit_title - case merge_commit_message - case allow_merge_commit - case subscribers_count - case network_count - } - } - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository`. - public var template_repository: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload? /// - Remark: Generated from `#/components/schemas/nullable-repository/temp_clone_token`. public var temp_clone_token: Swift.String? /// Whether to allow squash merges for pull requests. @@ -11021,10 +9465,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/nullable-repository/web_commit_signoff_required`. public var web_commit_signoff_required: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/network_count`. - public var network_count: Swift.Int? /// - Remark: Generated from `#/components/schemas/nullable-repository/open_issues`. public var open_issues: Swift.Int /// - Remark: Generated from `#/components/schemas/nullable-repository/watchers`. @@ -11045,7 +9485,6 @@ public enum Components { /// - name: The name of the repository. /// - full_name: /// - license: - /// - organization: /// - forks: /// - permissions: /// - owner: @@ -11118,7 +9557,6 @@ public enum Components { /// - created_at: /// - updated_at: /// - allow_rebase_merge: Whether to allow rebase merges for pull requests. - /// - template_repository: /// - temp_clone_token: /// - allow_squash_merge: Whether to allow squash merges for pull requests. /// - allow_auto_merge: Whether to allow Auto-merge to be used on pull requests. @@ -11132,8 +9570,6 @@ public enum Components { /// - allow_merge_commit: Whether to allow merge commits for pull requests. /// - allow_forking: Whether to allow forking this repo /// - web_commit_signoff_required: Whether to require contributors to sign off on web-based commits - /// - subscribers_count: - /// - network_count: /// - open_issues: /// - watchers: /// - master_branch: @@ -11145,7 +9581,6 @@ public enum Components { name: Swift.String, full_name: Swift.String, license: Components.Schemas.nullable_hyphen_license_hyphen_simple? = nil, - organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? = nil, forks: Swift.Int, permissions: Components.Schemas.nullable_hyphen_repository.permissionsPayload? = nil, owner: Components.Schemas.simple_hyphen_user, @@ -11218,7 +9653,6 @@ public enum Components { created_at: Foundation.Date? = nil, updated_at: Foundation.Date? = nil, allow_rebase_merge: Swift.Bool? = nil, - template_repository: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload? = nil, temp_clone_token: Swift.String? = nil, allow_squash_merge: Swift.Bool? = nil, allow_auto_merge: Swift.Bool? = nil, @@ -11232,8 +9666,6 @@ public enum Components { allow_merge_commit: Swift.Bool? = nil, allow_forking: Swift.Bool? = nil, web_commit_signoff_required: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil, open_issues: Swift.Int, watchers: Swift.Int, master_branch: Swift.String? = nil, @@ -11245,7 +9677,6 @@ public enum Components { self.name = name self.full_name = full_name self.license = license - self.organization = organization self.forks = forks self.permissions = permissions self.owner = owner @@ -11318,7 +9749,6 @@ public enum Components { self.created_at = created_at self.updated_at = updated_at self.allow_rebase_merge = allow_rebase_merge - self.template_repository = template_repository self.temp_clone_token = temp_clone_token self.allow_squash_merge = allow_squash_merge self.allow_auto_merge = allow_auto_merge @@ -11332,8 +9762,6 @@ public enum Components { self.allow_merge_commit = allow_merge_commit self.allow_forking = allow_forking self.web_commit_signoff_required = web_commit_signoff_required - self.subscribers_count = subscribers_count - self.network_count = network_count self.open_issues = open_issues self.watchers = watchers self.master_branch = master_branch @@ -11346,7 +9774,6 @@ public enum Components { case name case full_name case license - case organization case forks case permissions case owner @@ -11419,7 +9846,6 @@ public enum Components { case created_at case updated_at case allow_rebase_merge - case template_repository case temp_clone_token case allow_squash_merge case allow_auto_merge @@ -11433,8 +9859,6 @@ public enum Components { case allow_merge_commit case allow_forking case web_commit_signoff_required - case subscribers_count - case network_count case open_issues case watchers case master_branch @@ -23451,12 +21875,7 @@ public enum Operations { /// /// Creates a new repository in the specified organization. The authenticated user must be a member of the organization. /// - /// **OAuth scope requirements** - /// - /// When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - /// - /// * `public_repo` scope or `repo` scope to create a public repository - /// * `repo` scope to create a private repository + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. /// /// - Remark: HTTP `POST /orgs/{org}/repos`. /// - Remark: Generated from `#/paths//orgs/{org}/repos/post(repos/create-in-org)`. @@ -26302,11 +24721,13 @@ public enum Operations { } /// Delete a repository /// - /// Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required. + /// Deleting a repository requires admin access. /// /// If an organization owner has configured the organization to prevent members from deleting organization-owned /// repositories, you will get a `403 Forbidden` response. /// + /// OAuth app tokens and personal access tokens (classic) need the `delete_repo` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/delete(repos/delete)`. public enum repos_sol_delete { @@ -32441,7 +30862,7 @@ public enum Operations { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Lists the GitHub Apps that have push access to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/get(repos/get-apps-with-access-to-protected-branch)`. @@ -32614,7 +31035,7 @@ public enum Operations { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Grants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Grants the specified apps push access for this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/post(repos/add-app-access-restrictions)`. @@ -32848,7 +31269,7 @@ public enum Operations { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Replaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/put(repos/set-app-access-restrictions)`. @@ -33082,7 +31503,7 @@ public enum Operations { /// /// Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. /// - /// Removes the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. + /// Removes the ability of an app to push to this branch. Only GitHub Apps that are installed on the repository and that have been granted write access to the repository contents can be added as authorized actors on a protected branch. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps/delete(repos/remove-app-access-restrictions)`. @@ -35086,17 +33507,9 @@ public enum Operations { /// /// **Note:** Although the API responds immediately, the branch rename process might take some extra time to complete in the background. You won't be able to push to the old branch name while the rename process is in progress. For more information, see "[Renaming a branch](https://docs.github.com/github/administering-a-repository/renaming-a-branch)". /// - /// The permissions required to use this endpoint depends on whether you are renaming the default branch. - /// - /// To rename a non-default branch: + /// The authenticated user must have push access to the branch. If the branch is the default branch, the authenticated user must also have admin or owner permissions. /// - /// * Users must have push access. - /// * GitHub Apps must have the `contents:write` repository permission. - /// - /// To rename the default branch: - /// - /// * Users must have admin or owner permissions. - /// * GitHub Apps must have the `contents:write` and `administration:write` repository permissions. + /// In order to rename the default branch, fine-grained access tokens also need the `administration:write` repository permission. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/branches/{branch}/rename`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/branches/{branch}/rename/post(repos/rename-branch)`. @@ -35534,9 +33947,9 @@ public enum Operations { /// /// Team members will include the members of child teams. /// - /// You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - /// endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - /// endpoint. + /// The authenticated user must have push access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/collaborators`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/collaborators/get(repos/list-collaborators)`. @@ -35778,9 +34191,9 @@ public enum Operations { /// /// Team members will include the members of child teams. /// - /// You must authenticate using an access token with the `read:org` and `repo` scopes with push access to use this - /// endpoint. GitHub Apps must have the `members` organization permission and `metadata` repository permission to use this - /// endpoint. + /// The authenticated user must have push access to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:org` and `repo` scopes to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/collaborators/{username}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/collaborators/{username}/get(repos/check-collaborator)`. @@ -39961,10 +38374,12 @@ public enum Operations { } /// Create or update file contents /// - /// Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint. If you want to modify files in the `.github/workflows` directory, you must authenticate using an access token with the `workflow` scope. + /// Creates a new file or replaces an existing file in a repository. /// /// **Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory. + /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/contents/{path}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/contents/{path}/put(repos/create-or-update-file-contents)`. public enum repos_sol_create_hyphen_or_hyphen_update_hyphen_file_hyphen_contents { @@ -41245,8 +39660,6 @@ public enum Operations { /// be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an /// application with debugging enabled. /// - /// Users with `repo` or `repo_deployment` scopes can create a deployment for a given ref. - /// /// Merged branch response: /// /// You will see this response when GitHub automatically merges the base branch into the topic branch instead of creating @@ -41268,6 +39681,8 @@ public enum Operations { /// This error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` /// status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/deployments/post(repos/create-deployment)`. public enum repos_sol_create_hyphen_deployment { @@ -41837,7 +40252,7 @@ public enum Operations { } /// Delete a deployment /// - /// If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. Anyone with `repo` or `repo_deployment` scopes can delete a deployment. + /// If the repository only has one deployment, you can delete the deployment regardless of its status. If the repository has more than one deployment, you can only delete inactive deployments. This ensures that repositories with multiple deployments will always have an active deployment. /// /// To set a deployment as inactive, you must: /// @@ -41846,6 +40261,8 @@ public enum Operations { /// /// For more information, see "[Create a deployment](https://docs.github.com/rest/deployments/deployments/#create-a-deployment)" and "[Create a deployment status](https://docs.github.com/rest/deployments/statuses#create-a-deployment-status)." /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repo_deployment` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/deployments/{deployment_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/deployments/{deployment_id}/delete(repos/delete-deployment)`. public enum repos_sol_delete_hyphen_deployment { @@ -42233,7 +40650,7 @@ public enum Operations { /// /// Users with `push` access can create deployment statuses for a given deployment. /// - /// GitHub Apps require `read & write` access to "Deployments" and `read-only` access to "Repo contents" (for private repos). OAuth apps require the `repo_deployment` scope. + /// OAuth app tokens and personal access tokens (classic) need the `repo_deployment` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/deployments/{deployment_id}/statuses/post(repos/create-deployment-status)`. @@ -42691,13 +41108,10 @@ public enum Operations { /// /// The `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. /// - /// This endpoint requires write access to the repository by providing either: - /// - /// - Personal access tokens with `repo` scope. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)" in the GitHub Help documentation. - /// - GitHub Apps with both `metadata:read` and `contents:read&write` permissions. - /// /// This input example shows how you can use the `client_payload` as a test to debug your workflow. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/dispatches`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/dispatches/post(repos/create-dispatch-event)`. public enum repos_sol_create_hyphen_dispatch_hyphen_event { @@ -42894,7 +41308,9 @@ public enum Operations { /// /// Lists the environments for a repository. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/get(repos/get-all-environments)`. @@ -43089,9 +41505,9 @@ public enum Operations { /// /// **Note:** To get information about name patterns that branches must match in order to deploy to this environment, see "[Get a deployment branch policy](/rest/deployments/branch-policies#get-a-deployment-branch-policy)." /// - /// Anyone with read access to the repository can use this endpoint. If the - /// repository is private, you must use an access token with the `repo` scope. GitHub - /// Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/get(repos/get-environment)`. @@ -43245,7 +41661,7 @@ public enum Operations { /// /// **Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)." /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/environments/{environment_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/put(repos/create-or-update-environment)`. @@ -43544,7 +41960,7 @@ public enum Operations { } /// Delete an environment /// - /// You must authenticate using an access token with the repo scope to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/environments/{environment_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/delete(repos/delete-an-environment)`. @@ -43628,7 +42044,9 @@ public enum Operations { /// /// Lists the deployment branch policies for an environment. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/get(repos/list-deployment-branch-policies)`. @@ -43830,7 +42248,7 @@ public enum Operations { /// /// Creates a deployment branch or tag policy for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/post(repos/create-deployment-branch-policy)`. @@ -44043,7 +42461,9 @@ public enum Operations { /// /// Gets a deployment branch or tag policy for an environment. /// - /// Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. + /// Anyone with read access to the repository can use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}/get(repos/get-deployment-branch-policy)`. @@ -44200,7 +42620,7 @@ public enum Operations { /// /// Updates a deployment branch or tag policy for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}/put(repos/update-deployment-branch-policy)`. @@ -44366,7 +42786,7 @@ public enum Operations { /// /// Deletes a deployment branch or tag policy for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration:write` permission for the repository to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}/delete(repos/delete-deployment-branch-policy)`. @@ -44455,10 +42875,12 @@ public enum Operations { } /// Get all deployment protection rules for an environment /// - /// Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + /// Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// /// For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/get(repos/get-all-deployment-protection-rules)`. public enum repos_sol_get_hyphen_all_hyphen_deployment_hyphen_protection_hyphen_rules { @@ -44632,10 +43054,12 @@ public enum Operations { /// /// Enable a custom deployment protection rule for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. + /// The authenticated user must have admin or owner permissions to the repository to use this endpoint. /// /// For more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/rest/apps/apps#get-an-app). /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/post(repos/create-deployment-protection-rule)`. public enum repos_sol_create_hyphen_deployment_hyphen_protection_hyphen_rule { @@ -44808,12 +43232,14 @@ public enum Operations { } /// List custom deployment rule integrations available for an environment /// - /// Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. + /// Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. /// /// For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// /// For more information about the app that is providing this custom deployment rule, see "[GET an app](https://docs.github.com/rest/apps/apps#get-an-app)". /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps/get(repos/list-custom-deployment-rule-integrations)`. public enum repos_sol_list_hyphen_custom_hyphen_deployment_hyphen_rule_hyphen_integrations { @@ -45012,10 +43438,12 @@ public enum Operations { } /// Get a custom deployment protection rule /// - /// Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." + /// Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. For more information about environments, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)." /// /// For more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/rest/apps/apps#get-an-app). /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}/get(repos/get-custom-deployment-protection-rule)`. public enum repos_sol_get_hyphen_custom_hyphen_deployment_hyphen_protection_hyphen_rule { @@ -45171,7 +43599,9 @@ public enum Operations { /// /// Disables a custom deployment protection rule for an environment. /// - /// You must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Get an app](https://docs.github.com/rest/apps/apps#get-an-app)". + /// The authenticated user must have admin or owner permissions to the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}/delete(repos/disable-deployment-protection-rule)`. @@ -46899,7 +45329,7 @@ public enum Operations { /// /// Returns the webhook configuration for a repository. To get more information about the webhook, including the `active` state and `events`, use "[Get a repository webhook](/rest/webhooks/repos#get-a-repository-webhook)." /// - /// Access tokens must have the `read:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `read:repo_hook` or `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/hooks/{hook_id}/config/get(repos/get-webhook-config-for-repo)`. @@ -47049,7 +45479,7 @@ public enum Operations { /// /// Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)." /// - /// Access tokens must have the `write:repo_hook` or `repo` scope, and GitHub Apps must have the `repository_hooks:write` permission. + /// OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/hooks/{hook_id}/config/patch(repos/update-webhook-config-for-repo)`. @@ -49964,7 +48394,7 @@ public enum Operations { /// /// Gets information about a GitHub Pages site. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/get(repos/get-pages)`. @@ -50130,7 +48560,9 @@ public enum Operations { /// /// Configures a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages)." /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/post(repos/create-pages-site)`. @@ -50385,7 +48817,9 @@ public enum Operations { /// /// Updates information for a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/put(repos/update-information-about-pages-site)`. @@ -50694,7 +49128,9 @@ public enum Operations { /// /// Deletes a GitHub Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages). /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administration:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/pages`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/delete(repos/delete-pages-site)`. @@ -50882,7 +49318,7 @@ public enum Operations { /// /// Lists builts of a GitHub Pages site. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/builds`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/builds/get(repos/list-pages-builds)`. @@ -51214,7 +49650,7 @@ public enum Operations { /// /// Gets information about the single most recent build of a GitHub Pages site. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/builds/latest`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/builds/latest/get(repos/get-latest-pages-build)`. @@ -51357,7 +49793,7 @@ public enum Operations { /// /// Gets information about a GitHub Pages build. /// - /// A token with the `repo` scope is required. GitHub Apps must have the `pages:read` permission. + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/builds/{build_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/builds/{build_id}/get(repos/get-pages-build)`. @@ -51505,7 +49941,7 @@ public enum Operations { /// /// Create a GitHub Pages deployment for a repository. /// - /// Users must have write permissions. GitHub Apps must have the `pages:write` permission to use this endpoint. + /// The authenticated user must have write permission to the repository. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pages/deployments`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/deployments/post(repos/create-pages-deployment)`. @@ -51785,7 +50221,7 @@ public enum Operations { /// /// Gets the current status of a GitHub Pages deployment. /// - /// Users must have read permission for the GitHub Pages site. GitHub Apps must have the `pages:read` permission. + /// The authenticated user must have read permission for the GitHub Pages site. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/get(repos/get-pages-deployment)`. @@ -51993,7 +50429,7 @@ public enum Operations { /// /// Cancels a GitHub Pages deployment. /// - /// Users must have write permissions for the GitHub Pages site. GitHub Apps must have the `pages:write` permission to use this endpoint. + /// The authenticated user must have write permissions for the GitHub Pages site. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/deployments/{pages_deployment_id}/cancel/post(repos/cancel-pages-deployment)`. @@ -52175,7 +50611,9 @@ public enum Operations { /// /// The first request to this endpoint returns a `202 Accepted` status and starts an asynchronous background task to get the results for the domain. After the background task completes, subsequent requests to this endpoint return a `200 OK` status with the health check results in the response. /// - /// To use this endpoint, you must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission. A token with the `repo` scope or Pages write permission is required. GitHub Apps must have the `administrative:write` and `pages:write` permissions. + /// The authenticated user must be a repository administrator, maintainer, or have the 'manage GitHub Pages settings' permission to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/pages/health`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pages/health/get(repos/get-pages-health-check)`. @@ -52731,8 +51169,6 @@ public enum Operations { /// Gets all custom property values that are set for a repository. /// Users with read access to the repository can use this endpoint. /// - /// GitHub Apps must have the `metadata:read` repository permission to use this endpoint. - /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/properties/values`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/properties/values/get(repos/get-custom-properties-values)`. public enum repos_sol_get_hyphen_custom_hyphen_properties_hyphen_values { @@ -52923,8 +51359,6 @@ public enum Operations { /// /// Repository admins and other users with the repository-level "edit custom property values" fine-grained permission can use this endpoint. /// - /// GitHub Apps must have the `repository_custom_properties:write` permission to use this endpoint. - /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/properties/values`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/properties/values/patch(repos/create-or-update-custom-properties-values)`. public enum repos_sol_create_hyphen_or_hyphen_update_hyphen_custom_hyphen_properties_hyphen_values { @@ -53079,6 +51513,29 @@ public enum Operations { } } } + /// Validation failed, or the endpoint has been spammed. + /// + /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/properties/values/patch(repos/create-or-update-custom-properties-values)/responses/422`. + /// + /// HTTP response code: `422 unprocessableContent`. + case unprocessableContent(Components.Responses.validation_failed) + /// The associated value of the enum case if `self` is `.unprocessableContent`. + /// + /// - Throws: An error if `self` is not `.unprocessableContent`. + /// - SeeAlso: `.unprocessableContent`. + public var unprocessableContent: Components.Responses.validation_failed { + get throws { + switch self { + case let .unprocessableContent(response): + return response + default: + try throwUnexpectedResponseStatus( + expectedStatus: "unprocessableContent", + response: self + ) + } + } + } /// Undocumented response. /// /// A response with a code that is not documented in the OpenAPI document. @@ -59845,11 +58302,7 @@ public enum Operations { /// /// For a public repository, a team is listed only if that team added the public repository explicitly. /// - /// Personal access tokens require the following scopes: - /// * `public_repo` to call this endpoint on a public repository - /// * `repo` to call this endpoint on a private repository (this scope also includes public repositories) - /// - /// This endpoint is not compatible with fine-grained personal access tokens. + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to use this endpoint with a public repository, and `repo` scope to use this endpoint with a private repository. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/teams`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/teams/get(repos/list-teams)`. @@ -61162,7 +59615,6 @@ public enum Operations { /// Transfer a repository /// /// A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://docs.github.com/articles/about-repository-transfers/). - /// You must use a personal access token (classic) or an OAuth token for this endpoint. An installation access token or a fine-grained personal access token cannot be used because they are only granted access to a single account. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/transfer`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/transfer/post(repos/transfer)`. @@ -61706,12 +60158,7 @@ public enum Operations { /// /// Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. If the repository is not public, the authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint and check that the `is_template` key is `true`. /// - /// **OAuth scope requirements** - /// - /// When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - /// - /// * `public_repo` scope or `repo` scope to create a public repository - /// * `repo` scope to create a private repository + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. /// /// - Remark: HTTP `POST /repos/{template_owner}/{template_repo}/generate`. /// - Remark: Generated from `#/paths//repos/{template_owner}/{template_repo}/generate/post(repos/create-using-template)`. @@ -62447,12 +60894,7 @@ public enum Operations { /// /// Creates a new repository for the authenticated user. /// - /// **OAuth scope requirements** - /// - /// When using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include: - /// - /// * `public_repo` scope or `repo` scope to create a public repository - /// * `repo` scope to create a private repository + /// OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository. /// /// - Remark: HTTP `POST /user/repos`. /// - Remark: Generated from `#/paths//user/repos/post(repos/create-for-authenticated-user)`. From 1f70a858b80b5a66a78ef9367d30cb3a4163d649 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:19:37 +0000 Subject: [PATCH 15/20] Commit via running ake Sources/secret-scanning --- Sources/secret-scanning/Client.swift | 37 +++++---- Sources/secret-scanning/Types.swift | 111 +++++++++++++++------------ 2 files changed, 84 insertions(+), 64 deletions(-) diff --git a/Sources/secret-scanning/Client.swift b/Sources/secret-scanning/Client.swift index 4a6b113c61..82e6c56bbc 100644 --- a/Sources/secret-scanning/Client.swift +++ b/Sources/secret-scanning/Client.swift @@ -41,7 +41,12 @@ public struct Client: APIProtocol { /// List secret scanning alerts for an enterprise /// /// Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - /// To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + /// + /// Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + /// + /// The authenticated user must be a member of the enterprise in order to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. /// /// - Remark: HTTP `GET /enterprises/{enterprise}/secret-scanning/alerts`. /// - Remark: Generated from `#/paths//enterprises/{enterprise}/secret-scanning/alerts/get(secret-scanning/list-alerts-for-enterprise)`. @@ -221,10 +226,10 @@ public struct Client: APIProtocol { /// List secret scanning alerts for an organization /// /// Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - /// To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator or security manager for the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /orgs/{org}/secret-scanning/alerts`. /// - Remark: Generated from `#/paths//orgs/{org}/secret-scanning/alerts/get(secret-scanning/list-alerts-for-org)`. @@ -411,10 +416,10 @@ public struct Client: APIProtocol { /// List secret scanning alerts for a repository /// /// Lists secret scanning alerts for an eligible repository, from newest to oldest. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/secret-scanning/alerts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/get(secret-scanning/list-alerts-for-repo)`. @@ -574,10 +579,10 @@ public struct Client: APIProtocol { /// Get a secret scanning alert /// /// Gets a single secret scanning alert detected in an eligible repository. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/get(secret-scanning/get-alert)`. @@ -670,10 +675,10 @@ public struct Client: APIProtocol { /// Update a secret scanning alert /// /// Updates the status of a secret scanning alert in an eligible repository. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/patch(secret-scanning/update-alert)`. @@ -777,10 +782,10 @@ public struct Client: APIProtocol { /// List locations for a secret scanning alert /// /// Lists all locations for a given secret scanning alert for an eligible repository. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations/get(secret-scanning/list-locations-for-alert)`. diff --git a/Sources/secret-scanning/Types.swift b/Sources/secret-scanning/Types.swift index e20b799578..1c6914e74d 100644 --- a/Sources/secret-scanning/Types.swift +++ b/Sources/secret-scanning/Types.swift @@ -14,7 +14,12 @@ public protocol APIProtocol: Sendable { /// List secret scanning alerts for an enterprise /// /// Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - /// To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + /// + /// Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + /// + /// The authenticated user must be a member of the enterprise in order to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. /// /// - Remark: HTTP `GET /enterprises/{enterprise}/secret-scanning/alerts`. /// - Remark: Generated from `#/paths//enterprises/{enterprise}/secret-scanning/alerts/get(secret-scanning/list-alerts-for-enterprise)`. @@ -22,10 +27,10 @@ public protocol APIProtocol: Sendable { /// List secret scanning alerts for an organization /// /// Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - /// To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator or security manager for the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /orgs/{org}/secret-scanning/alerts`. /// - Remark: Generated from `#/paths//orgs/{org}/secret-scanning/alerts/get(secret-scanning/list-alerts-for-org)`. @@ -33,10 +38,10 @@ public protocol APIProtocol: Sendable { /// List secret scanning alerts for a repository /// /// Lists secret scanning alerts for an eligible repository, from newest to oldest. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/secret-scanning/alerts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/get(secret-scanning/list-alerts-for-repo)`. @@ -44,10 +49,10 @@ public protocol APIProtocol: Sendable { /// Get a secret scanning alert /// /// Gets a single secret scanning alert detected in an eligible repository. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/get(secret-scanning/get-alert)`. @@ -55,10 +60,10 @@ public protocol APIProtocol: Sendable { /// Update a secret scanning alert /// /// Updates the status of a secret scanning alert in an eligible repository. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/patch(secret-scanning/update-alert)`. @@ -66,10 +71,10 @@ public protocol APIProtocol: Sendable { /// List locations for a secret scanning alert /// /// Lists all locations for a given secret scanning alert for an eligible repository. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations/get(secret-scanning/list-locations-for-alert)`. @@ -81,7 +86,12 @@ extension APIProtocol { /// List secret scanning alerts for an enterprise /// /// Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - /// To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + /// + /// Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + /// + /// The authenticated user must be a member of the enterprise in order to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. /// /// - Remark: HTTP `GET /enterprises/{enterprise}/secret-scanning/alerts`. /// - Remark: Generated from `#/paths//enterprises/{enterprise}/secret-scanning/alerts/get(secret-scanning/list-alerts-for-enterprise)`. @@ -99,10 +109,10 @@ extension APIProtocol { /// List secret scanning alerts for an organization /// /// Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - /// To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator or security manager for the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /orgs/{org}/secret-scanning/alerts`. /// - Remark: Generated from `#/paths//orgs/{org}/secret-scanning/alerts/get(secret-scanning/list-alerts-for-org)`. @@ -120,10 +130,10 @@ extension APIProtocol { /// List secret scanning alerts for a repository /// /// Lists secret scanning alerts for an eligible repository, from newest to oldest. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/secret-scanning/alerts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/get(secret-scanning/list-alerts-for-repo)`. @@ -141,10 +151,10 @@ extension APIProtocol { /// Get a secret scanning alert /// /// Gets a single secret scanning alert detected in an eligible repository. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/get(secret-scanning/get-alert)`. @@ -160,10 +170,10 @@ extension APIProtocol { /// Update a secret scanning alert /// /// Updates the status of a secret scanning alert in an eligible repository. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/patch(secret-scanning/update-alert)`. @@ -181,10 +191,10 @@ extension APIProtocol { /// List locations for a secret scanning alert /// /// Lists all locations for a given secret scanning alert for an eligible repository. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations/get(secret-scanning/list-locations-for-alert)`. @@ -1907,7 +1917,12 @@ public enum Operations { /// List secret scanning alerts for an enterprise /// /// Lists secret scanning alerts for eligible repositories in an enterprise, from newest to oldest. - /// To use this endpoint, you must be a member of the enterprise, and you must use an access token with the `repo` scope or `security_events` scope. Alerts are only returned for organizations in the enterprise for which you are an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + /// + /// Alerts are only returned for organizations in the enterprise for which the authenticated user is an organization owner or a [security manager](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization). + /// + /// The authenticated user must be a member of the enterprise in order to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope or `security_events` scope to use this endpoint. /// /// - Remark: HTTP `GET /enterprises/{enterprise}/secret-scanning/alerts`. /// - Remark: Generated from `#/paths//enterprises/{enterprise}/secret-scanning/alerts/get(secret-scanning/list-alerts-for-enterprise)`. @@ -2198,10 +2213,10 @@ public enum Operations { /// List secret scanning alerts for an organization /// /// Lists secret scanning alerts for eligible repositories in an organization, from newest to oldest. - /// To use this endpoint, you must be an administrator or security manager for the organization, and you must use an access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator or security manager for the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /orgs/{org}/secret-scanning/alerts`. /// - Remark: Generated from `#/paths//orgs/{org}/secret-scanning/alerts/get(secret-scanning/list-alerts-for-org)`. @@ -2499,10 +2514,10 @@ public enum Operations { /// List secret scanning alerts for a repository /// /// Lists secret scanning alerts for an eligible repository, from newest to oldest. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/secret-scanning/alerts`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/get(secret-scanning/list-alerts-for-repo)`. @@ -2794,10 +2809,10 @@ public enum Operations { /// Get a secret scanning alert /// /// Gets a single secret scanning alert detected in an eligible repository. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/get(secret-scanning/get-alert)`. @@ -3019,10 +3034,10 @@ public enum Operations { /// Update a secret scanning alert /// /// Updates the status of a secret scanning alert in an eligible repository. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` write permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/patch(secret-scanning/update-alert)`. @@ -3313,10 +3328,10 @@ public enum Operations { /// List locations for a secret scanning alert /// /// Lists all locations for a given secret scanning alert for an eligible repository. - /// To use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the `repo` scope or `security_events` scope. - /// For public repositories, you may instead use the `public_repo` scope. /// - /// GitHub Apps must have the `secret_scanning_alerts` read permission to use this endpoint. + /// The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}/locations/get(secret-scanning/list-locations-for-alert)`. From ee788eb74fafcb94caab73bec973b0374b1cbf7a Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:19:58 +0000 Subject: [PATCH 16/20] Commit via running ake Sources/teams --- Sources/teams/Client.swift | 87 ++++++++++--- Sources/teams/Types.swift | 261 ++++++++++++++++++++++++++++--------- 2 files changed, 264 insertions(+), 84 deletions(-) diff --git a/Sources/teams/Client.swift b/Sources/teams/Client.swift index ffb715a3e3..778a512660 100644 --- a/Sources/teams/Client.swift +++ b/Sources/teams/Client.swift @@ -567,10 +567,12 @@ public struct Client: APIProtocol { } /// List discussions /// - /// List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all discussions on a team's page. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/get(teams/list-discussions-in-org)`. public func teams_sol_list_hyphen_discussions_hyphen_in_hyphen_org(_ input: Operations.teams_sol_list_hyphen_discussions_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_list_hyphen_discussions_hyphen_in_hyphen_org.Output { @@ -670,12 +672,14 @@ public struct Client: APIProtocol { } /// Create a discussion /// - /// Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new discussion post on a team's page. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/post(teams/create-discussion-in-org)`. public func teams_sol_create_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.teams_sol_create_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_create_hyphen_discussion_hyphen_in_hyphen_org.Output { @@ -748,10 +752,12 @@ public struct Client: APIProtocol { } /// Get a discussion /// - /// Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific discussion on a team's page. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/get(teams/get-discussion-in-org)`. public func teams_sol_get_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.teams_sol_get_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_get_hyphen_discussion_hyphen_in_hyphen_org.Output { @@ -816,10 +822,12 @@ public struct Client: APIProtocol { } /// Update a discussion /// - /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/patch(teams/update-discussion-in-org)`. public func teams_sol_update_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.teams_sol_update_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_update_hyphen_discussion_hyphen_in_hyphen_org.Output { @@ -895,10 +903,12 @@ public struct Client: APIProtocol { } /// Delete a discussion /// - /// Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a discussion from a team's page. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/delete(teams/delete-discussion-in-org)`. public func teams_sol_delete_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.teams_sol_delete_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_delete_hyphen_discussion_hyphen_in_hyphen_org.Output { @@ -939,10 +949,12 @@ public struct Client: APIProtocol { } /// List discussion comments /// - /// List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all comments on a team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/get(teams/list-discussion-comments-in-org)`. public func teams_sol_list_hyphen_discussion_hyphen_comments_hyphen_in_hyphen_org(_ input: Operations.teams_sol_list_hyphen_discussion_hyphen_comments_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_list_hyphen_discussion_hyphen_comments_hyphen_in_hyphen_org.Output { @@ -1036,12 +1048,14 @@ public struct Client: APIProtocol { } /// Create a discussion comment /// - /// Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new comment on a team discussion. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/post(teams/create-discussion-comment-in-org)`. public func teams_sol_create_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.teams_sol_create_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_create_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output { @@ -1115,10 +1129,12 @@ public struct Client: APIProtocol { } /// Get a discussion comment /// - /// Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific comment on a team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/get(teams/get-discussion-comment-in-org)`. public func teams_sol_get_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.teams_sol_get_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_get_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output { @@ -1184,10 +1200,12 @@ public struct Client: APIProtocol { } /// Update a discussion comment /// - /// Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the body text of a discussion comment. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/patch(teams/update-discussion-comment-in-org)`. public func teams_sol_update_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.teams_sol_update_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_update_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output { @@ -1262,10 +1280,12 @@ public struct Client: APIProtocol { } /// Delete a discussion comment /// - /// Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Deletes a comment on a team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/delete(teams/delete-discussion-comment-in-org)`. public func teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output { @@ -2702,7 +2722,9 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. /// - /// List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all discussions on a team's page. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/get(teams/list-discussions-legacy)`. @@ -2798,10 +2820,12 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. /// - /// Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new discussion post on a team's page. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /teams/{team_id}/discussions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/post(teams/create-discussion-legacy)`. @available(*, deprecated) @@ -2876,7 +2900,9 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. /// - /// Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific discussion on a team's page. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/get(teams/get-discussion-legacy)`. @@ -2944,7 +2970,9 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. /// - /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /teams/{team_id}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/patch(teams/update-discussion-legacy)`. @@ -3023,7 +3051,9 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. /// - /// Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a discussion from a team's page. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /teams/{team_id}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/delete(teams/delete-discussion-legacy)`. @@ -3067,7 +3097,9 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. /// - /// List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all comments on a team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/get(teams/list-discussion-comments-legacy)`. @@ -3164,10 +3196,12 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. /// - /// Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new comment on a team discussion. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /teams/{team_id}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/post(teams/create-discussion-comment-legacy)`. @available(*, deprecated) @@ -3243,7 +3277,9 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. /// - /// Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific comment on a team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/get(teams/get-discussion-comment-legacy)`. @@ -3312,7 +3348,9 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. /// - /// Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the body text of a discussion comment. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/patch(teams/update-discussion-comment-legacy)`. @@ -3390,7 +3428,9 @@ public struct Client: APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. /// - /// Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Deletes a comment on a team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/delete(teams/delete-discussion-comment-legacy)`. @@ -4968,7 +5008,12 @@ public struct Client: APIProtocol { } /// List teams for the authenticated user /// - /// List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. + /// List all of the teams across all of the organizations to which the authenticated + /// user belongs. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + /// + /// When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. /// /// - Remark: HTTP `GET /user/teams`. /// - Remark: Generated from `#/paths//user/teams/get(teams/list-for-authenticated-user)`. diff --git a/Sources/teams/Types.swift b/Sources/teams/Types.swift index 984059ae5c..6383370b8e 100644 --- a/Sources/teams/Types.swift +++ b/Sources/teams/Types.swift @@ -58,95 +58,115 @@ public protocol APIProtocol: Sendable { func teams_sol_delete_hyphen_in_hyphen_org(_ input: Operations.teams_sol_delete_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_delete_hyphen_in_hyphen_org.Output /// List discussions /// - /// List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all discussions on a team's page. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/get(teams/list-discussions-in-org)`. func teams_sol_list_hyphen_discussions_hyphen_in_hyphen_org(_ input: Operations.teams_sol_list_hyphen_discussions_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_list_hyphen_discussions_hyphen_in_hyphen_org.Output /// Create a discussion /// - /// Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new discussion post on a team's page. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/post(teams/create-discussion-in-org)`. func teams_sol_create_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.teams_sol_create_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_create_hyphen_discussion_hyphen_in_hyphen_org.Output /// Get a discussion /// - /// Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific discussion on a team's page. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/get(teams/get-discussion-in-org)`. func teams_sol_get_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.teams_sol_get_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_get_hyphen_discussion_hyphen_in_hyphen_org.Output /// Update a discussion /// - /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/patch(teams/update-discussion-in-org)`. func teams_sol_update_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.teams_sol_update_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_update_hyphen_discussion_hyphen_in_hyphen_org.Output /// Delete a discussion /// - /// Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a discussion from a team's page. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/delete(teams/delete-discussion-in-org)`. func teams_sol_delete_hyphen_discussion_hyphen_in_hyphen_org(_ input: Operations.teams_sol_delete_hyphen_discussion_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_delete_hyphen_discussion_hyphen_in_hyphen_org.Output /// List discussion comments /// - /// List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all comments on a team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/get(teams/list-discussion-comments-in-org)`. func teams_sol_list_hyphen_discussion_hyphen_comments_hyphen_in_hyphen_org(_ input: Operations.teams_sol_list_hyphen_discussion_hyphen_comments_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_list_hyphen_discussion_hyphen_comments_hyphen_in_hyphen_org.Output /// Create a discussion comment /// - /// Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new comment on a team discussion. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/post(teams/create-discussion-comment-in-org)`. func teams_sol_create_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.teams_sol_create_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_create_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output /// Get a discussion comment /// - /// Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific comment on a team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/get(teams/get-discussion-comment-in-org)`. func teams_sol_get_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.teams_sol_get_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_get_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output /// Update a discussion comment /// - /// Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the body text of a discussion comment. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/patch(teams/update-discussion-comment-in-org)`. func teams_sol_update_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.teams_sol_update_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_update_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output /// Delete a discussion comment /// - /// Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Deletes a comment on a team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/delete(teams/delete-discussion-comment-in-org)`. func teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(_ input: Operations.teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input) async throws -> Operations.teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output @@ -339,7 +359,9 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. /// - /// List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all discussions on a team's page. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/get(teams/list-discussions-legacy)`. @@ -349,10 +371,12 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. /// - /// Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new discussion post on a team's page. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /teams/{team_id}/discussions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/post(teams/create-discussion-legacy)`. @available(*, deprecated) @@ -361,7 +385,9 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. /// - /// Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific discussion on a team's page. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/get(teams/get-discussion-legacy)`. @@ -371,7 +397,9 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. /// - /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /teams/{team_id}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/patch(teams/update-discussion-legacy)`. @@ -381,7 +409,9 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. /// - /// Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a discussion from a team's page. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /teams/{team_id}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/delete(teams/delete-discussion-legacy)`. @@ -391,7 +421,9 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. /// - /// List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all comments on a team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/get(teams/list-discussion-comments-legacy)`. @@ -401,10 +433,12 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. /// - /// Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new comment on a team discussion. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /teams/{team_id}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/post(teams/create-discussion-comment-legacy)`. @available(*, deprecated) @@ -413,7 +447,9 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. /// - /// Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific comment on a team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/get(teams/get-discussion-comment-legacy)`. @@ -423,7 +459,9 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. /// - /// Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the body text of a discussion comment. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/patch(teams/update-discussion-comment-legacy)`. @@ -433,7 +471,9 @@ public protocol APIProtocol: Sendable { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. /// - /// Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Deletes a comment on a team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/delete(teams/delete-discussion-comment-legacy)`. @@ -646,7 +686,12 @@ public protocol APIProtocol: Sendable { func teams_sol_list_hyphen_child_hyphen_legacy(_ input: Operations.teams_sol_list_hyphen_child_hyphen_legacy.Input) async throws -> Operations.teams_sol_list_hyphen_child_hyphen_legacy.Output /// List teams for the authenticated user /// - /// List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. + /// List all of the teams across all of the organizations to which the authenticated + /// user belongs. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + /// + /// When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. /// /// - Remark: HTTP `GET /user/teams`. /// - Remark: Generated from `#/paths//user/teams/get(teams/list-for-authenticated-user)`. @@ -742,10 +787,12 @@ extension APIProtocol { } /// List discussions /// - /// List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all discussions on a team's page. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/get(teams/list-discussions-in-org)`. public func teams_sol_list_hyphen_discussions_hyphen_in_hyphen_org( @@ -761,12 +808,14 @@ extension APIProtocol { } /// Create a discussion /// - /// Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new discussion post on a team's page. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/post(teams/create-discussion-in-org)`. public func teams_sol_create_hyphen_discussion_hyphen_in_hyphen_org( @@ -782,10 +831,12 @@ extension APIProtocol { } /// Get a discussion /// - /// Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific discussion on a team's page. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/get(teams/get-discussion-in-org)`. public func teams_sol_get_hyphen_discussion_hyphen_in_hyphen_org( @@ -799,10 +850,12 @@ extension APIProtocol { } /// Update a discussion /// - /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/patch(teams/update-discussion-in-org)`. public func teams_sol_update_hyphen_discussion_hyphen_in_hyphen_org( @@ -818,10 +871,12 @@ extension APIProtocol { } /// Delete a discussion /// - /// Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a discussion from a team's page. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/delete(teams/delete-discussion-in-org)`. public func teams_sol_delete_hyphen_discussion_hyphen_in_hyphen_org(path: Operations.teams_sol_delete_hyphen_discussion_hyphen_in_hyphen_org.Input.Path) async throws -> Operations.teams_sol_delete_hyphen_discussion_hyphen_in_hyphen_org.Output { @@ -829,10 +884,12 @@ extension APIProtocol { } /// List discussion comments /// - /// List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all comments on a team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/get(teams/list-discussion-comments-in-org)`. public func teams_sol_list_hyphen_discussion_hyphen_comments_hyphen_in_hyphen_org( @@ -848,12 +905,14 @@ extension APIProtocol { } /// Create a discussion comment /// - /// Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new comment on a team discussion. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/post(teams/create-discussion-comment-in-org)`. public func teams_sol_create_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org( @@ -869,10 +928,12 @@ extension APIProtocol { } /// Get a discussion comment /// - /// Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific comment on a team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/get(teams/get-discussion-comment-in-org)`. public func teams_sol_get_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org( @@ -886,10 +947,12 @@ extension APIProtocol { } /// Update a discussion comment /// - /// Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the body text of a discussion comment. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/patch(teams/update-discussion-comment-in-org)`. public func teams_sol_update_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org( @@ -905,10 +968,12 @@ extension APIProtocol { } /// Delete a discussion comment /// - /// Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Deletes a comment on a team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/delete(teams/delete-discussion-comment-in-org)`. public func teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org(path: Operations.teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Input.Path) async throws -> Operations.teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org.Output { @@ -1237,7 +1302,9 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. /// - /// List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all discussions on a team's page. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/get(teams/list-discussions-legacy)`. @@ -1257,10 +1324,12 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. /// - /// Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new discussion post on a team's page. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /teams/{team_id}/discussions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/post(teams/create-discussion-legacy)`. @available(*, deprecated) @@ -1279,7 +1348,9 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. /// - /// Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific discussion on a team's page. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/get(teams/get-discussion-legacy)`. @@ -1297,7 +1368,9 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. /// - /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /teams/{team_id}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/patch(teams/update-discussion-legacy)`. @@ -1317,7 +1390,9 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. /// - /// Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a discussion from a team's page. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /teams/{team_id}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/delete(teams/delete-discussion-legacy)`. @@ -1329,7 +1404,9 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. /// - /// List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all comments on a team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/get(teams/list-discussion-comments-legacy)`. @@ -1349,10 +1426,12 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. /// - /// Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new comment on a team discussion. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /teams/{team_id}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/post(teams/create-discussion-comment-legacy)`. @available(*, deprecated) @@ -1371,7 +1450,9 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. /// - /// Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific comment on a team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/get(teams/get-discussion-comment-legacy)`. @@ -1389,7 +1470,9 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. /// - /// Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the body text of a discussion comment. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/patch(teams/update-discussion-comment-legacy)`. @@ -1409,7 +1492,9 @@ extension APIProtocol { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. /// - /// Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Deletes a comment on a team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/delete(teams/delete-discussion-comment-legacy)`. @@ -1752,7 +1837,12 @@ extension APIProtocol { } /// List teams for the authenticated user /// - /// List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. + /// List all of the teams across all of the organizations to which the authenticated + /// user belongs. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + /// + /// When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. /// /// - Remark: HTTP `GET /user/teams`. /// - Remark: Generated from `#/paths//user/teams/get(teams/list-for-authenticated-user)`. @@ -6283,10 +6373,12 @@ public enum Operations { } /// List discussions /// - /// List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all discussions on a team's page. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/get(teams/list-discussions-in-org)`. public enum teams_sol_list_hyphen_discussions_hyphen_in_hyphen_org { @@ -6491,12 +6583,14 @@ public enum Operations { } /// Create a discussion /// - /// Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new discussion post on a team's page. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/post(teams/create-discussion-in-org)`. public enum teams_sol_create_hyphen_discussion_hyphen_in_hyphen_org { @@ -6680,10 +6774,12 @@ public enum Operations { } /// Get a discussion /// - /// Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific discussion on a team's page. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/get(teams/get-discussion-in-org)`. public enum teams_sol_get_hyphen_discussion_hyphen_in_hyphen_org { @@ -6830,10 +6926,12 @@ public enum Operations { } /// Update a discussion /// - /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/patch(teams/update-discussion-in-org)`. public enum teams_sol_update_hyphen_discussion_hyphen_in_hyphen_org { @@ -7016,10 +7114,12 @@ public enum Operations { } /// Delete a discussion /// - /// Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a discussion from a team's page. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/delete(teams/delete-discussion-in-org)`. public enum teams_sol_delete_hyphen_discussion_hyphen_in_hyphen_org { @@ -7100,10 +7200,12 @@ public enum Operations { } /// List discussion comments /// - /// List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all comments on a team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/get(teams/list-discussion-comments-in-org)`. public enum teams_sol_list_hyphen_discussion_hyphen_comments_hyphen_in_hyphen_org { @@ -7308,12 +7410,14 @@ public enum Operations { } /// Create a discussion comment /// - /// Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new comment on a team discussion. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/post(teams/create-discussion-comment-in-org)`. public enum teams_sol_create_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org { @@ -7486,10 +7590,12 @@ public enum Operations { } /// Get a discussion comment /// - /// Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific comment on a team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/get(teams/get-discussion-comment-in-org)`. public enum teams_sol_get_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org { @@ -7643,10 +7749,12 @@ public enum Operations { } /// Update a discussion comment /// - /// Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the body text of a discussion comment. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/patch(teams/update-discussion-comment-in-org)`. public enum teams_sol_update_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org { @@ -7826,10 +7934,12 @@ public enum Operations { } /// Delete a discussion comment /// - /// Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Deletes a comment on a team discussion. /// /// **Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/delete(teams/delete-discussion-comment-in-org)`. public enum teams_sol_delete_hyphen_discussion_hyphen_comment_hyphen_in_hyphen_org { @@ -11018,7 +11128,9 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://docs.github.com/rest/teams/discussions#list-discussions) endpoint. /// - /// List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all discussions on a team's page. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/get(teams/list-discussions-legacy)`. @@ -11210,10 +11322,12 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://docs.github.com/rest/teams/discussions#create-a-discussion) endpoint. /// - /// Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new discussion post on a team's page. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /teams/{team_id}/discussions`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/post(teams/create-discussion-legacy)`. public enum teams_sol_create_hyphen_discussion_hyphen_legacy { @@ -11390,7 +11504,9 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion](https://docs.github.com/rest/teams/discussions#get-a-discussion) endpoint. /// - /// Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific discussion on a team's page. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/get(teams/get-discussion-legacy)`. @@ -11533,7 +11649,9 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/rest/teams/discussions#update-a-discussion) endpoint. /// - /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the title and body text of a discussion post. Only the parameters you provide are updated. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /teams/{team_id}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/patch(teams/update-discussion-legacy)`. @@ -11712,7 +11830,9 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://docs.github.com/rest/teams/discussions#delete-a-discussion) endpoint. /// - /// Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Delete a discussion from a team's page. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /teams/{team_id}/discussions/{discussion_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/delete(teams/delete-discussion-legacy)`. @@ -11789,7 +11909,9 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [List discussion comments](https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments) endpoint. /// - /// List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// List all comments on a team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/get(teams/list-discussion-comments-legacy)`. @@ -11990,10 +12112,12 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Create a discussion comment](https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment) endpoint. /// - /// Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Creates a new comment on a team discussion. /// /// This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/overview/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. + /// /// - Remark: HTTP `POST /teams/{team_id}/discussions/{discussion_number}/comments`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/post(teams/create-discussion-comment-legacy)`. public enum teams_sol_create_hyphen_discussion_hyphen_comment_hyphen_legacy { @@ -12161,7 +12285,9 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Get a discussion comment](https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment) endpoint. /// - /// Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Get a specific comment on a team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:discussion` scope to use this endpoint. /// /// - Remark: HTTP `GET /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/get(teams/get-discussion-comment-legacy)`. @@ -12311,7 +12437,9 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment) endpoint. /// - /// Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Edits the body text of a discussion comment. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/patch(teams/update-discussion-comment-legacy)`. @@ -12487,7 +12615,9 @@ public enum Operations { /// /// **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Delete a discussion comment](https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment) endpoint. /// - /// Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Deletes a comment on a team discussion. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}`. /// - Remark: Generated from `#/paths//teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/delete(teams/delete-discussion-comment-legacy)`. @@ -15684,7 +15814,12 @@ public enum Operations { } /// List teams for the authenticated user /// - /// List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://docs.github.com/apps/building-oauth-apps/). When using a fine-grained personal access token, the resource owner of the token [must be a single organization](https://docs.github.com/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token#fine-grained-personal-access-tokens), and have at least read-only member organization permissions. The response payload only contains the teams from a single organization when using a fine-grained personal access token. + /// List all of the teams across all of the organizations to which the authenticated + /// user belongs. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. + /// + /// When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization. /// /// - Remark: HTTP `GET /user/teams`. /// - Remark: Generated from `#/paths//user/teams/get(teams/list-for-authenticated-user)`. From 6c5ccf9dfa867a383471dd9d1ccff337d902d6b0 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:20:19 +0000 Subject: [PATCH 17/20] Commit via running ake Sources/users --- Sources/users/Client.swift | 85 +++++++++---- Sources/users/Types.swift | 255 +++++++++++++++++++++++++------------ 2 files changed, 236 insertions(+), 104 deletions(-) diff --git a/Sources/users/Client.swift b/Sources/users/Client.swift index 8117c5897e..e1d0323e8a 100644 --- a/Sources/users/Client.swift +++ b/Sources/users/Client.swift @@ -40,9 +40,7 @@ public struct Client: APIProtocol { } /// Get the authenticated user /// - /// If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - /// - /// If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. /// /// - Remark: HTTP `GET /user`. /// - Remark: Generated from `#/paths//user/get(users/get-authenticated)`. @@ -976,7 +974,10 @@ public struct Client: APIProtocol { } /// List email addresses for the authenticated user /// - /// Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + /// Lists all of your email addresses, and specifies which one is visible + /// to the public. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/emails`. /// - Remark: Generated from `#/paths//user/emails/get(users/list-emails-for-authenticated-user)`. @@ -1128,7 +1129,7 @@ public struct Client: APIProtocol { } /// Add an email address for the authenticated user /// - /// This endpoint is accessible with the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/emails`. /// - Remark: Generated from `#/paths//user/emails/post(users/add-email-for-authenticated-user)`. @@ -1291,7 +1292,7 @@ public struct Client: APIProtocol { } /// Delete an email address for the authenticated user /// - /// This endpoint is accessible with the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/emails`. /// - Remark: Generated from `#/paths//user/emails/delete(users/delete-email-for-authenticated-user)`. @@ -1806,7 +1807,7 @@ public struct Client: APIProtocol { /// /// Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." /// - /// Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/following/{username}`. /// - Remark: Generated from `#/paths//user/following/{username}/put(users/follow)`. @@ -1918,7 +1919,7 @@ public struct Client: APIProtocol { } /// Unfollow a user /// - /// Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/following/{username}`. /// - Remark: Generated from `#/paths//user/following/{username}/delete(users/unfollow)`. @@ -2030,7 +2031,9 @@ public struct Client: APIProtocol { } /// List GPG keys for the authenticated user /// - /// Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Lists the current user's GPG keys. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/gpg_keys`. /// - Remark: Generated from `#/paths//user/gpg_keys/get(users/list-gpg-keys-for-authenticated-user)`. @@ -2182,7 +2185,9 @@ public struct Client: APIProtocol { } /// Create a GPG key for the authenticated user /// - /// Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Adds a GPG key to the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/gpg_keys`. /// - Remark: Generated from `#/paths//user/gpg_keys/post(users/create-gpg-key-for-authenticated-user)`. @@ -2343,7 +2348,9 @@ public struct Client: APIProtocol { } /// Get a GPG key for the authenticated user /// - /// View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// View extended details for a single GPG key. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/gpg_keys/{gpg_key_id}`. /// - Remark: Generated from `#/paths//user/gpg_keys/{gpg_key_id}/get(users/get-gpg-key-for-authenticated-user)`. @@ -2475,7 +2482,9 @@ public struct Client: APIProtocol { } /// Delete a GPG key for the authenticated user /// - /// Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Removes a GPG key from the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/gpg_keys/{gpg_key_id}`. /// - Remark: Generated from `#/paths//user/gpg_keys/{gpg_key_id}/delete(users/delete-gpg-key-for-authenticated-user)`. @@ -2609,7 +2618,9 @@ public struct Client: APIProtocol { } /// List public SSH keys for the authenticated user /// - /// Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Lists the public SSH keys for the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/keys`. /// - Remark: Generated from `#/paths//user/keys/get(users/list-public-ssh-keys-for-authenticated-user)`. @@ -2761,7 +2772,9 @@ public struct Client: APIProtocol { } /// Create a public SSH key for the authenticated user /// - /// Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Adds a public SSH key to the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/keys`. /// - Remark: Generated from `#/paths//user/keys/post(users/create-public-ssh-key-for-authenticated-user)`. @@ -2922,7 +2935,9 @@ public struct Client: APIProtocol { } /// Get a public SSH key for the authenticated user /// - /// View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// View extended details for a single public SSH key. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/keys/{key_id}`. /// - Remark: Generated from `#/paths//user/keys/{key_id}/get(users/get-public-ssh-key-for-authenticated-user)`. @@ -3054,7 +3069,9 @@ public struct Client: APIProtocol { } /// Delete a public SSH key for the authenticated user /// - /// Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Removes a public SSH key from the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/keys/{key_id}`. /// - Remark: Generated from `#/paths//user/keys/{key_id}/delete(users/delete-public-ssh-key-for-authenticated-user)`. @@ -3166,7 +3183,11 @@ public struct Client: APIProtocol { } /// List public email addresses for the authenticated user /// - /// Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + /// Lists your publicly visible email address, which you can set with the + /// [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + /// endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/public_emails`. /// - Remark: Generated from `#/paths//user/public_emails/get(users/list-public-emails-for-authenticated-user)`. @@ -3470,7 +3491,9 @@ public struct Client: APIProtocol { } /// Add social accounts for the authenticated user /// - /// Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. + /// Add one or more social accounts to the authenticated user's profile. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/social_accounts`. /// - Remark: Generated from `#/paths//user/social_accounts/post(users/add-social-account-for-authenticated-user)`. @@ -3631,7 +3654,9 @@ public struct Client: APIProtocol { } /// Delete social accounts for the authenticated user /// - /// Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. + /// Deletes one or more social accounts from the authenticated user's profile. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/social_accounts`. /// - Remark: Generated from `#/paths//user/social_accounts/delete(users/delete-social-account-for-authenticated-user)`. @@ -3772,7 +3797,9 @@ public struct Client: APIProtocol { } /// List SSH signing keys for the authenticated user /// - /// Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Lists the SSH signing keys for the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/ssh_signing_keys`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/get(users/list-ssh-signing-keys-for-authenticated-user)`. @@ -3924,7 +3951,9 @@ public struct Client: APIProtocol { } /// Create a SSH signing key for the authenticated user /// - /// Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Creates an SSH signing key for the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/ssh_signing_keys`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/post(users/create-ssh-signing-key-for-authenticated-user)`. @@ -4085,7 +4114,9 @@ public struct Client: APIProtocol { } /// Get an SSH signing key for the authenticated user /// - /// Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Gets extended details for an SSH signing key. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/ssh_signing_keys/{ssh_signing_key_id}`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/{ssh_signing_key_id}/get(users/get-ssh-signing-key-for-authenticated-user)`. @@ -4217,7 +4248,9 @@ public struct Client: APIProtocol { } /// Delete an SSH signing key for the authenticated user /// - /// Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Deletes an SSH signing key from the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/ssh_signing_keys/{ssh_signing_key_id}`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/{ssh_signing_key_id}/delete(users/delete-ssh-signing-key-for-authenticated-user)`. @@ -4419,8 +4452,6 @@ public struct Client: APIProtocol { /// /// Provides publicly available information about someone with a GitHub account. /// - /// GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" - /// /// The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). /// /// The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". @@ -4808,7 +4839,7 @@ public struct Client: APIProtocol { } /// Get contextual information for a user /// - /// Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + /// Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. /// /// The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: /// @@ -4817,6 +4848,8 @@ public struct Client: APIProtocol { /// https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 /// ``` /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /users/{username}/hovercard`. /// - Remark: Generated from `#/paths//users/{username}/hovercard/get(users/get-context-for-user)`. public func users_sol_get_hyphen_context_hyphen_for_hyphen_user(_ input: Operations.users_sol_get_hyphen_context_hyphen_for_hyphen_user.Input) async throws -> Operations.users_sol_get_hyphen_context_hyphen_for_hyphen_user.Output { diff --git a/Sources/users/Types.swift b/Sources/users/Types.swift index 48dd09ad91..1d0fa984d3 100644 --- a/Sources/users/Types.swift +++ b/Sources/users/Types.swift @@ -13,9 +13,7 @@ import struct Foundation.Date public protocol APIProtocol: Sendable { /// Get the authenticated user /// - /// If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - /// - /// If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. /// /// - Remark: HTTP `GET /user`. /// - Remark: Generated from `#/paths//user/get(users/get-authenticated)`. @@ -64,21 +62,24 @@ public protocol APIProtocol: Sendable { func users_sol_set_hyphen_primary_hyphen_email_hyphen_visibility_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_set_hyphen_primary_hyphen_email_hyphen_visibility_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_set_hyphen_primary_hyphen_email_hyphen_visibility_hyphen_for_hyphen_authenticated_hyphen_user.Output /// List email addresses for the authenticated user /// - /// Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + /// Lists all of your email addresses, and specifies which one is visible + /// to the public. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/emails`. /// - Remark: Generated from `#/paths//user/emails/get(users/list-emails-for-authenticated-user)`. func users_sol_list_hyphen_emails_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_list_hyphen_emails_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_list_hyphen_emails_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Add an email address for the authenticated user /// - /// This endpoint is accessible with the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/emails`. /// - Remark: Generated from `#/paths//user/emails/post(users/add-email-for-authenticated-user)`. func users_sol_add_hyphen_email_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_add_hyphen_email_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_add_hyphen_email_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Delete an email address for the authenticated user /// - /// This endpoint is accessible with the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/emails`. /// - Remark: Generated from `#/paths//user/emails/delete(users/delete-email-for-authenticated-user)`. @@ -106,77 +107,97 @@ public protocol APIProtocol: Sendable { /// /// Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." /// - /// Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/following/{username}`. /// - Remark: Generated from `#/paths//user/following/{username}/put(users/follow)`. func users_sol_follow(_ input: Operations.users_sol_follow.Input) async throws -> Operations.users_sol_follow.Output /// Unfollow a user /// - /// Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/following/{username}`. /// - Remark: Generated from `#/paths//user/following/{username}/delete(users/unfollow)`. func users_sol_unfollow(_ input: Operations.users_sol_unfollow.Input) async throws -> Operations.users_sol_unfollow.Output /// List GPG keys for the authenticated user /// - /// Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Lists the current user's GPG keys. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/gpg_keys`. /// - Remark: Generated from `#/paths//user/gpg_keys/get(users/list-gpg-keys-for-authenticated-user)`. func users_sol_list_hyphen_gpg_hyphen_keys_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_list_hyphen_gpg_hyphen_keys_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_list_hyphen_gpg_hyphen_keys_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Create a GPG key for the authenticated user /// - /// Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Adds a GPG key to the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/gpg_keys`. /// - Remark: Generated from `#/paths//user/gpg_keys/post(users/create-gpg-key-for-authenticated-user)`. func users_sol_create_hyphen_gpg_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_create_hyphen_gpg_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_create_hyphen_gpg_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Get a GPG key for the authenticated user /// - /// View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// View extended details for a single GPG key. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/gpg_keys/{gpg_key_id}`. /// - Remark: Generated from `#/paths//user/gpg_keys/{gpg_key_id}/get(users/get-gpg-key-for-authenticated-user)`. func users_sol_get_hyphen_gpg_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_get_hyphen_gpg_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_get_hyphen_gpg_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Delete a GPG key for the authenticated user /// - /// Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Removes a GPG key from the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/gpg_keys/{gpg_key_id}`. /// - Remark: Generated from `#/paths//user/gpg_keys/{gpg_key_id}/delete(users/delete-gpg-key-for-authenticated-user)`. func users_sol_delete_hyphen_gpg_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_delete_hyphen_gpg_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_delete_hyphen_gpg_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Output /// List public SSH keys for the authenticated user /// - /// Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Lists the public SSH keys for the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/keys`. /// - Remark: Generated from `#/paths//user/keys/get(users/list-public-ssh-keys-for-authenticated-user)`. func users_sol_list_hyphen_public_hyphen_ssh_hyphen_keys_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_list_hyphen_public_hyphen_ssh_hyphen_keys_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_list_hyphen_public_hyphen_ssh_hyphen_keys_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Create a public SSH key for the authenticated user /// - /// Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Adds a public SSH key to the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/keys`. /// - Remark: Generated from `#/paths//user/keys/post(users/create-public-ssh-key-for-authenticated-user)`. func users_sol_create_hyphen_public_hyphen_ssh_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_create_hyphen_public_hyphen_ssh_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_create_hyphen_public_hyphen_ssh_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Get a public SSH key for the authenticated user /// - /// View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// View extended details for a single public SSH key. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/keys/{key_id}`. /// - Remark: Generated from `#/paths//user/keys/{key_id}/get(users/get-public-ssh-key-for-authenticated-user)`. func users_sol_get_hyphen_public_hyphen_ssh_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_get_hyphen_public_hyphen_ssh_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_get_hyphen_public_hyphen_ssh_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Delete a public SSH key for the authenticated user /// - /// Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Removes a public SSH key from the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/keys/{key_id}`. /// - Remark: Generated from `#/paths//user/keys/{key_id}/delete(users/delete-public-ssh-key-for-authenticated-user)`. func users_sol_delete_hyphen_public_hyphen_ssh_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_delete_hyphen_public_hyphen_ssh_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_delete_hyphen_public_hyphen_ssh_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Output /// List public email addresses for the authenticated user /// - /// Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + /// Lists your publicly visible email address, which you can set with the + /// [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + /// endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/public_emails`. /// - Remark: Generated from `#/paths//user/public_emails/get(users/list-public-emails-for-authenticated-user)`. @@ -190,42 +211,54 @@ public protocol APIProtocol: Sendable { func users_sol_list_hyphen_social_hyphen_accounts_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_list_hyphen_social_hyphen_accounts_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_list_hyphen_social_hyphen_accounts_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Add social accounts for the authenticated user /// - /// Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. + /// Add one or more social accounts to the authenticated user's profile. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/social_accounts`. /// - Remark: Generated from `#/paths//user/social_accounts/post(users/add-social-account-for-authenticated-user)`. func users_sol_add_hyphen_social_hyphen_account_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_add_hyphen_social_hyphen_account_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_add_hyphen_social_hyphen_account_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Delete social accounts for the authenticated user /// - /// Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. + /// Deletes one or more social accounts from the authenticated user's profile. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/social_accounts`. /// - Remark: Generated from `#/paths//user/social_accounts/delete(users/delete-social-account-for-authenticated-user)`. func users_sol_delete_hyphen_social_hyphen_account_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_delete_hyphen_social_hyphen_account_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_delete_hyphen_social_hyphen_account_hyphen_for_hyphen_authenticated_hyphen_user.Output /// List SSH signing keys for the authenticated user /// - /// Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Lists the SSH signing keys for the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/ssh_signing_keys`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/get(users/list-ssh-signing-keys-for-authenticated-user)`. func users_sol_list_hyphen_ssh_hyphen_signing_hyphen_keys_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_list_hyphen_ssh_hyphen_signing_hyphen_keys_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_list_hyphen_ssh_hyphen_signing_hyphen_keys_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Create a SSH signing key for the authenticated user /// - /// Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Creates an SSH signing key for the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/ssh_signing_keys`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/post(users/create-ssh-signing-key-for-authenticated-user)`. func users_sol_create_hyphen_ssh_hyphen_signing_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_create_hyphen_ssh_hyphen_signing_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_create_hyphen_ssh_hyphen_signing_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Get an SSH signing key for the authenticated user /// - /// Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Gets extended details for an SSH signing key. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/ssh_signing_keys/{ssh_signing_key_id}`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/{ssh_signing_key_id}/get(users/get-ssh-signing-key-for-authenticated-user)`. func users_sol_get_hyphen_ssh_hyphen_signing_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user(_ input: Operations.users_sol_get_hyphen_ssh_hyphen_signing_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Input) async throws -> Operations.users_sol_get_hyphen_ssh_hyphen_signing_hyphen_key_hyphen_for_hyphen_authenticated_hyphen_user.Output /// Delete an SSH signing key for the authenticated user /// - /// Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Deletes an SSH signing key from the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/ssh_signing_keys/{ssh_signing_key_id}`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/{ssh_signing_key_id}/delete(users/delete-ssh-signing-key-for-authenticated-user)`. @@ -243,8 +276,6 @@ public protocol APIProtocol: Sendable { /// /// Provides publicly available information about someone with a GitHub account. /// - /// GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" - /// /// The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). /// /// The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". @@ -280,7 +311,7 @@ public protocol APIProtocol: Sendable { func users_sol_list_hyphen_gpg_hyphen_keys_hyphen_for_hyphen_user(_ input: Operations.users_sol_list_hyphen_gpg_hyphen_keys_hyphen_for_hyphen_user.Input) async throws -> Operations.users_sol_list_hyphen_gpg_hyphen_keys_hyphen_for_hyphen_user.Output /// Get contextual information for a user /// - /// Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + /// Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. /// /// The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: /// @@ -289,6 +320,8 @@ public protocol APIProtocol: Sendable { /// https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 /// ``` /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /users/{username}/hovercard`. /// - Remark: Generated from `#/paths//users/{username}/hovercard/get(users/get-context-for-user)`. func users_sol_get_hyphen_context_hyphen_for_hyphen_user(_ input: Operations.users_sol_get_hyphen_context_hyphen_for_hyphen_user.Input) async throws -> Operations.users_sol_get_hyphen_context_hyphen_for_hyphen_user.Output @@ -319,9 +352,7 @@ public protocol APIProtocol: Sendable { extension APIProtocol { /// Get the authenticated user /// - /// If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - /// - /// If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. /// /// - Remark: HTTP `GET /user`. /// - Remark: Generated from `#/paths//user/get(users/get-authenticated)`. @@ -420,7 +451,10 @@ extension APIProtocol { } /// List email addresses for the authenticated user /// - /// Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + /// Lists all of your email addresses, and specifies which one is visible + /// to the public. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/emails`. /// - Remark: Generated from `#/paths//user/emails/get(users/list-emails-for-authenticated-user)`. @@ -435,7 +469,7 @@ extension APIProtocol { } /// Add an email address for the authenticated user /// - /// This endpoint is accessible with the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/emails`. /// - Remark: Generated from `#/paths//user/emails/post(users/add-email-for-authenticated-user)`. @@ -450,7 +484,7 @@ extension APIProtocol { } /// Delete an email address for the authenticated user /// - /// This endpoint is accessible with the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/emails`. /// - Remark: Generated from `#/paths//user/emails/delete(users/delete-email-for-authenticated-user)`. @@ -510,7 +544,7 @@ extension APIProtocol { /// /// Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." /// - /// Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/following/{username}`. /// - Remark: Generated from `#/paths//user/following/{username}/put(users/follow)`. @@ -525,7 +559,7 @@ extension APIProtocol { } /// Unfollow a user /// - /// Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/following/{username}`. /// - Remark: Generated from `#/paths//user/following/{username}/delete(users/unfollow)`. @@ -540,7 +574,9 @@ extension APIProtocol { } /// List GPG keys for the authenticated user /// - /// Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Lists the current user's GPG keys. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/gpg_keys`. /// - Remark: Generated from `#/paths//user/gpg_keys/get(users/list-gpg-keys-for-authenticated-user)`. @@ -555,7 +591,9 @@ extension APIProtocol { } /// Create a GPG key for the authenticated user /// - /// Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Adds a GPG key to the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/gpg_keys`. /// - Remark: Generated from `#/paths//user/gpg_keys/post(users/create-gpg-key-for-authenticated-user)`. @@ -570,7 +608,9 @@ extension APIProtocol { } /// Get a GPG key for the authenticated user /// - /// View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// View extended details for a single GPG key. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/gpg_keys/{gpg_key_id}`. /// - Remark: Generated from `#/paths//user/gpg_keys/{gpg_key_id}/get(users/get-gpg-key-for-authenticated-user)`. @@ -585,7 +625,9 @@ extension APIProtocol { } /// Delete a GPG key for the authenticated user /// - /// Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Removes a GPG key from the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/gpg_keys/{gpg_key_id}`. /// - Remark: Generated from `#/paths//user/gpg_keys/{gpg_key_id}/delete(users/delete-gpg-key-for-authenticated-user)`. @@ -600,7 +642,9 @@ extension APIProtocol { } /// List public SSH keys for the authenticated user /// - /// Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Lists the public SSH keys for the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/keys`. /// - Remark: Generated from `#/paths//user/keys/get(users/list-public-ssh-keys-for-authenticated-user)`. @@ -615,7 +659,9 @@ extension APIProtocol { } /// Create a public SSH key for the authenticated user /// - /// Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Adds a public SSH key to the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/keys`. /// - Remark: Generated from `#/paths//user/keys/post(users/create-public-ssh-key-for-authenticated-user)`. @@ -630,7 +676,9 @@ extension APIProtocol { } /// Get a public SSH key for the authenticated user /// - /// View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// View extended details for a single public SSH key. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/keys/{key_id}`. /// - Remark: Generated from `#/paths//user/keys/{key_id}/get(users/get-public-ssh-key-for-authenticated-user)`. @@ -645,7 +693,9 @@ extension APIProtocol { } /// Delete a public SSH key for the authenticated user /// - /// Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Removes a public SSH key from the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/keys/{key_id}`. /// - Remark: Generated from `#/paths//user/keys/{key_id}/delete(users/delete-public-ssh-key-for-authenticated-user)`. @@ -660,7 +710,11 @@ extension APIProtocol { } /// List public email addresses for the authenticated user /// - /// Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + /// Lists your publicly visible email address, which you can set with the + /// [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + /// endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/public_emails`. /// - Remark: Generated from `#/paths//user/public_emails/get(users/list-public-emails-for-authenticated-user)`. @@ -690,7 +744,9 @@ extension APIProtocol { } /// Add social accounts for the authenticated user /// - /// Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. + /// Add one or more social accounts to the authenticated user's profile. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/social_accounts`. /// - Remark: Generated from `#/paths//user/social_accounts/post(users/add-social-account-for-authenticated-user)`. @@ -705,7 +761,9 @@ extension APIProtocol { } /// Delete social accounts for the authenticated user /// - /// Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. + /// Deletes one or more social accounts from the authenticated user's profile. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/social_accounts`. /// - Remark: Generated from `#/paths//user/social_accounts/delete(users/delete-social-account-for-authenticated-user)`. @@ -720,7 +778,9 @@ extension APIProtocol { } /// List SSH signing keys for the authenticated user /// - /// Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Lists the SSH signing keys for the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/ssh_signing_keys`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/get(users/list-ssh-signing-keys-for-authenticated-user)`. @@ -735,7 +795,9 @@ extension APIProtocol { } /// Create a SSH signing key for the authenticated user /// - /// Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Creates an SSH signing key for the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/ssh_signing_keys`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/post(users/create-ssh-signing-key-for-authenticated-user)`. @@ -750,7 +812,9 @@ extension APIProtocol { } /// Get an SSH signing key for the authenticated user /// - /// Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Gets extended details for an SSH signing key. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/ssh_signing_keys/{ssh_signing_key_id}`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/{ssh_signing_key_id}/get(users/get-ssh-signing-key-for-authenticated-user)`. @@ -765,7 +829,9 @@ extension APIProtocol { } /// Delete an SSH signing key for the authenticated user /// - /// Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Deletes an SSH signing key from the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/ssh_signing_keys/{ssh_signing_key_id}`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/{ssh_signing_key_id}/delete(users/delete-ssh-signing-key-for-authenticated-user)`. @@ -799,8 +865,6 @@ extension APIProtocol { /// /// Provides publicly available information about someone with a GitHub account. /// - /// GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" - /// /// The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). /// /// The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". @@ -876,7 +940,7 @@ extension APIProtocol { } /// Get contextual information for a user /// - /// Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + /// Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. /// /// The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: /// @@ -885,6 +949,8 @@ extension APIProtocol { /// https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 /// ``` /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /users/{username}/hovercard`. /// - Remark: Generated from `#/paths//users/{username}/hovercard/get(users/get-context-for-user)`. public func users_sol_get_hyphen_context_hyphen_for_hyphen_user( @@ -2683,9 +2749,7 @@ public enum Components { public enum Operations { /// Get the authenticated user /// - /// If the authenticated user is authenticated with an OAuth token with the `user` scope, then the response lists public and private profile information. - /// - /// If the authenticated user is authenticated through OAuth without the `user` scope, then the response lists only public profile information. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. /// /// - Remark: HTTP `GET /user`. /// - Remark: Generated from `#/paths//user/get(users/get-authenticated)`. @@ -4360,7 +4424,10 @@ public enum Operations { } /// List email addresses for the authenticated user /// - /// Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope. + /// Lists all of your email addresses, and specifies which one is visible + /// to the public. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/emails`. /// - Remark: Generated from `#/paths//user/emails/get(users/list-emails-for-authenticated-user)`. @@ -4612,7 +4679,7 @@ public enum Operations { } /// Add an email address for the authenticated user /// - /// This endpoint is accessible with the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/emails`. /// - Remark: Generated from `#/paths//user/emails/post(users/add-email-for-authenticated-user)`. @@ -4912,7 +4979,7 @@ public enum Operations { } /// Delete an email address for the authenticated user /// - /// This endpoint is accessible with the `user` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/emails`. /// - Remark: Generated from `#/paths//user/emails/delete(users/delete-email-for-authenticated-user)`. @@ -5878,7 +5945,7 @@ public enum Operations { /// /// Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#http-method)." /// - /// Following a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/following/{username}`. /// - Remark: Generated from `#/paths//user/following/{username}/put(users/follow)`. @@ -6078,7 +6145,7 @@ public enum Operations { } /// Unfollow a user /// - /// Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope. + /// OAuth app tokens and personal access tokens (classic) need the `user:follow` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/following/{username}`. /// - Remark: Generated from `#/paths//user/following/{username}/delete(users/unfollow)`. @@ -6278,7 +6345,9 @@ public enum Operations { } /// List GPG keys for the authenticated user /// - /// Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Lists the current user's GPG keys. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/gpg_keys`. /// - Remark: Generated from `#/paths//user/gpg_keys/get(users/list-gpg-keys-for-authenticated-user)`. @@ -6530,7 +6599,9 @@ public enum Operations { } /// Create a GPG key for the authenticated user /// - /// Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Adds a GPG key to the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/gpg_keys`. /// - Remark: Generated from `#/paths//user/gpg_keys/post(users/create-gpg-key-for-authenticated-user)`. @@ -6795,7 +6866,9 @@ public enum Operations { } /// Get a GPG key for the authenticated user /// - /// View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// View extended details for a single GPG key. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/gpg_keys/{gpg_key_id}`. /// - Remark: Generated from `#/paths//user/gpg_keys/{gpg_key_id}/get(users/get-gpg-key-for-authenticated-user)`. @@ -7019,7 +7092,9 @@ public enum Operations { } /// Delete a GPG key for the authenticated user /// - /// Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Removes a GPG key from the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/gpg_keys/{gpg_key_id}`. /// - Remark: Generated from `#/paths//user/gpg_keys/{gpg_key_id}/delete(users/delete-gpg-key-for-authenticated-user)`. @@ -7242,7 +7317,9 @@ public enum Operations { } /// List public SSH keys for the authenticated user /// - /// Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Lists the public SSH keys for the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/keys`. /// - Remark: Generated from `#/paths//user/keys/get(users/list-public-ssh-keys-for-authenticated-user)`. @@ -7494,7 +7571,9 @@ public enum Operations { } /// Create a public SSH key for the authenticated user /// - /// Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Adds a public SSH key to the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/keys`. /// - Remark: Generated from `#/paths//user/keys/post(users/create-public-ssh-key-for-authenticated-user)`. @@ -7759,7 +7838,9 @@ public enum Operations { } /// Get a public SSH key for the authenticated user /// - /// View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// View extended details for a single public SSH key. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/keys/{key_id}`. /// - Remark: Generated from `#/paths//user/keys/{key_id}/get(users/get-public-ssh-key-for-authenticated-user)`. @@ -7983,7 +8064,9 @@ public enum Operations { } /// Delete a public SSH key for the authenticated user /// - /// Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). + /// Removes a public SSH key from the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/keys/{key_id}`. /// - Remark: Generated from `#/paths//user/keys/{key_id}/delete(users/delete-public-ssh-key-for-authenticated-user)`. @@ -8183,7 +8266,11 @@ public enum Operations { } /// List public email addresses for the authenticated user /// - /// Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. This endpoint is accessible with the `user:email` scope. + /// Lists your publicly visible email address, which you can set with the + /// [Set primary email visibility for the authenticated user](https://docs.github.com/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) + /// endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/public_emails`. /// - Remark: Generated from `#/paths//user/public_emails/get(users/list-public-emails-for-authenticated-user)`. @@ -8687,7 +8774,9 @@ public enum Operations { } /// Add social accounts for the authenticated user /// - /// Add one or more social accounts to the authenticated user's profile. This endpoint is accessible with the `user` scope. + /// Add one or more social accounts to the authenticated user's profile. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/social_accounts`. /// - Remark: Generated from `#/paths//user/social_accounts/post(users/add-social-account-for-authenticated-user)`. @@ -8942,7 +9031,9 @@ public enum Operations { } /// Delete social accounts for the authenticated user /// - /// Deletes one or more social accounts from the authenticated user's profile. This endpoint is accessible with the `user` scope. + /// Deletes one or more social accounts from the authenticated user's profile. + /// + /// OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/social_accounts`. /// - Remark: Generated from `#/paths//user/social_accounts/delete(users/delete-social-account-for-authenticated-user)`. @@ -9173,7 +9264,9 @@ public enum Operations { } /// List SSH signing keys for the authenticated user /// - /// Lists the SSH signing keys for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Lists the SSH signing keys for the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/ssh_signing_keys`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/get(users/list-ssh-signing-keys-for-authenticated-user)`. @@ -9425,7 +9518,9 @@ public enum Operations { } /// Create a SSH signing key for the authenticated user /// - /// Creates an SSH signing key for the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `write:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Creates an SSH signing key for the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/ssh_signing_keys`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/post(users/create-ssh-signing-key-for-authenticated-user)`. @@ -9690,7 +9785,9 @@ public enum Operations { } /// Get an SSH signing key for the authenticated user /// - /// Gets extended details for an SSH signing key. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `read:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Gets extended details for an SSH signing key. + /// + /// OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/ssh_signing_keys/{ssh_signing_key_id}`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/{ssh_signing_key_id}/get(users/get-ssh-signing-key-for-authenticated-user)`. @@ -9914,7 +10011,9 @@ public enum Operations { } /// Delete an SSH signing key for the authenticated user /// - /// Deletes an SSH signing key from the authenticated user's GitHub account. You must authenticate with Basic Authentication, or you must authenticate with OAuth with at least `admin:ssh_signing_key` scope. For more information, see "[Understanding scopes for OAuth apps](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/)." + /// Deletes an SSH signing key from the authenticated user's GitHub account. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/ssh_signing_keys/{ssh_signing_key_id}`. /// - Remark: Generated from `#/paths//user/ssh_signing_keys/{ssh_signing_key_id}/delete(users/delete-ssh-signing-key-for-authenticated-user)`. @@ -10301,8 +10400,6 @@ public enum Operations { /// /// Provides publicly available information about someone with a GitHub account. /// - /// GitHub Apps with the `Plan` user permission can use this endpoint to retrieve information about a user's GitHub plan. The GitHub App must be authenticated as a user. See "[Identifying and authorizing users for GitHub Apps](https://docs.github.com/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)" for details about authentication. For an example response, see 'Response with GitHub plan information' below" - /// /// The `email` key in the following response is the publicly visible email address from your GitHub [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub. For more information, see [Authentication](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#authentication). /// /// The Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see "[Emails API](https://docs.github.com/rest/users/emails)". @@ -11127,7 +11224,7 @@ public enum Operations { } /// Get contextual information for a user /// - /// Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. + /// Provides hovercard information. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations. /// /// The `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this: /// @@ -11136,6 +11233,8 @@ public enum Operations { /// https://api.github.com/users/octocat/hovercard?subject_type=repository&subject_id=1300192 /// ``` /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. + /// /// - Remark: HTTP `GET /users/{username}/hovercard`. /// - Remark: Generated from `#/paths//users/{username}/hovercard/get(users/get-context-for-user)`. public enum users_sol_get_hyphen_context_hyphen_for_hyphen_user { From 8bed6faa6e8cc170573bab1fc9c571f3e5d4aacf Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:20:39 +0000 Subject: [PATCH 18/20] Commit via running ake Sources/codespaces --- Sources/codespaces/Client.swift | 231 ++-- Sources/codespaces/Types.swift | 2259 ++++--------------------------- 2 files changed, 368 insertions(+), 2122 deletions(-) diff --git a/Sources/codespaces/Client.swift b/Sources/codespaces/Client.swift index 484f5e32be..afcb24fb1a 100644 --- a/Sources/codespaces/Client.swift +++ b/Sources/codespaces/Client.swift @@ -42,7 +42,7 @@ public struct Client: APIProtocol { /// /// Lists the codespaces associated to a specified organization. /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/get(codespaces/list-in-organization)`. @@ -211,7 +211,7 @@ public struct Client: APIProtocol { /// Manage access control for organization codespaces /// /// Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/access`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/access/put(codespaces/set-codespaces-access)`. @@ -340,7 +340,7 @@ public struct Client: APIProtocol { /// To use this endpoint, the access settings for the organization must be set to `selected_members`. /// For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/codespaces/access/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/access/selected_users/post(codespaces/set-codespaces-access-users)`. @@ -469,7 +469,7 @@ public struct Client: APIProtocol { /// To use this endpoint, the access settings for the organization must be set to `selected_members`. /// For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/codespaces/access/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/access/selected_users/delete(codespaces/delete-codespaces-access-users)`. @@ -593,8 +593,10 @@ public struct Client: APIProtocol { } /// List organization secrets /// - /// Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted + /// values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/get(codespaces/list-org-secrets)`. @@ -680,7 +682,8 @@ public struct Client: APIProtocol { } /// Get an organization public key /// - /// Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets/public-key`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/public-key/get(codespaces/get-org-public-key)`. @@ -745,7 +748,8 @@ public struct Client: APIProtocol { /// Get an organization secret /// /// Gets an organization development environment secret without revealing its encrypted value. - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/get(codespaces/get-org-secret)`. @@ -821,8 +825,7 @@ public struct Client: APIProtocol { /// Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `admin:org` scope to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/put(codespaces/create-or-update-org-secret)`. @@ -942,7 +945,9 @@ public struct Client: APIProtocol { } /// Delete an organization secret /// - /// Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Deletes an organization development environment secret using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/delete(codespaces/delete-org-secret)`. @@ -1009,7 +1014,10 @@ public struct Client: APIProtocol { } /// List selected repositories for an organization secret /// - /// Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Lists all repositories that have been selected when the `visibility` + /// for repository access to a secret is set to `selected`. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/get(codespaces/list-selected-repos-for-org-secret)`. @@ -1110,7 +1118,11 @@ public struct Client: APIProtocol { } /// Set selected repositories for an organization secret /// - /// Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Replaces all repositories for an organization development environment secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/put(codespaces/set-selected-repos-for-org-secret)`. @@ -1188,7 +1200,8 @@ public struct Client: APIProtocol { } /// Add selected repository to an organization secret /// - /// Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}/put(codespaces/add-selected-repo-to-org-secret)`. @@ -1280,7 +1293,11 @@ public struct Client: APIProtocol { } /// Remove selected repository from an organization secret /// - /// Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Removes a repository from an organization development environment secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}/delete(codespaces/remove-selected-repo-from-org-secret)`. @@ -1374,7 +1391,7 @@ public struct Client: APIProtocol { /// /// Lists the codespaces that a member of an organization has for repositories in that organization. /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/members/{username}/codespaces`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/codespaces/get(codespaces/get-codespaces-for-user-in-org)`. @@ -1545,10 +1562,7 @@ public struct Client: APIProtocol { /// /// Deletes a user's codespace. /// - /// To use this endpoint you must authenticate using one of the following methods: - /// - /// - An access token with the `admin:org` scope - /// - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/members/{username}/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/codespaces/{codespace_name}/delete(codespaces/delete-from-organization)`. @@ -1706,10 +1720,7 @@ public struct Client: APIProtocol { /// /// Stops a user's codespace. /// - /// To use this endpoint you must authenticate using one of the following methods: - /// - /// - An access token with the `admin:org` scope - /// - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/codespaces/{codespace_name}/stop/post(codespaces/stop-in-organization)`. @@ -1867,12 +1878,7 @@ public struct Client: APIProtocol { /// /// Lists the codespaces associated to a specified repository and the authenticated user. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have read access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/get(codespaces/list-in-repository-for-authenticated-user)`. @@ -2041,12 +2047,7 @@ public struct Client: APIProtocol { /// /// Creates a codespace owned by the authenticated user in the specified repository. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/codespaces`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/post(codespaces/create-with-repo-for-authenticated-user)`. @@ -2264,9 +2265,7 @@ public struct Client: APIProtocol { /// Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files /// specify launchpoint configurations for codespaces created within the repository. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/devcontainers`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/devcontainers/get(codespaces/list-devcontainers-in-repository-for-authenticated-user)`. @@ -2466,9 +2465,7 @@ public struct Client: APIProtocol { /// /// List the machine types available for a given repository based on its configuration. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/machines`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/machines/get(codespaces/repo-machines-for-authenticated-user)`. @@ -2646,12 +2643,7 @@ public struct Client: APIProtocol { /// /// Gets the default attributes for codespaces created by the user with the repository. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/new`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/new/get(codespaces/pre-flight-with-repo-for-authenticated-user)`. @@ -2798,12 +2790,7 @@ public struct Client: APIProtocol { /// /// Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/permissions_check`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/permissions_check/get(codespaces/check-permissions-for-devcontainer)`. @@ -2992,7 +2979,10 @@ public struct Client: APIProtocol { } /// List repository secrets /// - /// Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + /// Lists all development environment secrets available in a repository without revealing their encrypted + /// values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/get(codespaces/list-repo-secrets)`. @@ -3079,7 +3069,12 @@ public struct Client: APIProtocol { } /// Get a repository public key /// - /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + /// Gets your public key, which you need to encrypt secrets. You need to + /// encrypt a secret before you can create or update secrets. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/secrets/public-key`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/public-key/get(codespaces/get-repo-public-key)`. @@ -3144,7 +3139,9 @@ public struct Client: APIProtocol { } /// Get a repository secret /// - /// Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + /// Gets a single repository development environment secret without revealing its encrypted value. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/{secret_name}/get(codespaces/get-repo-secret)`. @@ -3213,11 +3210,7 @@ public struct Client: APIProtocol { /// Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - /// repository permission to use this endpoint. - /// - /// This endpoint does not support fine-grained personal access tokens. For more information about personal access tokens, see "[Managing your personal access tokens](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic)." + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/{secret_name}/put(codespaces/create-or-update-repo-secret)`. @@ -3294,8 +3287,9 @@ public struct Client: APIProtocol { } /// Delete a repository secret /// - /// Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. - /// This endpoint does not support fine-grained personal access tokens. For more information about personal access tokens, see "[Managing your personal access tokens](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic)." + /// Deletes a development environment secret in a repository using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/{secret_name}/delete(codespaces/delete-repo-secret)`. @@ -3339,12 +3333,7 @@ public struct Client: APIProtocol { /// /// Creates a codespace owned by the authenticated user for the specified pull request. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pulls/{pull_number}/codespaces`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pulls/{pull_number}/codespaces/post(codespaces/create-with-pr-for-authenticated-user)`. @@ -3531,12 +3520,7 @@ public struct Client: APIProtocol { /// /// Lists the authenticated user's codespaces. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have read access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces`. /// - Remark: Generated from `#/paths//user/codespaces/get(codespaces/list-for-authenticated-user)`. @@ -3713,12 +3697,7 @@ public struct Client: APIProtocol { /// /// This endpoint requires either a `repository_id` OR a `pull_request` but not both. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces`. /// - Remark: Generated from `#/paths//user/codespaces/post(codespaces/create-for-authenticated-user)`. @@ -3902,9 +3881,9 @@ public struct Client: APIProtocol { /// Lists all development environment secrets available for a user's codespaces without revealing their /// encrypted values. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/get(codespaces/list-secrets-for-authenticated-user)`. @@ -3990,9 +3969,9 @@ public struct Client: APIProtocol { /// /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets/public-key`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/public-key/get(codespaces/get-public-key-for-authenticated-user)`. @@ -4056,9 +4035,9 @@ public struct Client: APIProtocol { /// /// Gets a development environment secret available to a user's codespaces without revealing its encrypted value. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/get(codespaces/get-secret-for-authenticated-user)`. @@ -4125,9 +4104,9 @@ public struct Client: APIProtocol { /// Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/put(codespaces/create-or-update-secret-for-authenticated-user)`. @@ -4248,9 +4227,9 @@ public struct Client: APIProtocol { /// /// Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/delete(codespaces/delete-secret-for-authenticated-user)`. @@ -4292,9 +4271,9 @@ public struct Client: APIProtocol { /// /// List the repositories that have been granted the ability to use a user's development environment secret. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/get(codespaces/list-repositories-for-secret-for-authenticated-user)`. @@ -4448,9 +4427,9 @@ public struct Client: APIProtocol { /// /// Select the repositories that will use a user's development environment secret. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/put(codespaces/set-repositories-for-secret-for-authenticated-user)`. @@ -4592,8 +4571,10 @@ public struct Client: APIProtocol { /// Add a selected repository to a user secret /// /// Adds a repository to the selected repositories for a user's development environment secret. - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + /// + /// The authenticated user must have Codespaces access to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/{repository_id}/put(codespaces/add-repository-for-secret-for-authenticated-user)`. @@ -4727,8 +4708,10 @@ public struct Client: APIProtocol { /// Remove a selected repository from a user secret /// /// Removes a repository from the selected repositories for a user's development environment secret. - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + /// + /// The authenticated user must have Codespaces access to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/{repository_id}/delete(codespaces/remove-repository-for-secret-for-authenticated-user)`. @@ -4863,12 +4846,7 @@ public struct Client: APIProtocol { /// /// Gets information about a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have read access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/get(codespaces/get-for-authenticated-user)`. @@ -5026,12 +5004,7 @@ public struct Client: APIProtocol { /// /// If you specify a new machine type it will be applied the next time your codespace is started. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /user/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/patch(codespaces/update-for-authenticated-user)`. @@ -5174,12 +5147,7 @@ public struct Client: APIProtocol { /// /// Deletes a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/delete(codespaces/delete-for-authenticated-user)`. @@ -5337,9 +5305,7 @@ public struct Client: APIProtocol { /// /// If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. /// - /// You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/exports`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/exports/post(codespaces/export-for-authenticated-user)`. @@ -5515,9 +5481,7 @@ public struct Client: APIProtocol { /// /// Gets information about an export of a codespace. /// - /// You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/{codespace_name}/exports/{export_id}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/exports/{export_id}/get(codespaces/get-export-details-for-authenticated-user)`. @@ -5606,9 +5570,7 @@ public struct Client: APIProtocol { /// /// List the machine types a codespace can transition to use. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/{codespace_name}/machines`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/machines/get(codespaces/codespace-machines-for-authenticated-user)`. @@ -5768,12 +5730,7 @@ public struct Client: APIProtocol { /// /// This will fail for a codespace that is already published, meaning it has an associated repository. /// - /// You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/publish`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/publish/post(codespaces/publish-for-authenticated-user)`. @@ -5936,9 +5893,7 @@ public struct Client: APIProtocol { /// /// Starts a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/start`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/start/post(codespaces/start-for-authenticated-user)`. @@ -6169,9 +6124,7 @@ public struct Client: APIProtocol { /// /// Stops a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/stop`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/stop/post(codespaces/stop-for-authenticated-user)`. diff --git a/Sources/codespaces/Types.swift b/Sources/codespaces/Types.swift index 86ff17aab8..2fa3c1a0c8 100644 --- a/Sources/codespaces/Types.swift +++ b/Sources/codespaces/Types.swift @@ -15,7 +15,7 @@ public protocol APIProtocol: Sendable { /// /// Lists the codespaces associated to a specified organization. /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/get(codespaces/list-in-organization)`. @@ -23,7 +23,7 @@ public protocol APIProtocol: Sendable { /// Manage access control for organization codespaces /// /// Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/access`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/access/put(codespaces/set-codespaces-access)`. @@ -36,7 +36,7 @@ public protocol APIProtocol: Sendable { /// To use this endpoint, the access settings for the organization must be set to `selected_members`. /// For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/codespaces/access/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/access/selected_users/post(codespaces/set-codespaces-access-users)`. @@ -49,7 +49,7 @@ public protocol APIProtocol: Sendable { /// To use this endpoint, the access settings for the organization must be set to `selected_members`. /// For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/codespaces/access/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/access/selected_users/delete(codespaces/delete-codespaces-access-users)`. @@ -57,15 +57,18 @@ public protocol APIProtocol: Sendable { func codespaces_sol_delete_hyphen_codespaces_hyphen_access_hyphen_users(_ input: Operations.codespaces_sol_delete_hyphen_codespaces_hyphen_access_hyphen_users.Input) async throws -> Operations.codespaces_sol_delete_hyphen_codespaces_hyphen_access_hyphen_users.Output /// List organization secrets /// - /// Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted + /// values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/get(codespaces/list-org-secrets)`. func codespaces_sol_list_hyphen_org_hyphen_secrets(_ input: Operations.codespaces_sol_list_hyphen_org_hyphen_secrets.Input) async throws -> Operations.codespaces_sol_list_hyphen_org_hyphen_secrets.Output /// Get an organization public key /// - /// Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets/public-key`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/public-key/get(codespaces/get-org-public-key)`. @@ -73,7 +76,8 @@ public protocol APIProtocol: Sendable { /// Get an organization secret /// /// Gets an organization development environment secret without revealing its encrypted value. - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/get(codespaces/get-org-secret)`. @@ -83,43 +87,56 @@ public protocol APIProtocol: Sendable { /// Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `admin:org` scope to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/put(codespaces/create-or-update-org-secret)`. func codespaces_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret(_ input: Operations.codespaces_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret.Input) async throws -> Operations.codespaces_sol_create_hyphen_or_hyphen_update_hyphen_org_hyphen_secret.Output /// Delete an organization secret /// - /// Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Deletes an organization development environment secret using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/delete(codespaces/delete-org-secret)`. func codespaces_sol_delete_hyphen_org_hyphen_secret(_ input: Operations.codespaces_sol_delete_hyphen_org_hyphen_secret.Input) async throws -> Operations.codespaces_sol_delete_hyphen_org_hyphen_secret.Output /// List selected repositories for an organization secret /// - /// Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Lists all repositories that have been selected when the `visibility` + /// for repository access to a secret is set to `selected`. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/get(codespaces/list-selected-repos-for-org-secret)`. func codespaces_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret(_ input: Operations.codespaces_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Input) async throws -> Operations.codespaces_sol_list_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Output /// Set selected repositories for an organization secret /// - /// Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Replaces all repositories for an organization development environment secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/put(codespaces/set-selected-repos-for-org-secret)`. func codespaces_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret(_ input: Operations.codespaces_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Input) async throws -> Operations.codespaces_sol_set_hyphen_selected_hyphen_repos_hyphen_for_hyphen_org_hyphen_secret.Output /// Add selected repository to an organization secret /// - /// Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}/put(codespaces/add-selected-repo-to-org-secret)`. func codespaces_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret(_ input: Operations.codespaces_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret.Input) async throws -> Operations.codespaces_sol_add_hyphen_selected_hyphen_repo_hyphen_to_hyphen_org_hyphen_secret.Output /// Remove selected repository from an organization secret /// - /// Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Removes a repository from an organization development environment secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}/delete(codespaces/remove-selected-repo-from-org-secret)`. @@ -128,7 +145,7 @@ public protocol APIProtocol: Sendable { /// /// Lists the codespaces that a member of an organization has for repositories in that organization. /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/members/{username}/codespaces`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/codespaces/get(codespaces/get-codespaces-for-user-in-org)`. @@ -137,10 +154,7 @@ public protocol APIProtocol: Sendable { /// /// Deletes a user's codespace. /// - /// To use this endpoint you must authenticate using one of the following methods: - /// - /// - An access token with the `admin:org` scope - /// - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/members/{username}/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/codespaces/{codespace_name}/delete(codespaces/delete-from-organization)`. @@ -149,10 +163,7 @@ public protocol APIProtocol: Sendable { /// /// Stops a user's codespace. /// - /// To use this endpoint you must authenticate using one of the following methods: - /// - /// - An access token with the `admin:org` scope - /// - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/codespaces/{codespace_name}/stop/post(codespaces/stop-in-organization)`. @@ -161,12 +172,7 @@ public protocol APIProtocol: Sendable { /// /// Lists the codespaces associated to a specified repository and the authenticated user. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have read access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/get(codespaces/list-in-repository-for-authenticated-user)`. @@ -175,12 +181,7 @@ public protocol APIProtocol: Sendable { /// /// Creates a codespace owned by the authenticated user in the specified repository. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/codespaces`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/post(codespaces/create-with-repo-for-authenticated-user)`. @@ -190,9 +191,7 @@ public protocol APIProtocol: Sendable { /// Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files /// specify launchpoint configurations for codespaces created within the repository. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/devcontainers`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/devcontainers/get(codespaces/list-devcontainers-in-repository-for-authenticated-user)`. @@ -201,9 +200,7 @@ public protocol APIProtocol: Sendable { /// /// List the machine types available for a given repository based on its configuration. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/machines`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/machines/get(codespaces/repo-machines-for-authenticated-user)`. @@ -212,12 +209,7 @@ public protocol APIProtocol: Sendable { /// /// Gets the default attributes for codespaces created by the user with the repository. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/new`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/new/get(codespaces/pre-flight-with-repo-for-authenticated-user)`. @@ -226,33 +218,38 @@ public protocol APIProtocol: Sendable { /// /// Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/permissions_check`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/permissions_check/get(codespaces/check-permissions-for-devcontainer)`. func codespaces_sol_check_hyphen_permissions_hyphen_for_hyphen_devcontainer(_ input: Operations.codespaces_sol_check_hyphen_permissions_hyphen_for_hyphen_devcontainer.Input) async throws -> Operations.codespaces_sol_check_hyphen_permissions_hyphen_for_hyphen_devcontainer.Output /// List repository secrets /// - /// Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + /// Lists all development environment secrets available in a repository without revealing their encrypted + /// values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/get(codespaces/list-repo-secrets)`. func codespaces_sol_list_hyphen_repo_hyphen_secrets(_ input: Operations.codespaces_sol_list_hyphen_repo_hyphen_secrets.Input) async throws -> Operations.codespaces_sol_list_hyphen_repo_hyphen_secrets.Output /// Get a repository public key /// - /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + /// Gets your public key, which you need to encrypt secrets. You need to + /// encrypt a secret before you can create or update secrets. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/secrets/public-key`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/public-key/get(codespaces/get-repo-public-key)`. func codespaces_sol_get_hyphen_repo_hyphen_public_hyphen_key(_ input: Operations.codespaces_sol_get_hyphen_repo_hyphen_public_hyphen_key.Input) async throws -> Operations.codespaces_sol_get_hyphen_repo_hyphen_public_hyphen_key.Output /// Get a repository secret /// - /// Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + /// Gets a single repository development environment secret without revealing its encrypted value. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/{secret_name}/get(codespaces/get-repo-secret)`. @@ -262,19 +259,16 @@ public protocol APIProtocol: Sendable { /// Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - /// repository permission to use this endpoint. - /// - /// This endpoint does not support fine-grained personal access tokens. For more information about personal access tokens, see "[Managing your personal access tokens](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic)." + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/{secret_name}/put(codespaces/create-or-update-repo-secret)`. func codespaces_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret(_ input: Operations.codespaces_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret.Input) async throws -> Operations.codespaces_sol_create_hyphen_or_hyphen_update_hyphen_repo_hyphen_secret.Output /// Delete a repository secret /// - /// Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. - /// This endpoint does not support fine-grained personal access tokens. For more information about personal access tokens, see "[Managing your personal access tokens](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic)." + /// Deletes a development environment secret in a repository using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/{secret_name}/delete(codespaces/delete-repo-secret)`. @@ -283,12 +277,7 @@ public protocol APIProtocol: Sendable { /// /// Creates a codespace owned by the authenticated user for the specified pull request. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pulls/{pull_number}/codespaces`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pulls/{pull_number}/codespaces/post(codespaces/create-with-pr-for-authenticated-user)`. @@ -297,12 +286,7 @@ public protocol APIProtocol: Sendable { /// /// Lists the authenticated user's codespaces. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have read access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces`. /// - Remark: Generated from `#/paths//user/codespaces/get(codespaces/list-for-authenticated-user)`. @@ -313,12 +297,7 @@ public protocol APIProtocol: Sendable { /// /// This endpoint requires either a `repository_id` OR a `pull_request` but not both. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces`. /// - Remark: Generated from `#/paths//user/codespaces/post(codespaces/create-for-authenticated-user)`. @@ -328,9 +307,9 @@ public protocol APIProtocol: Sendable { /// Lists all development environment secrets available for a user's codespaces without revealing their /// encrypted values. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/get(codespaces/list-secrets-for-authenticated-user)`. @@ -339,9 +318,9 @@ public protocol APIProtocol: Sendable { /// /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets/public-key`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/public-key/get(codespaces/get-public-key-for-authenticated-user)`. @@ -350,9 +329,9 @@ public protocol APIProtocol: Sendable { /// /// Gets a development environment secret available to a user's codespaces without revealing its encrypted value. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/get(codespaces/get-secret-for-authenticated-user)`. @@ -362,9 +341,9 @@ public protocol APIProtocol: Sendable { /// Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/put(codespaces/create-or-update-secret-for-authenticated-user)`. @@ -373,9 +352,9 @@ public protocol APIProtocol: Sendable { /// /// Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/delete(codespaces/delete-secret-for-authenticated-user)`. @@ -384,9 +363,9 @@ public protocol APIProtocol: Sendable { /// /// List the repositories that have been granted the ability to use a user's development environment secret. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/get(codespaces/list-repositories-for-secret-for-authenticated-user)`. @@ -395,9 +374,9 @@ public protocol APIProtocol: Sendable { /// /// Select the repositories that will use a user's development environment secret. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/put(codespaces/set-repositories-for-secret-for-authenticated-user)`. @@ -405,8 +384,10 @@ public protocol APIProtocol: Sendable { /// Add a selected repository to a user secret /// /// Adds a repository to the selected repositories for a user's development environment secret. - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + /// + /// The authenticated user must have Codespaces access to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/{repository_id}/put(codespaces/add-repository-for-secret-for-authenticated-user)`. @@ -414,8 +395,10 @@ public protocol APIProtocol: Sendable { /// Remove a selected repository from a user secret /// /// Removes a repository from the selected repositories for a user's development environment secret. - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + /// + /// The authenticated user must have Codespaces access to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/{repository_id}/delete(codespaces/remove-repository-for-secret-for-authenticated-user)`. @@ -424,12 +407,7 @@ public protocol APIProtocol: Sendable { /// /// Gets information about a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have read access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/get(codespaces/get-for-authenticated-user)`. @@ -440,12 +418,7 @@ public protocol APIProtocol: Sendable { /// /// If you specify a new machine type it will be applied the next time your codespace is started. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /user/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/patch(codespaces/update-for-authenticated-user)`. @@ -454,12 +427,7 @@ public protocol APIProtocol: Sendable { /// /// Deletes a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/delete(codespaces/delete-for-authenticated-user)`. @@ -470,9 +438,7 @@ public protocol APIProtocol: Sendable { /// /// If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. /// - /// You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/exports`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/exports/post(codespaces/export-for-authenticated-user)`. @@ -481,9 +447,7 @@ public protocol APIProtocol: Sendable { /// /// Gets information about an export of a codespace. /// - /// You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/{codespace_name}/exports/{export_id}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/exports/{export_id}/get(codespaces/get-export-details-for-authenticated-user)`. @@ -492,9 +456,7 @@ public protocol APIProtocol: Sendable { /// /// List the machine types a codespace can transition to use. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/{codespace_name}/machines`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/machines/get(codespaces/codespace-machines-for-authenticated-user)`. @@ -507,12 +469,7 @@ public protocol APIProtocol: Sendable { /// /// This will fail for a codespace that is already published, meaning it has an associated repository. /// - /// You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/publish`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/publish/post(codespaces/publish-for-authenticated-user)`. @@ -521,9 +478,7 @@ public protocol APIProtocol: Sendable { /// /// Starts a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/start`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/start/post(codespaces/start-for-authenticated-user)`. @@ -532,9 +487,7 @@ public protocol APIProtocol: Sendable { /// /// Stops a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/stop`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/stop/post(codespaces/stop-for-authenticated-user)`. @@ -547,7 +500,7 @@ extension APIProtocol { /// /// Lists the codespaces associated to a specified organization. /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/get(codespaces/list-in-organization)`. @@ -565,7 +518,7 @@ extension APIProtocol { /// Manage access control for organization codespaces /// /// Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/access`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/access/put(codespaces/set-codespaces-access)`. @@ -588,7 +541,7 @@ extension APIProtocol { /// To use this endpoint, the access settings for the organization must be set to `selected_members`. /// For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/codespaces/access/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/access/selected_users/post(codespaces/set-codespaces-access-users)`. @@ -611,7 +564,7 @@ extension APIProtocol { /// To use this endpoint, the access settings for the organization must be set to `selected_members`. /// For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/codespaces/access/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/access/selected_users/delete(codespaces/delete-codespaces-access-users)`. @@ -629,8 +582,10 @@ extension APIProtocol { } /// List organization secrets /// - /// Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted + /// values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/get(codespaces/list-org-secrets)`. @@ -647,7 +602,8 @@ extension APIProtocol { } /// Get an organization public key /// - /// Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets/public-key`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/public-key/get(codespaces/get-org-public-key)`. @@ -663,7 +619,8 @@ extension APIProtocol { /// Get an organization secret /// /// Gets an organization development environment secret without revealing its encrypted value. - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/get(codespaces/get-org-secret)`. @@ -681,8 +638,7 @@ extension APIProtocol { /// Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `admin:org` scope to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/put(codespaces/create-or-update-org-secret)`. @@ -699,7 +655,9 @@ extension APIProtocol { } /// Delete an organization secret /// - /// Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Deletes an organization development environment secret using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/delete(codespaces/delete-org-secret)`. @@ -714,7 +672,10 @@ extension APIProtocol { } /// List selected repositories for an organization secret /// - /// Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Lists all repositories that have been selected when the `visibility` + /// for repository access to a secret is set to `selected`. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/get(codespaces/list-selected-repos-for-org-secret)`. @@ -731,7 +692,11 @@ extension APIProtocol { } /// Set selected repositories for an organization secret /// - /// Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Replaces all repositories for an organization development environment secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/put(codespaces/set-selected-repos-for-org-secret)`. @@ -748,7 +713,8 @@ extension APIProtocol { } /// Add selected repository to an organization secret /// - /// Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}/put(codespaces/add-selected-repo-to-org-secret)`. @@ -763,7 +729,11 @@ extension APIProtocol { } /// Remove selected repository from an organization secret /// - /// Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Removes a repository from an organization development environment secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}/delete(codespaces/remove-selected-repo-from-org-secret)`. @@ -780,7 +750,7 @@ extension APIProtocol { /// /// Lists the codespaces that a member of an organization has for repositories in that organization. /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/members/{username}/codespaces`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/codespaces/get(codespaces/get-codespaces-for-user-in-org)`. @@ -799,10 +769,7 @@ extension APIProtocol { /// /// Deletes a user's codespace. /// - /// To use this endpoint you must authenticate using one of the following methods: - /// - /// - An access token with the `admin:org` scope - /// - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/members/{username}/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/codespaces/{codespace_name}/delete(codespaces/delete-from-organization)`. @@ -819,10 +786,7 @@ extension APIProtocol { /// /// Stops a user's codespace. /// - /// To use this endpoint you must authenticate using one of the following methods: - /// - /// - An access token with the `admin:org` scope - /// - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/codespaces/{codespace_name}/stop/post(codespaces/stop-in-organization)`. @@ -839,12 +803,7 @@ extension APIProtocol { /// /// Lists the codespaces associated to a specified repository and the authenticated user. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have read access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/get(codespaces/list-in-repository-for-authenticated-user)`. @@ -863,12 +822,7 @@ extension APIProtocol { /// /// Creates a codespace owned by the authenticated user in the specified repository. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/codespaces`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/post(codespaces/create-with-repo-for-authenticated-user)`. @@ -888,9 +842,7 @@ extension APIProtocol { /// Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files /// specify launchpoint configurations for codespaces created within the repository. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/devcontainers`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/devcontainers/get(codespaces/list-devcontainers-in-repository-for-authenticated-user)`. @@ -909,9 +861,7 @@ extension APIProtocol { /// /// List the machine types available for a given repository based on its configuration. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/machines`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/machines/get(codespaces/repo-machines-for-authenticated-user)`. @@ -930,12 +880,7 @@ extension APIProtocol { /// /// Gets the default attributes for codespaces created by the user with the repository. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/new`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/new/get(codespaces/pre-flight-with-repo-for-authenticated-user)`. @@ -954,12 +899,7 @@ extension APIProtocol { /// /// Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/permissions_check`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/permissions_check/get(codespaces/check-permissions-for-devcontainer)`. @@ -976,7 +916,10 @@ extension APIProtocol { } /// List repository secrets /// - /// Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + /// Lists all development environment secrets available in a repository without revealing their encrypted + /// values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/get(codespaces/list-repo-secrets)`. @@ -993,7 +936,12 @@ extension APIProtocol { } /// Get a repository public key /// - /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + /// Gets your public key, which you need to encrypt secrets. You need to + /// encrypt a secret before you can create or update secrets. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/secrets/public-key`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/public-key/get(codespaces/get-repo-public-key)`. @@ -1008,7 +956,9 @@ extension APIProtocol { } /// Get a repository secret /// - /// Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + /// Gets a single repository development environment secret without revealing its encrypted value. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/{secret_name}/get(codespaces/get-repo-secret)`. @@ -1026,11 +976,7 @@ extension APIProtocol { /// Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - /// repository permission to use this endpoint. - /// - /// This endpoint does not support fine-grained personal access tokens. For more information about personal access tokens, see "[Managing your personal access tokens](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic)." + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/{secret_name}/put(codespaces/create-or-update-repo-secret)`. @@ -1047,8 +993,9 @@ extension APIProtocol { } /// Delete a repository secret /// - /// Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. - /// This endpoint does not support fine-grained personal access tokens. For more information about personal access tokens, see "[Managing your personal access tokens](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic)." + /// Deletes a development environment secret in a repository using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/{secret_name}/delete(codespaces/delete-repo-secret)`. @@ -1059,12 +1006,7 @@ extension APIProtocol { /// /// Creates a codespace owned by the authenticated user for the specified pull request. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pulls/{pull_number}/codespaces`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pulls/{pull_number}/codespaces/post(codespaces/create-with-pr-for-authenticated-user)`. @@ -1083,12 +1025,7 @@ extension APIProtocol { /// /// Lists the authenticated user's codespaces. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have read access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces`. /// - Remark: Generated from `#/paths//user/codespaces/get(codespaces/list-for-authenticated-user)`. @@ -1107,12 +1044,7 @@ extension APIProtocol { /// /// This endpoint requires either a `repository_id` OR a `pull_request` but not both. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces`. /// - Remark: Generated from `#/paths//user/codespaces/post(codespaces/create-for-authenticated-user)`. @@ -1130,9 +1062,9 @@ extension APIProtocol { /// Lists all development environment secrets available for a user's codespaces without revealing their /// encrypted values. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/get(codespaces/list-secrets-for-authenticated-user)`. @@ -1149,9 +1081,9 @@ extension APIProtocol { /// /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets/public-key`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/public-key/get(codespaces/get-public-key-for-authenticated-user)`. @@ -1162,9 +1094,9 @@ extension APIProtocol { /// /// Gets a development environment secret available to a user's codespaces without revealing its encrypted value. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/get(codespaces/get-secret-for-authenticated-user)`. @@ -1182,9 +1114,9 @@ extension APIProtocol { /// Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/put(codespaces/create-or-update-secret-for-authenticated-user)`. @@ -1203,9 +1135,9 @@ extension APIProtocol { /// /// Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/delete(codespaces/delete-secret-for-authenticated-user)`. @@ -1216,9 +1148,9 @@ extension APIProtocol { /// /// List the repositories that have been granted the ability to use a user's development environment secret. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/get(codespaces/list-repositories-for-secret-for-authenticated-user)`. @@ -1235,9 +1167,9 @@ extension APIProtocol { /// /// Select the repositories that will use a user's development environment secret. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/put(codespaces/set-repositories-for-secret-for-authenticated-user)`. @@ -1255,8 +1187,10 @@ extension APIProtocol { /// Add a selected repository to a user secret /// /// Adds a repository to the selected repositories for a user's development environment secret. - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + /// + /// The authenticated user must have Codespaces access to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/{repository_id}/put(codespaces/add-repository-for-secret-for-authenticated-user)`. @@ -1272,8 +1206,10 @@ extension APIProtocol { /// Remove a selected repository from a user secret /// /// Removes a repository from the selected repositories for a user's development environment secret. - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + /// + /// The authenticated user must have Codespaces access to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/{repository_id}/delete(codespaces/remove-repository-for-secret-for-authenticated-user)`. @@ -1290,12 +1226,7 @@ extension APIProtocol { /// /// Gets information about a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have read access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/get(codespaces/get-for-authenticated-user)`. @@ -1314,12 +1245,7 @@ extension APIProtocol { /// /// If you specify a new machine type it will be applied the next time your codespace is started. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /user/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/patch(codespaces/update-for-authenticated-user)`. @@ -1338,12 +1264,7 @@ extension APIProtocol { /// /// Deletes a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/delete(codespaces/delete-for-authenticated-user)`. @@ -1362,9 +1283,7 @@ extension APIProtocol { /// /// If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. /// - /// You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/exports`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/exports/post(codespaces/export-for-authenticated-user)`. @@ -1381,9 +1300,7 @@ extension APIProtocol { /// /// Gets information about an export of a codespace. /// - /// You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/{codespace_name}/exports/{export_id}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/exports/{export_id}/get(codespaces/get-export-details-for-authenticated-user)`. @@ -1400,9 +1317,7 @@ extension APIProtocol { /// /// List the machine types a codespace can transition to use. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/{codespace_name}/machines`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/machines/get(codespaces/codespace-machines-for-authenticated-user)`. @@ -1423,12 +1338,7 @@ extension APIProtocol { /// /// This will fail for a codespace that is already published, meaning it has an associated repository. /// - /// You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/publish`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/publish/post(codespaces/publish-for-authenticated-user)`. @@ -1447,9 +1357,7 @@ extension APIProtocol { /// /// Starts a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/start`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/start/post(codespaces/start-for-authenticated-user)`. @@ -1466,9 +1374,7 @@ extension APIProtocol { /// /// Stops a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/stop`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/stop/post(codespaces/stop-for-authenticated-user)`. @@ -2053,8 +1959,6 @@ public enum Components { public var full_name: Swift.String /// - Remark: Generated from `#/components/schemas/repository/license`. public var license: Components.Schemas.nullable_hyphen_license_hyphen_simple? - /// - Remark: Generated from `#/components/schemas/repository/organization`. - public var organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? /// - Remark: Generated from `#/components/schemas/repository/forks`. public var forks: Swift.Int /// - Remark: Generated from `#/components/schemas/repository/permissions`. @@ -2267,767 +2171,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/repository/allow_rebase_merge`. public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository`. - public struct template_repositoryPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/name`. - public var name: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/full_name`. - public var full_name: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner`. - public struct ownerPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/login`. - public var login: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/avatar_url`. - public var avatar_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/gravatar_id`. - public var gravatar_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/followers_url`. - public var followers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/following_url`. - public var following_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/gists_url`. - public var gists_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/starred_url`. - public var starred_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/subscriptions_url`. - public var subscriptions_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/organizations_url`. - public var organizations_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/repos_url`. - public var repos_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/received_events_url`. - public var received_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/type`. - public var _type: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/site_admin`. - public var site_admin: Swift.Bool? - /// Creates a new `ownerPayload`. - /// - /// - Parameters: - /// - login: - /// - id: - /// - node_id: - /// - avatar_url: - /// - gravatar_id: - /// - url: - /// - html_url: - /// - followers_url: - /// - following_url: - /// - gists_url: - /// - starred_url: - /// - subscriptions_url: - /// - organizations_url: - /// - repos_url: - /// - events_url: - /// - received_events_url: - /// - _type: - /// - site_admin: - public init( - login: Swift.String? = nil, - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - avatar_url: Swift.String? = nil, - gravatar_id: Swift.String? = nil, - url: Swift.String? = nil, - html_url: Swift.String? = nil, - followers_url: Swift.String? = nil, - following_url: Swift.String? = nil, - gists_url: Swift.String? = nil, - starred_url: Swift.String? = nil, - subscriptions_url: Swift.String? = nil, - organizations_url: Swift.String? = nil, - repos_url: Swift.String? = nil, - events_url: Swift.String? = nil, - received_events_url: Swift.String? = nil, - _type: Swift.String? = nil, - site_admin: Swift.Bool? = nil - ) { - self.login = login - self.id = id - self.node_id = node_id - self.avatar_url = avatar_url - self.gravatar_id = gravatar_id - self.url = url - self.html_url = html_url - self.followers_url = followers_url - self.following_url = following_url - self.gists_url = gists_url - self.starred_url = starred_url - self.subscriptions_url = subscriptions_url - self.organizations_url = organizations_url - self.repos_url = repos_url - self.events_url = events_url - self.received_events_url = received_events_url - self._type = _type - self.site_admin = site_admin - } - public enum CodingKeys: String, CodingKey { - case login - case id - case node_id - case avatar_url - case gravatar_id - case url - case html_url - case followers_url - case following_url - case gists_url - case starred_url - case subscriptions_url - case organizations_url - case repos_url - case events_url - case received_events_url - case _type = "type" - case site_admin - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner`. - public var owner: Components.Schemas.repository.template_repositoryPayload.ownerPayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/private`. - public var _private: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/description`. - public var description: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/fork`. - public var fork: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/archive_url`. - public var archive_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/assignees_url`. - public var assignees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/blobs_url`. - public var blobs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/branches_url`. - public var branches_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/collaborators_url`. - public var collaborators_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/comments_url`. - public var comments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/commits_url`. - public var commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/compare_url`. - public var compare_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/contents_url`. - public var contents_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/contributors_url`. - public var contributors_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/deployments_url`. - public var deployments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/downloads_url`. - public var downloads_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/forks_url`. - public var forks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_commits_url`. - public var git_commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_refs_url`. - public var git_refs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_tags_url`. - public var git_tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_url`. - public var git_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issue_comment_url`. - public var issue_comment_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issue_events_url`. - public var issue_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issues_url`. - public var issues_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/keys_url`. - public var keys_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/labels_url`. - public var labels_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/languages_url`. - public var languages_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merges_url`. - public var merges_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/milestones_url`. - public var milestones_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/notifications_url`. - public var notifications_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/pulls_url`. - public var pulls_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/releases_url`. - public var releases_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/ssh_url`. - public var ssh_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/stargazers_url`. - public var stargazers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/statuses_url`. - public var statuses_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscribers_url`. - public var subscribers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscription_url`. - public var subscription_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/tags_url`. - public var tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/teams_url`. - public var teams_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/trees_url`. - public var trees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/clone_url`. - public var clone_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/mirror_url`. - public var mirror_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/hooks_url`. - public var hooks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/svn_url`. - public var svn_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/homepage`. - public var homepage: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/language`. - public var language: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/forks_count`. - public var forks_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/stargazers_count`. - public var stargazers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/watchers_count`. - public var watchers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/size`. - public var size: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/default_branch`. - public var default_branch: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/open_issues_count`. - public var open_issues_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/is_template`. - public var is_template: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/topics`. - public var topics: [Swift.String]? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_issues`. - public var has_issues: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_projects`. - public var has_projects: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_wiki`. - public var has_wiki: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_pages`. - public var has_pages: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_downloads`. - public var has_downloads: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/archived`. - public var archived: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/disabled`. - public var disabled: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/visibility`. - public var visibility: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/pushed_at`. - public var pushed_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/created_at`. - public var created_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/updated_at`. - public var updated_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions`. - public struct permissionsPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/admin`. - public var admin: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/maintain`. - public var maintain: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/push`. - public var push: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/triage`. - public var triage: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/pull`. - public var pull: Swift.Bool? - /// Creates a new `permissionsPayload`. - /// - /// - Parameters: - /// - admin: - /// - maintain: - /// - push: - /// - triage: - /// - pull: - public init( - admin: Swift.Bool? = nil, - maintain: Swift.Bool? = nil, - push: Swift.Bool? = nil, - triage: Swift.Bool? = nil, - pull: Swift.Bool? = nil - ) { - self.admin = admin - self.maintain = maintain - self.push = push - self.triage = triage - self.pull = pull - } - public enum CodingKeys: String, CodingKey { - case admin - case maintain - case push - case triage - case pull - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions`. - public var permissions: Components.Schemas.repository.template_repositoryPayload.permissionsPayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_rebase_merge`. - public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/temp_clone_token`. - public var temp_clone_token: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_squash_merge`. - public var allow_squash_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_auto_merge`. - public var allow_auto_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/delete_branch_on_merge`. - public var delete_branch_on_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_update_branch`. - public var allow_update_branch: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/use_squash_pr_title_as_default`. - public var use_squash_pr_title_as_default: Swift.Bool? - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_title`. - @frozen public enum squash_merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case COMMIT_OR_PR_TITLE = "COMMIT_OR_PR_TITLE" - } - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_title`. - public var squash_merge_commit_title: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_titlePayload? - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_message`. - @frozen public enum squash_merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case COMMIT_MESSAGES = "COMMIT_MESSAGES" - case BLANK = "BLANK" - } - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_message`. - public var squash_merge_commit_message: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_messagePayload? - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_title`. - @frozen public enum merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case MERGE_MESSAGE = "MERGE_MESSAGE" - } - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_title`. - public var merge_commit_title: Components.Schemas.repository.template_repositoryPayload.merge_commit_titlePayload? - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_message`. - @frozen public enum merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case PR_TITLE = "PR_TITLE" - case BLANK = "BLANK" - } - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_message`. - public var merge_commit_message: Components.Schemas.repository.template_repositoryPayload.merge_commit_messagePayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_merge_commit`. - public var allow_merge_commit: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/network_count`. - public var network_count: Swift.Int? - /// Creates a new `template_repositoryPayload`. - /// - /// - Parameters: - /// - id: - /// - node_id: - /// - name: - /// - full_name: - /// - owner: - /// - _private: - /// - html_url: - /// - description: - /// - fork: - /// - url: - /// - archive_url: - /// - assignees_url: - /// - blobs_url: - /// - branches_url: - /// - collaborators_url: - /// - comments_url: - /// - commits_url: - /// - compare_url: - /// - contents_url: - /// - contributors_url: - /// - deployments_url: - /// - downloads_url: - /// - events_url: - /// - forks_url: - /// - git_commits_url: - /// - git_refs_url: - /// - git_tags_url: - /// - git_url: - /// - issue_comment_url: - /// - issue_events_url: - /// - issues_url: - /// - keys_url: - /// - labels_url: - /// - languages_url: - /// - merges_url: - /// - milestones_url: - /// - notifications_url: - /// - pulls_url: - /// - releases_url: - /// - ssh_url: - /// - stargazers_url: - /// - statuses_url: - /// - subscribers_url: - /// - subscription_url: - /// - tags_url: - /// - teams_url: - /// - trees_url: - /// - clone_url: - /// - mirror_url: - /// - hooks_url: - /// - svn_url: - /// - homepage: - /// - language: - /// - forks_count: - /// - stargazers_count: - /// - watchers_count: - /// - size: - /// - default_branch: - /// - open_issues_count: - /// - is_template: - /// - topics: - /// - has_issues: - /// - has_projects: - /// - has_wiki: - /// - has_pages: - /// - has_downloads: - /// - archived: - /// - disabled: - /// - visibility: - /// - pushed_at: - /// - created_at: - /// - updated_at: - /// - permissions: - /// - allow_rebase_merge: - /// - temp_clone_token: - /// - allow_squash_merge: - /// - allow_auto_merge: - /// - delete_branch_on_merge: - /// - allow_update_branch: - /// - use_squash_pr_title_as_default: - /// - squash_merge_commit_title: The default value for a squash merge commit title: - /// - squash_merge_commit_message: The default value for a squash merge commit message: - /// - merge_commit_title: The default value for a merge commit title. - /// - merge_commit_message: The default value for a merge commit message. - /// - allow_merge_commit: - /// - subscribers_count: - /// - network_count: - public init( - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - name: Swift.String? = nil, - full_name: Swift.String? = nil, - owner: Components.Schemas.repository.template_repositoryPayload.ownerPayload? = nil, - _private: Swift.Bool? = nil, - html_url: Swift.String? = nil, - description: Swift.String? = nil, - fork: Swift.Bool? = nil, - url: Swift.String? = nil, - archive_url: Swift.String? = nil, - assignees_url: Swift.String? = nil, - blobs_url: Swift.String? = nil, - branches_url: Swift.String? = nil, - collaborators_url: Swift.String? = nil, - comments_url: Swift.String? = nil, - commits_url: Swift.String? = nil, - compare_url: Swift.String? = nil, - contents_url: Swift.String? = nil, - contributors_url: Swift.String? = nil, - deployments_url: Swift.String? = nil, - downloads_url: Swift.String? = nil, - events_url: Swift.String? = nil, - forks_url: Swift.String? = nil, - git_commits_url: Swift.String? = nil, - git_refs_url: Swift.String? = nil, - git_tags_url: Swift.String? = nil, - git_url: Swift.String? = nil, - issue_comment_url: Swift.String? = nil, - issue_events_url: Swift.String? = nil, - issues_url: Swift.String? = nil, - keys_url: Swift.String? = nil, - labels_url: Swift.String? = nil, - languages_url: Swift.String? = nil, - merges_url: Swift.String? = nil, - milestones_url: Swift.String? = nil, - notifications_url: Swift.String? = nil, - pulls_url: Swift.String? = nil, - releases_url: Swift.String? = nil, - ssh_url: Swift.String? = nil, - stargazers_url: Swift.String? = nil, - statuses_url: Swift.String? = nil, - subscribers_url: Swift.String? = nil, - subscription_url: Swift.String? = nil, - tags_url: Swift.String? = nil, - teams_url: Swift.String? = nil, - trees_url: Swift.String? = nil, - clone_url: Swift.String? = nil, - mirror_url: Swift.String? = nil, - hooks_url: Swift.String? = nil, - svn_url: Swift.String? = nil, - homepage: Swift.String? = nil, - language: Swift.String? = nil, - forks_count: Swift.Int? = nil, - stargazers_count: Swift.Int? = nil, - watchers_count: Swift.Int? = nil, - size: Swift.Int? = nil, - default_branch: Swift.String? = nil, - open_issues_count: Swift.Int? = nil, - is_template: Swift.Bool? = nil, - topics: [Swift.String]? = nil, - has_issues: Swift.Bool? = nil, - has_projects: Swift.Bool? = nil, - has_wiki: Swift.Bool? = nil, - has_pages: Swift.Bool? = nil, - has_downloads: Swift.Bool? = nil, - archived: Swift.Bool? = nil, - disabled: Swift.Bool? = nil, - visibility: Swift.String? = nil, - pushed_at: Swift.String? = nil, - created_at: Swift.String? = nil, - updated_at: Swift.String? = nil, - permissions: Components.Schemas.repository.template_repositoryPayload.permissionsPayload? = nil, - allow_rebase_merge: Swift.Bool? = nil, - temp_clone_token: Swift.String? = nil, - allow_squash_merge: Swift.Bool? = nil, - allow_auto_merge: Swift.Bool? = nil, - delete_branch_on_merge: Swift.Bool? = nil, - allow_update_branch: Swift.Bool? = nil, - use_squash_pr_title_as_default: Swift.Bool? = nil, - squash_merge_commit_title: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_titlePayload? = nil, - squash_merge_commit_message: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_messagePayload? = nil, - merge_commit_title: Components.Schemas.repository.template_repositoryPayload.merge_commit_titlePayload? = nil, - merge_commit_message: Components.Schemas.repository.template_repositoryPayload.merge_commit_messagePayload? = nil, - allow_merge_commit: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil - ) { - self.id = id - self.node_id = node_id - self.name = name - self.full_name = full_name - self.owner = owner - self._private = _private - self.html_url = html_url - self.description = description - self.fork = fork - self.url = url - self.archive_url = archive_url - self.assignees_url = assignees_url - self.blobs_url = blobs_url - self.branches_url = branches_url - self.collaborators_url = collaborators_url - self.comments_url = comments_url - self.commits_url = commits_url - self.compare_url = compare_url - self.contents_url = contents_url - self.contributors_url = contributors_url - self.deployments_url = deployments_url - self.downloads_url = downloads_url - self.events_url = events_url - self.forks_url = forks_url - self.git_commits_url = git_commits_url - self.git_refs_url = git_refs_url - self.git_tags_url = git_tags_url - self.git_url = git_url - self.issue_comment_url = issue_comment_url - self.issue_events_url = issue_events_url - self.issues_url = issues_url - self.keys_url = keys_url - self.labels_url = labels_url - self.languages_url = languages_url - self.merges_url = merges_url - self.milestones_url = milestones_url - self.notifications_url = notifications_url - self.pulls_url = pulls_url - self.releases_url = releases_url - self.ssh_url = ssh_url - self.stargazers_url = stargazers_url - self.statuses_url = statuses_url - self.subscribers_url = subscribers_url - self.subscription_url = subscription_url - self.tags_url = tags_url - self.teams_url = teams_url - self.trees_url = trees_url - self.clone_url = clone_url - self.mirror_url = mirror_url - self.hooks_url = hooks_url - self.svn_url = svn_url - self.homepage = homepage - self.language = language - self.forks_count = forks_count - self.stargazers_count = stargazers_count - self.watchers_count = watchers_count - self.size = size - self.default_branch = default_branch - self.open_issues_count = open_issues_count - self.is_template = is_template - self.topics = topics - self.has_issues = has_issues - self.has_projects = has_projects - self.has_wiki = has_wiki - self.has_pages = has_pages - self.has_downloads = has_downloads - self.archived = archived - self.disabled = disabled - self.visibility = visibility - self.pushed_at = pushed_at - self.created_at = created_at - self.updated_at = updated_at - self.permissions = permissions - self.allow_rebase_merge = allow_rebase_merge - self.temp_clone_token = temp_clone_token - self.allow_squash_merge = allow_squash_merge - self.allow_auto_merge = allow_auto_merge - self.delete_branch_on_merge = delete_branch_on_merge - self.allow_update_branch = allow_update_branch - self.use_squash_pr_title_as_default = use_squash_pr_title_as_default - self.squash_merge_commit_title = squash_merge_commit_title - self.squash_merge_commit_message = squash_merge_commit_message - self.merge_commit_title = merge_commit_title - self.merge_commit_message = merge_commit_message - self.allow_merge_commit = allow_merge_commit - self.subscribers_count = subscribers_count - self.network_count = network_count - } - public enum CodingKeys: String, CodingKey { - case id - case node_id - case name - case full_name - case owner - case _private = "private" - case html_url - case description - case fork - case url - case archive_url - case assignees_url - case blobs_url - case branches_url - case collaborators_url - case comments_url - case commits_url - case compare_url - case contents_url - case contributors_url - case deployments_url - case downloads_url - case events_url - case forks_url - case git_commits_url - case git_refs_url - case git_tags_url - case git_url - case issue_comment_url - case issue_events_url - case issues_url - case keys_url - case labels_url - case languages_url - case merges_url - case milestones_url - case notifications_url - case pulls_url - case releases_url - case ssh_url - case stargazers_url - case statuses_url - case subscribers_url - case subscription_url - case tags_url - case teams_url - case trees_url - case clone_url - case mirror_url - case hooks_url - case svn_url - case homepage - case language - case forks_count - case stargazers_count - case watchers_count - case size - case default_branch - case open_issues_count - case is_template - case topics - case has_issues - case has_projects - case has_wiki - case has_pages - case has_downloads - case archived - case disabled - case visibility - case pushed_at - case created_at - case updated_at - case permissions - case allow_rebase_merge - case temp_clone_token - case allow_squash_merge - case allow_auto_merge - case delete_branch_on_merge - case allow_update_branch - case use_squash_pr_title_as_default - case squash_merge_commit_title - case squash_merge_commit_message - case merge_commit_title - case merge_commit_message - case allow_merge_commit - case subscribers_count - case network_count - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository`. - public var template_repository: Components.Schemas.repository.template_repositoryPayload? /// - Remark: Generated from `#/components/schemas/repository/temp_clone_token`. public var temp_clone_token: Swift.String? /// Whether to allow squash merges for pull requests. @@ -3137,10 +2280,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/repository/web_commit_signoff_required`. public var web_commit_signoff_required: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/network_count`. - public var network_count: Swift.Int? /// - Remark: Generated from `#/components/schemas/repository/open_issues`. public var open_issues: Swift.Int /// - Remark: Generated from `#/components/schemas/repository/watchers`. @@ -3161,7 +2300,6 @@ public enum Components { /// - name: The name of the repository. /// - full_name: /// - license: - /// - organization: /// - forks: /// - permissions: /// - owner: @@ -3234,7 +2372,6 @@ public enum Components { /// - created_at: /// - updated_at: /// - allow_rebase_merge: Whether to allow rebase merges for pull requests. - /// - template_repository: /// - temp_clone_token: /// - allow_squash_merge: Whether to allow squash merges for pull requests. /// - allow_auto_merge: Whether to allow Auto-merge to be used on pull requests. @@ -3248,8 +2385,6 @@ public enum Components { /// - allow_merge_commit: Whether to allow merge commits for pull requests. /// - allow_forking: Whether to allow forking this repo /// - web_commit_signoff_required: Whether to require contributors to sign off on web-based commits - /// - subscribers_count: - /// - network_count: /// - open_issues: /// - watchers: /// - master_branch: @@ -3261,7 +2396,6 @@ public enum Components { name: Swift.String, full_name: Swift.String, license: Components.Schemas.nullable_hyphen_license_hyphen_simple? = nil, - organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? = nil, forks: Swift.Int, permissions: Components.Schemas.repository.permissionsPayload? = nil, owner: Components.Schemas.simple_hyphen_user, @@ -3334,7 +2468,6 @@ public enum Components { created_at: Foundation.Date? = nil, updated_at: Foundation.Date? = nil, allow_rebase_merge: Swift.Bool? = nil, - template_repository: Components.Schemas.repository.template_repositoryPayload? = nil, temp_clone_token: Swift.String? = nil, allow_squash_merge: Swift.Bool? = nil, allow_auto_merge: Swift.Bool? = nil, @@ -3348,8 +2481,6 @@ public enum Components { allow_merge_commit: Swift.Bool? = nil, allow_forking: Swift.Bool? = nil, web_commit_signoff_required: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil, open_issues: Swift.Int, watchers: Swift.Int, master_branch: Swift.String? = nil, @@ -3361,7 +2492,6 @@ public enum Components { self.name = name self.full_name = full_name self.license = license - self.organization = organization self.forks = forks self.permissions = permissions self.owner = owner @@ -3434,7 +2564,6 @@ public enum Components { self.created_at = created_at self.updated_at = updated_at self.allow_rebase_merge = allow_rebase_merge - self.template_repository = template_repository self.temp_clone_token = temp_clone_token self.allow_squash_merge = allow_squash_merge self.allow_auto_merge = allow_auto_merge @@ -3448,8 +2577,6 @@ public enum Components { self.allow_merge_commit = allow_merge_commit self.allow_forking = allow_forking self.web_commit_signoff_required = web_commit_signoff_required - self.subscribers_count = subscribers_count - self.network_count = network_count self.open_issues = open_issues self.watchers = watchers self.master_branch = master_branch @@ -3462,7 +2589,6 @@ public enum Components { case name case full_name case license - case organization case forks case permissions case owner @@ -3535,7 +2661,6 @@ public enum Components { case created_at case updated_at case allow_rebase_merge - case template_repository case temp_clone_token case allow_squash_merge case allow_auto_merge @@ -3549,8 +2674,6 @@ public enum Components { case allow_merge_commit case allow_forking case web_commit_signoff_required - case subscribers_count - case network_count case open_issues case watchers case master_branch @@ -4914,8 +4037,6 @@ public enum Components { public var full_name: Swift.String /// - Remark: Generated from `#/components/schemas/nullable-repository/license`. public var license: Components.Schemas.nullable_hyphen_license_hyphen_simple? - /// - Remark: Generated from `#/components/schemas/nullable-repository/organization`. - public var organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? /// - Remark: Generated from `#/components/schemas/nullable-repository/forks`. public var forks: Swift.Int /// - Remark: Generated from `#/components/schemas/nullable-repository/permissions`. @@ -5128,767 +4249,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/nullable-repository/allow_rebase_merge`. public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository`. - public struct template_repositoryPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/name`. - public var name: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/full_name`. - public var full_name: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner`. - public struct ownerPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/login`. - public var login: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/avatar_url`. - public var avatar_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/gravatar_id`. - public var gravatar_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/followers_url`. - public var followers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/following_url`. - public var following_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/gists_url`. - public var gists_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/starred_url`. - public var starred_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/subscriptions_url`. - public var subscriptions_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/organizations_url`. - public var organizations_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/repos_url`. - public var repos_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/received_events_url`. - public var received_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/type`. - public var _type: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/site_admin`. - public var site_admin: Swift.Bool? - /// Creates a new `ownerPayload`. - /// - /// - Parameters: - /// - login: - /// - id: - /// - node_id: - /// - avatar_url: - /// - gravatar_id: - /// - url: - /// - html_url: - /// - followers_url: - /// - following_url: - /// - gists_url: - /// - starred_url: - /// - subscriptions_url: - /// - organizations_url: - /// - repos_url: - /// - events_url: - /// - received_events_url: - /// - _type: - /// - site_admin: - public init( - login: Swift.String? = nil, - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - avatar_url: Swift.String? = nil, - gravatar_id: Swift.String? = nil, - url: Swift.String? = nil, - html_url: Swift.String? = nil, - followers_url: Swift.String? = nil, - following_url: Swift.String? = nil, - gists_url: Swift.String? = nil, - starred_url: Swift.String? = nil, - subscriptions_url: Swift.String? = nil, - organizations_url: Swift.String? = nil, - repos_url: Swift.String? = nil, - events_url: Swift.String? = nil, - received_events_url: Swift.String? = nil, - _type: Swift.String? = nil, - site_admin: Swift.Bool? = nil - ) { - self.login = login - self.id = id - self.node_id = node_id - self.avatar_url = avatar_url - self.gravatar_id = gravatar_id - self.url = url - self.html_url = html_url - self.followers_url = followers_url - self.following_url = following_url - self.gists_url = gists_url - self.starred_url = starred_url - self.subscriptions_url = subscriptions_url - self.organizations_url = organizations_url - self.repos_url = repos_url - self.events_url = events_url - self.received_events_url = received_events_url - self._type = _type - self.site_admin = site_admin - } - public enum CodingKeys: String, CodingKey { - case login - case id - case node_id - case avatar_url - case gravatar_id - case url - case html_url - case followers_url - case following_url - case gists_url - case starred_url - case subscriptions_url - case organizations_url - case repos_url - case events_url - case received_events_url - case _type = "type" - case site_admin - } - } - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner`. - public var owner: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.ownerPayload? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/private`. - public var _private: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/description`. - public var description: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/fork`. - public var fork: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/archive_url`. - public var archive_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/assignees_url`. - public var assignees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/blobs_url`. - public var blobs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/branches_url`. - public var branches_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/collaborators_url`. - public var collaborators_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/comments_url`. - public var comments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/commits_url`. - public var commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/compare_url`. - public var compare_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/contents_url`. - public var contents_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/contributors_url`. - public var contributors_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/deployments_url`. - public var deployments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/downloads_url`. - public var downloads_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/forks_url`. - public var forks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/git_commits_url`. - public var git_commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/git_refs_url`. - public var git_refs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/git_tags_url`. - public var git_tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/git_url`. - public var git_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/issue_comment_url`. - public var issue_comment_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/issue_events_url`. - public var issue_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/issues_url`. - public var issues_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/keys_url`. - public var keys_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/labels_url`. - public var labels_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/languages_url`. - public var languages_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merges_url`. - public var merges_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/milestones_url`. - public var milestones_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/notifications_url`. - public var notifications_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/pulls_url`. - public var pulls_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/releases_url`. - public var releases_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/ssh_url`. - public var ssh_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/stargazers_url`. - public var stargazers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/statuses_url`. - public var statuses_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/subscribers_url`. - public var subscribers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/subscription_url`. - public var subscription_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/tags_url`. - public var tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/teams_url`. - public var teams_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/trees_url`. - public var trees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/clone_url`. - public var clone_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/mirror_url`. - public var mirror_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/hooks_url`. - public var hooks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/svn_url`. - public var svn_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/homepage`. - public var homepage: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/language`. - public var language: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/forks_count`. - public var forks_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/stargazers_count`. - public var stargazers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/watchers_count`. - public var watchers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/size`. - public var size: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/default_branch`. - public var default_branch: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/open_issues_count`. - public var open_issues_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/is_template`. - public var is_template: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/topics`. - public var topics: [Swift.String]? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_issues`. - public var has_issues: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_projects`. - public var has_projects: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_wiki`. - public var has_wiki: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_pages`. - public var has_pages: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_downloads`. - public var has_downloads: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/archived`. - public var archived: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/disabled`. - public var disabled: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/visibility`. - public var visibility: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/pushed_at`. - public var pushed_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/created_at`. - public var created_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/updated_at`. - public var updated_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions`. - public struct permissionsPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/admin`. - public var admin: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/maintain`. - public var maintain: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/push`. - public var push: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/triage`. - public var triage: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/pull`. - public var pull: Swift.Bool? - /// Creates a new `permissionsPayload`. - /// - /// - Parameters: - /// - admin: - /// - maintain: - /// - push: - /// - triage: - /// - pull: - public init( - admin: Swift.Bool? = nil, - maintain: Swift.Bool? = nil, - push: Swift.Bool? = nil, - triage: Swift.Bool? = nil, - pull: Swift.Bool? = nil - ) { - self.admin = admin - self.maintain = maintain - self.push = push - self.triage = triage - self.pull = pull - } - public enum CodingKeys: String, CodingKey { - case admin - case maintain - case push - case triage - case pull - } - } - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions`. - public var permissions: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.permissionsPayload? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_rebase_merge`. - public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/temp_clone_token`. - public var temp_clone_token: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_squash_merge`. - public var allow_squash_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_auto_merge`. - public var allow_auto_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/delete_branch_on_merge`. - public var delete_branch_on_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_update_branch`. - public var allow_update_branch: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/use_squash_pr_title_as_default`. - public var use_squash_pr_title_as_default: Swift.Bool? - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/squash_merge_commit_title`. - @frozen public enum squash_merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case COMMIT_OR_PR_TITLE = "COMMIT_OR_PR_TITLE" - } - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/squash_merge_commit_title`. - public var squash_merge_commit_title: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.squash_merge_commit_titlePayload? - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/squash_merge_commit_message`. - @frozen public enum squash_merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case COMMIT_MESSAGES = "COMMIT_MESSAGES" - case BLANK = "BLANK" - } - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/squash_merge_commit_message`. - public var squash_merge_commit_message: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.squash_merge_commit_messagePayload? - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merge_commit_title`. - @frozen public enum merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case MERGE_MESSAGE = "MERGE_MESSAGE" - } - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merge_commit_title`. - public var merge_commit_title: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.merge_commit_titlePayload? - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merge_commit_message`. - @frozen public enum merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case PR_TITLE = "PR_TITLE" - case BLANK = "BLANK" - } - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merge_commit_message`. - public var merge_commit_message: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.merge_commit_messagePayload? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_merge_commit`. - public var allow_merge_commit: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/network_count`. - public var network_count: Swift.Int? - /// Creates a new `template_repositoryPayload`. - /// - /// - Parameters: - /// - id: - /// - node_id: - /// - name: - /// - full_name: - /// - owner: - /// - _private: - /// - html_url: - /// - description: - /// - fork: - /// - url: - /// - archive_url: - /// - assignees_url: - /// - blobs_url: - /// - branches_url: - /// - collaborators_url: - /// - comments_url: - /// - commits_url: - /// - compare_url: - /// - contents_url: - /// - contributors_url: - /// - deployments_url: - /// - downloads_url: - /// - events_url: - /// - forks_url: - /// - git_commits_url: - /// - git_refs_url: - /// - git_tags_url: - /// - git_url: - /// - issue_comment_url: - /// - issue_events_url: - /// - issues_url: - /// - keys_url: - /// - labels_url: - /// - languages_url: - /// - merges_url: - /// - milestones_url: - /// - notifications_url: - /// - pulls_url: - /// - releases_url: - /// - ssh_url: - /// - stargazers_url: - /// - statuses_url: - /// - subscribers_url: - /// - subscription_url: - /// - tags_url: - /// - teams_url: - /// - trees_url: - /// - clone_url: - /// - mirror_url: - /// - hooks_url: - /// - svn_url: - /// - homepage: - /// - language: - /// - forks_count: - /// - stargazers_count: - /// - watchers_count: - /// - size: - /// - default_branch: - /// - open_issues_count: - /// - is_template: - /// - topics: - /// - has_issues: - /// - has_projects: - /// - has_wiki: - /// - has_pages: - /// - has_downloads: - /// - archived: - /// - disabled: - /// - visibility: - /// - pushed_at: - /// - created_at: - /// - updated_at: - /// - permissions: - /// - allow_rebase_merge: - /// - temp_clone_token: - /// - allow_squash_merge: - /// - allow_auto_merge: - /// - delete_branch_on_merge: - /// - allow_update_branch: - /// - use_squash_pr_title_as_default: - /// - squash_merge_commit_title: The default value for a squash merge commit title: - /// - squash_merge_commit_message: The default value for a squash merge commit message: - /// - merge_commit_title: The default value for a merge commit title. - /// - merge_commit_message: The default value for a merge commit message. - /// - allow_merge_commit: - /// - subscribers_count: - /// - network_count: - public init( - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - name: Swift.String? = nil, - full_name: Swift.String? = nil, - owner: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.ownerPayload? = nil, - _private: Swift.Bool? = nil, - html_url: Swift.String? = nil, - description: Swift.String? = nil, - fork: Swift.Bool? = nil, - url: Swift.String? = nil, - archive_url: Swift.String? = nil, - assignees_url: Swift.String? = nil, - blobs_url: Swift.String? = nil, - branches_url: Swift.String? = nil, - collaborators_url: Swift.String? = nil, - comments_url: Swift.String? = nil, - commits_url: Swift.String? = nil, - compare_url: Swift.String? = nil, - contents_url: Swift.String? = nil, - contributors_url: Swift.String? = nil, - deployments_url: Swift.String? = nil, - downloads_url: Swift.String? = nil, - events_url: Swift.String? = nil, - forks_url: Swift.String? = nil, - git_commits_url: Swift.String? = nil, - git_refs_url: Swift.String? = nil, - git_tags_url: Swift.String? = nil, - git_url: Swift.String? = nil, - issue_comment_url: Swift.String? = nil, - issue_events_url: Swift.String? = nil, - issues_url: Swift.String? = nil, - keys_url: Swift.String? = nil, - labels_url: Swift.String? = nil, - languages_url: Swift.String? = nil, - merges_url: Swift.String? = nil, - milestones_url: Swift.String? = nil, - notifications_url: Swift.String? = nil, - pulls_url: Swift.String? = nil, - releases_url: Swift.String? = nil, - ssh_url: Swift.String? = nil, - stargazers_url: Swift.String? = nil, - statuses_url: Swift.String? = nil, - subscribers_url: Swift.String? = nil, - subscription_url: Swift.String? = nil, - tags_url: Swift.String? = nil, - teams_url: Swift.String? = nil, - trees_url: Swift.String? = nil, - clone_url: Swift.String? = nil, - mirror_url: Swift.String? = nil, - hooks_url: Swift.String? = nil, - svn_url: Swift.String? = nil, - homepage: Swift.String? = nil, - language: Swift.String? = nil, - forks_count: Swift.Int? = nil, - stargazers_count: Swift.Int? = nil, - watchers_count: Swift.Int? = nil, - size: Swift.Int? = nil, - default_branch: Swift.String? = nil, - open_issues_count: Swift.Int? = nil, - is_template: Swift.Bool? = nil, - topics: [Swift.String]? = nil, - has_issues: Swift.Bool? = nil, - has_projects: Swift.Bool? = nil, - has_wiki: Swift.Bool? = nil, - has_pages: Swift.Bool? = nil, - has_downloads: Swift.Bool? = nil, - archived: Swift.Bool? = nil, - disabled: Swift.Bool? = nil, - visibility: Swift.String? = nil, - pushed_at: Swift.String? = nil, - created_at: Swift.String? = nil, - updated_at: Swift.String? = nil, - permissions: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.permissionsPayload? = nil, - allow_rebase_merge: Swift.Bool? = nil, - temp_clone_token: Swift.String? = nil, - allow_squash_merge: Swift.Bool? = nil, - allow_auto_merge: Swift.Bool? = nil, - delete_branch_on_merge: Swift.Bool? = nil, - allow_update_branch: Swift.Bool? = nil, - use_squash_pr_title_as_default: Swift.Bool? = nil, - squash_merge_commit_title: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.squash_merge_commit_titlePayload? = nil, - squash_merge_commit_message: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.squash_merge_commit_messagePayload? = nil, - merge_commit_title: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.merge_commit_titlePayload? = nil, - merge_commit_message: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.merge_commit_messagePayload? = nil, - allow_merge_commit: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil - ) { - self.id = id - self.node_id = node_id - self.name = name - self.full_name = full_name - self.owner = owner - self._private = _private - self.html_url = html_url - self.description = description - self.fork = fork - self.url = url - self.archive_url = archive_url - self.assignees_url = assignees_url - self.blobs_url = blobs_url - self.branches_url = branches_url - self.collaborators_url = collaborators_url - self.comments_url = comments_url - self.commits_url = commits_url - self.compare_url = compare_url - self.contents_url = contents_url - self.contributors_url = contributors_url - self.deployments_url = deployments_url - self.downloads_url = downloads_url - self.events_url = events_url - self.forks_url = forks_url - self.git_commits_url = git_commits_url - self.git_refs_url = git_refs_url - self.git_tags_url = git_tags_url - self.git_url = git_url - self.issue_comment_url = issue_comment_url - self.issue_events_url = issue_events_url - self.issues_url = issues_url - self.keys_url = keys_url - self.labels_url = labels_url - self.languages_url = languages_url - self.merges_url = merges_url - self.milestones_url = milestones_url - self.notifications_url = notifications_url - self.pulls_url = pulls_url - self.releases_url = releases_url - self.ssh_url = ssh_url - self.stargazers_url = stargazers_url - self.statuses_url = statuses_url - self.subscribers_url = subscribers_url - self.subscription_url = subscription_url - self.tags_url = tags_url - self.teams_url = teams_url - self.trees_url = trees_url - self.clone_url = clone_url - self.mirror_url = mirror_url - self.hooks_url = hooks_url - self.svn_url = svn_url - self.homepage = homepage - self.language = language - self.forks_count = forks_count - self.stargazers_count = stargazers_count - self.watchers_count = watchers_count - self.size = size - self.default_branch = default_branch - self.open_issues_count = open_issues_count - self.is_template = is_template - self.topics = topics - self.has_issues = has_issues - self.has_projects = has_projects - self.has_wiki = has_wiki - self.has_pages = has_pages - self.has_downloads = has_downloads - self.archived = archived - self.disabled = disabled - self.visibility = visibility - self.pushed_at = pushed_at - self.created_at = created_at - self.updated_at = updated_at - self.permissions = permissions - self.allow_rebase_merge = allow_rebase_merge - self.temp_clone_token = temp_clone_token - self.allow_squash_merge = allow_squash_merge - self.allow_auto_merge = allow_auto_merge - self.delete_branch_on_merge = delete_branch_on_merge - self.allow_update_branch = allow_update_branch - self.use_squash_pr_title_as_default = use_squash_pr_title_as_default - self.squash_merge_commit_title = squash_merge_commit_title - self.squash_merge_commit_message = squash_merge_commit_message - self.merge_commit_title = merge_commit_title - self.merge_commit_message = merge_commit_message - self.allow_merge_commit = allow_merge_commit - self.subscribers_count = subscribers_count - self.network_count = network_count - } - public enum CodingKeys: String, CodingKey { - case id - case node_id - case name - case full_name - case owner - case _private = "private" - case html_url - case description - case fork - case url - case archive_url - case assignees_url - case blobs_url - case branches_url - case collaborators_url - case comments_url - case commits_url - case compare_url - case contents_url - case contributors_url - case deployments_url - case downloads_url - case events_url - case forks_url - case git_commits_url - case git_refs_url - case git_tags_url - case git_url - case issue_comment_url - case issue_events_url - case issues_url - case keys_url - case labels_url - case languages_url - case merges_url - case milestones_url - case notifications_url - case pulls_url - case releases_url - case ssh_url - case stargazers_url - case statuses_url - case subscribers_url - case subscription_url - case tags_url - case teams_url - case trees_url - case clone_url - case mirror_url - case hooks_url - case svn_url - case homepage - case language - case forks_count - case stargazers_count - case watchers_count - case size - case default_branch - case open_issues_count - case is_template - case topics - case has_issues - case has_projects - case has_wiki - case has_pages - case has_downloads - case archived - case disabled - case visibility - case pushed_at - case created_at - case updated_at - case permissions - case allow_rebase_merge - case temp_clone_token - case allow_squash_merge - case allow_auto_merge - case delete_branch_on_merge - case allow_update_branch - case use_squash_pr_title_as_default - case squash_merge_commit_title - case squash_merge_commit_message - case merge_commit_title - case merge_commit_message - case allow_merge_commit - case subscribers_count - case network_count - } - } - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository`. - public var template_repository: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload? /// - Remark: Generated from `#/components/schemas/nullable-repository/temp_clone_token`. public var temp_clone_token: Swift.String? /// Whether to allow squash merges for pull requests. @@ -5998,10 +4358,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/nullable-repository/web_commit_signoff_required`. public var web_commit_signoff_required: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/network_count`. - public var network_count: Swift.Int? /// - Remark: Generated from `#/components/schemas/nullable-repository/open_issues`. public var open_issues: Swift.Int /// - Remark: Generated from `#/components/schemas/nullable-repository/watchers`. @@ -6022,7 +4378,6 @@ public enum Components { /// - name: The name of the repository. /// - full_name: /// - license: - /// - organization: /// - forks: /// - permissions: /// - owner: @@ -6095,7 +4450,6 @@ public enum Components { /// - created_at: /// - updated_at: /// - allow_rebase_merge: Whether to allow rebase merges for pull requests. - /// - template_repository: /// - temp_clone_token: /// - allow_squash_merge: Whether to allow squash merges for pull requests. /// - allow_auto_merge: Whether to allow Auto-merge to be used on pull requests. @@ -6109,8 +4463,6 @@ public enum Components { /// - allow_merge_commit: Whether to allow merge commits for pull requests. /// - allow_forking: Whether to allow forking this repo /// - web_commit_signoff_required: Whether to require contributors to sign off on web-based commits - /// - subscribers_count: - /// - network_count: /// - open_issues: /// - watchers: /// - master_branch: @@ -6122,7 +4474,6 @@ public enum Components { name: Swift.String, full_name: Swift.String, license: Components.Schemas.nullable_hyphen_license_hyphen_simple? = nil, - organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? = nil, forks: Swift.Int, permissions: Components.Schemas.nullable_hyphen_repository.permissionsPayload? = nil, owner: Components.Schemas.simple_hyphen_user, @@ -6195,7 +4546,6 @@ public enum Components { created_at: Foundation.Date? = nil, updated_at: Foundation.Date? = nil, allow_rebase_merge: Swift.Bool? = nil, - template_repository: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload? = nil, temp_clone_token: Swift.String? = nil, allow_squash_merge: Swift.Bool? = nil, allow_auto_merge: Swift.Bool? = nil, @@ -6209,8 +4559,6 @@ public enum Components { allow_merge_commit: Swift.Bool? = nil, allow_forking: Swift.Bool? = nil, web_commit_signoff_required: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil, open_issues: Swift.Int, watchers: Swift.Int, master_branch: Swift.String? = nil, @@ -6222,7 +4570,6 @@ public enum Components { self.name = name self.full_name = full_name self.license = license - self.organization = organization self.forks = forks self.permissions = permissions self.owner = owner @@ -6295,7 +4642,6 @@ public enum Components { self.created_at = created_at self.updated_at = updated_at self.allow_rebase_merge = allow_rebase_merge - self.template_repository = template_repository self.temp_clone_token = temp_clone_token self.allow_squash_merge = allow_squash_merge self.allow_auto_merge = allow_auto_merge @@ -6309,8 +4655,6 @@ public enum Components { self.allow_merge_commit = allow_merge_commit self.allow_forking = allow_forking self.web_commit_signoff_required = web_commit_signoff_required - self.subscribers_count = subscribers_count - self.network_count = network_count self.open_issues = open_issues self.watchers = watchers self.master_branch = master_branch @@ -6323,7 +4667,6 @@ public enum Components { case name case full_name case license - case organization case forks case permissions case owner @@ -6396,7 +4739,6 @@ public enum Components { case created_at case updated_at case allow_rebase_merge - case template_repository case temp_clone_token case allow_squash_merge case allow_auto_merge @@ -6410,8 +4752,6 @@ public enum Components { case allow_merge_commit case allow_forking case web_commit_signoff_required - case subscribers_count - case network_count case open_issues case watchers case master_branch @@ -8231,7 +6571,7 @@ public enum Operations { /// /// Lists the codespaces associated to a specified organization. /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/get(codespaces/list-in-organization)`. @@ -8529,7 +6869,7 @@ public enum Operations { /// Manage access control for organization codespaces /// /// Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/access`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/access/put(codespaces/set-codespaces-access)`. @@ -8806,7 +7146,7 @@ public enum Operations { /// To use this endpoint, the access settings for the organization must be set to `selected_members`. /// For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/codespaces/access/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/access/selected_users/post(codespaces/set-codespaces-access-users)`. @@ -9064,7 +7404,7 @@ public enum Operations { /// To use this endpoint, the access settings for the organization must be set to `selected_members`. /// For information on how to change this setting, see "[Manage access control for organization codespaces](https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces)." /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces settings` write permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/codespaces/access/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/access/selected_users/delete(codespaces/delete-codespaces-access-users)`. @@ -9317,8 +7657,10 @@ public enum Operations { } /// List organization secrets /// - /// Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted + /// values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/get(codespaces/list-org-secrets)`. @@ -9519,7 +7861,8 @@ public enum Operations { } /// Get an organization public key /// - /// Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets/public-key`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/public-key/get(codespaces/get-org-public-key)`. @@ -9652,7 +7995,8 @@ public enum Operations { /// Get an organization secret /// /// Gets an organization development environment secret without revealing its encrypted value. - /// You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/get(codespaces/get-org-secret)`. @@ -9815,8 +8159,7 @@ public enum Operations { /// Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `admin:org` scope to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/put(codespaces/create-or-update-org-secret)`. @@ -10090,7 +8433,9 @@ public enum Operations { } /// Delete an organization secret /// - /// Deletes an organization development environment secret using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Deletes an organization development environment secret using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/delete(codespaces/delete-org-secret)`. @@ -10230,7 +8575,10 @@ public enum Operations { } /// List selected repositories for an organization secret /// - /// Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Lists all repositories that have been selected when the `visibility` + /// for repository access to a secret is set to `selected`. + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/get(codespaces/list-selected-repos-for-org-secret)`. @@ -10444,7 +8792,11 @@ public enum Operations { } /// Set selected repositories for an organization secret /// - /// Replaces all repositories for an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Replaces all repositories for an organization development environment secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/put(codespaces/set-selected-repos-for-org-secret)`. @@ -10637,7 +8989,8 @@ public enum Operations { } /// Add selected repository to an organization secret /// - /// Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Adds a repository to an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `PUT /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}/put(codespaces/add-selected-repo-to-org-secret)`. @@ -10832,7 +9185,11 @@ public enum Operations { } /// Remove selected repository from an organization secret /// - /// Removes a repository from an organization development environment secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. + /// Removes a repository from an organization development environment secret when the `visibility` + /// for repository access is set to `selected`. The visibility is set when you [Create + /// or update an organization secret](https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret). + /// + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}/delete(codespaces/remove-selected-repo-from-org-secret)`. @@ -11029,7 +9386,7 @@ public enum Operations { /// /// Lists the codespaces that a member of an organization has for repositories in that organization. /// - /// You must authenticate using an access token with the `admin:org` scope or the `Organization codespaces` read permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/members/{username}/codespaces`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/codespaces/get(codespaces/get-codespaces-for-user-in-org)`. @@ -11337,10 +9694,7 @@ public enum Operations { /// /// Deletes a user's codespace. /// - /// To use this endpoint you must authenticate using one of the following methods: - /// - /// - An access token with the `admin:org` scope - /// - An access token with write permissions for `Codespaces` on the specific repository and write permissions for `Organization codespaces` + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/members/{username}/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/codespaces/{codespace_name}/delete(codespaces/delete-from-organization)`. @@ -11577,10 +9931,7 @@ public enum Operations { /// /// Stops a user's codespace. /// - /// To use this endpoint you must authenticate using one of the following methods: - /// - /// - An access token with the `admin:org` scope - /// - An access token with write permissions for `Codespaces lifecycle admin` on the specific repository and write permissions for `Organization codespaces` + /// OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. /// /// - Remark: HTTP `POST /orgs/{org}/members/{username}/codespaces/{codespace_name}/stop`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/codespaces/{codespace_name}/stop/post(codespaces/stop-in-organization)`. @@ -11845,12 +10196,7 @@ public enum Operations { /// /// Lists the codespaces associated to a specified repository and the authenticated user. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have read access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/get(codespaces/list-in-repository-for-authenticated-user)`. @@ -12135,12 +10481,7 @@ public enum Operations { /// /// Creates a codespace owned by the authenticated user in the specified repository. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/codespaces`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/post(codespaces/create-with-repo-for-authenticated-user)`. @@ -12573,9 +10914,7 @@ public enum Operations { /// Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files /// specify launchpoint configurations for codespaces created within the repository. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/devcontainers`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/devcontainers/get(codespaces/list-devcontainers-in-repository-for-authenticated-user)`. @@ -12920,9 +11259,7 @@ public enum Operations { /// /// List the machine types available for a given repository based on its configuration. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_metadata` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/machines`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/machines/get(codespaces/repo-machines-for-authenticated-user)`. @@ -13237,12 +11574,7 @@ public enum Operations { /// /// Gets the default attributes for codespaces created by the user with the repository. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/new`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/new/get(codespaces/pre-flight-with-repo-for-authenticated-user)`. @@ -13527,12 +11859,7 @@ public enum Operations { /// /// Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/permissions_check`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/permissions_check/get(codespaces/check-permissions-for-devcontainer)`. @@ -13815,7 +12142,10 @@ public enum Operations { } /// List repository secrets /// - /// Lists all development environment secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + /// Lists all development environment secrets available in a repository without revealing their encrypted + /// values. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/secrets`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/get(codespaces/list-repo-secrets)`. @@ -14025,7 +12355,12 @@ public enum Operations { } /// Get a repository public key /// - /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + /// Gets your public key, which you need to encrypt secrets. You need to + /// encrypt a secret before you can create or update secrets. + /// + /// Anyone with read access to the repository can use this endpoint. + /// + /// If the repository is private, OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/secrets/public-key`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/public-key/get(codespaces/get-repo-public-key)`. @@ -14166,7 +12501,9 @@ public enum Operations { } /// Get a repository secret /// - /// Gets a single repository development environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. + /// Gets a single repository development environment secret without revealing its encrypted value. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/{secret_name}/get(codespaces/get-repo-secret)`. @@ -14317,11 +12654,7 @@ public enum Operations { /// Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access - /// token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` - /// repository permission to use this endpoint. - /// - /// This endpoint does not support fine-grained personal access tokens. For more information about personal access tokens, see "[Managing your personal access tokens](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic)." + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `PUT /repos/{owner}/{repo}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/{secret_name}/put(codespaces/create-or-update-repo-secret)`. @@ -14532,8 +12865,9 @@ public enum Operations { } /// Delete a repository secret /// - /// Deletes a development environment secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have write access to the `codespaces_secrets` repository permission to use this endpoint. - /// This endpoint does not support fine-grained personal access tokens. For more information about personal access tokens, see "[Managing your personal access tokens](https://docs.github.com/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#personal-access-tokens-classic)." + /// Deletes a development environment secret in a repository using the secret name. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /repos/{owner}/{repo}/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/codespaces/secrets/{secret_name}/delete(codespaces/delete-repo-secret)`. @@ -14617,12 +12951,7 @@ public enum Operations { /// /// Creates a codespace owned by the authenticated user for the specified pull request. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/pulls/{pull_number}/codespaces`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/pulls/{pull_number}/codespaces/post(codespaces/create-with-pr-for-authenticated-user)`. @@ -15024,12 +13353,7 @@ public enum Operations { /// /// Lists the authenticated user's codespaces. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have read access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces`. /// - Remark: Generated from `#/paths//user/codespaces/get(codespaces/list-for-authenticated-user)`. @@ -15319,12 +13643,7 @@ public enum Operations { /// /// This endpoint requires either a `repository_id` OR a `pull_request` but not both. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces`. /// - Remark: Generated from `#/paths//user/codespaces/post(codespaces/create-for-authenticated-user)`. @@ -15849,9 +14168,9 @@ public enum Operations { /// Lists all development environment secrets available for a user's codespaces without revealing their /// encrypted values. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/get(codespaces/list-secrets-for-authenticated-user)`. @@ -16036,9 +14355,9 @@ public enum Operations { /// /// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets/public-key`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/public-key/get(codespaces/get-public-key-for-authenticated-user)`. @@ -16152,9 +14471,9 @@ public enum Operations { /// /// Gets a development environment secret available to a user's codespaces without revealing its encrypted value. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/get(codespaces/get-secret-for-authenticated-user)`. @@ -16289,9 +14608,9 @@ public enum Operations { /// Creates or updates a development environment secret for a user's codespace with an encrypted value. Encrypt your secret using /// [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/rest/guides/encrypting-secrets-for-the-rest-api)." /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must also have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission and `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/put(codespaces/create-or-update-secret-for-authenticated-user)`. @@ -16593,9 +14912,9 @@ public enum Operations { /// /// Deletes a development environment secret from a user's codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/codespaces/secrets/{secret_name}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/delete(codespaces/delete-secret-for-authenticated-user)`. @@ -16663,9 +14982,9 @@ public enum Operations { /// /// List the repositories that have been granted the ability to use a user's development environment secret. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have read access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/get(codespaces/list-repositories-for-secret-for-authenticated-user)`. @@ -16914,9 +15233,9 @@ public enum Operations { /// /// Select the repositories that will use a user's development environment secret. /// - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. + /// The authenticated user must have Codespaces access to use this endpoint. /// - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on all referenced repositories to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/codespaces/secrets/{secret_name}/repositories`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/put(codespaces/set-repositories-for-secret-for-authenticated-user)`. @@ -17143,8 +15462,10 @@ public enum Operations { /// Add a selected repository to a user secret /// /// Adds a repository to the selected repositories for a user's development environment secret. - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission and write access to the `codespaces_secrets` repository permission on the referenced repository to use this endpoint. + /// + /// The authenticated user must have Codespaces access to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `PUT /user/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/{repository_id}/put(codespaces/add-repository-for-secret-for-authenticated-user)`. @@ -17352,8 +15673,10 @@ public enum Operations { /// Remove a selected repository from a user secret /// /// Removes a repository from the selected repositories for a user's development environment secret. - /// You must authenticate using an access token with the `codespace` or `codespace:secrets` scope to use this endpoint. User must have Codespaces access to use this endpoint. - /// GitHub Apps must have write access to the `codespaces_user_secrets` user permission to use this endpoint. + /// + /// The authenticated user must have Codespaces access to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `codespace` or `codespace:secrets` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/codespaces/secrets/{secret_name}/repositories/{repository_id}`. /// - Remark: Generated from `#/paths//user/codespaces/secrets/{secret_name}/repositories/{repository_id}/delete(codespaces/remove-repository-for-secret-for-authenticated-user)`. @@ -17562,12 +15885,7 @@ public enum Operations { /// /// Gets information about a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have read access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/get(codespaces/get-for-authenticated-user)`. @@ -17818,12 +16136,7 @@ public enum Operations { /// /// If you specify a new machine type it will be applied the next time your codespace is started. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `PATCH /user/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/patch(codespaces/update-for-authenticated-user)`. @@ -18070,12 +16383,7 @@ public enum Operations { /// /// Deletes a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /user/codespaces/{codespace_name}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/delete(codespaces/delete-for-authenticated-user)`. @@ -18298,9 +16606,7 @@ public enum Operations { /// /// If changes cannot be pushed to the codespace's repository, they will be pushed to a new or previously-existing fork instead. /// - /// You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/exports`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/exports/post(codespaces/export-for-authenticated-user)`. @@ -18549,9 +16855,7 @@ public enum Operations { /// /// Gets information about an export of a codespace. /// - /// You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have read access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/{codespace_name}/exports/{export_id}`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/exports/{export_id}/get(codespaces/get-export-details-for-authenticated-user)`. @@ -18717,9 +17021,7 @@ public enum Operations { /// /// List the machine types a codespace can transition to use. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have read access to the `codespaces_metadata` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `GET /user/codespaces/{codespace_name}/machines`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/machines/get(codespaces/codespace-machines-for-authenticated-user)`. @@ -18995,12 +17297,7 @@ public enum Operations { /// /// This will fail for a codespace that is already published, meaning it has an associated repository. /// - /// You must authenticate using a personal access token with the `codespace` scope to use this endpoint. - /// - /// To use this endpoint with GitHub Apps: - /// - /// - The app must be authenticated on behalf of the user. For more information, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)." - /// - The app must have write access to the `codespaces` repository permission. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/publish`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/publish/post(codespaces/publish-for-authenticated-user)`. @@ -19262,9 +17559,7 @@ public enum Operations { /// /// Starts a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/start`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/start/post(codespaces/start-for-authenticated-user)`. @@ -19616,9 +17911,7 @@ public enum Operations { /// /// Stops a user's codespace. /// - /// You must authenticate using an access token with the `codespace` scope to use this endpoint. - /// - /// GitHub Apps must have write access to the `codespaces_lifecycle_admin` repository permission to use this endpoint. + /// OAuth app tokens and personal access tokens (classic) need the `codespace` scope to use this endpoint. /// /// - Remark: HTTP `POST /user/codespaces/{codespace_name}/stop`. /// - Remark: Generated from `#/paths//user/codespaces/{codespace_name}/stop/post(codespaces/stop-for-authenticated-user)`. From 1c22e1ed8d5416e7f1aed2a6dacb1c8dcdbb8f69 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:21:00 +0000 Subject: [PATCH 19/20] Commit via running ake Sources/copilot --- Sources/copilot/Client.swift | 34 +++++++----- Sources/copilot/Types.swift | 102 +++++++++++++++++++++-------------- 2 files changed, 84 insertions(+), 52 deletions(-) diff --git a/Sources/copilot/Client.swift b/Sources/copilot/Client.swift index 0e602cde54..b8df1b617a 100644 --- a/Sources/copilot/Client.swift +++ b/Sources/copilot/Client.swift @@ -46,8 +46,9 @@ public struct Client: APIProtocol { /// and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. /// For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". /// - /// Only organization owners can configure and view details about the organization's Copilot Business subscription. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure and view details about the organization's Copilot Business subscription. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/copilot/billing`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/get(copilot/get-copilot-organization-details)`. @@ -203,8 +204,9 @@ public struct Client: APIProtocol { /// /// Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). /// - /// Only organization owners can configure and view details about the organization's Copilot Business subscription. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure and view details about the organization's Copilot Business subscription. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/copilot/billing/seats`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/seats/get(copilot/list-copilot-seats)`. @@ -383,13 +385,14 @@ public struct Client: APIProtocol { /// Purchases a GitHub Copilot Business seat for all users within each specified team. /// The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. /// /// In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. /// For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". /// For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/copilot/billing/selected_teams`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_teams/post(copilot/add-copilot-for-business-seats-for-teams)`. public func copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_teams(_ input: Operations.copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_teams.Input) async throws -> Operations.copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_teams.Output { @@ -560,8 +563,9 @@ public struct Client: APIProtocol { /// /// For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_teams`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_teams/delete(copilot/cancel-copilot-seat-assignment-for-teams)`. @@ -729,13 +733,14 @@ public struct Client: APIProtocol { /// Purchases a GitHub Copilot Business seat for each user specified. /// The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. /// /// In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. /// For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". /// For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/copilot/billing/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_users/post(copilot/add-copilot-for-business-seats-for-users)`. public func copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_users(_ input: Operations.copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_users.Input) async throws -> Operations.copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_users.Output { @@ -906,8 +911,9 @@ public struct Client: APIProtocol { /// /// For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_users/delete(copilot/cancel-copilot-seat-assignment-for-users)`. @@ -1074,7 +1080,9 @@ public struct Client: APIProtocol { /// /// Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. /// - /// Organization owners can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Organization owners can view GitHub Copilot seat assignment details for members in their organization. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/members/{username}/copilot`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/copilot/get(copilot/get-copilot-seat-details-for-user)`. diff --git a/Sources/copilot/Types.swift b/Sources/copilot/Types.swift index 9a536a1dbe..95f1722e33 100644 --- a/Sources/copilot/Types.swift +++ b/Sources/copilot/Types.swift @@ -19,8 +19,9 @@ public protocol APIProtocol: Sendable { /// and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. /// For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". /// - /// Only organization owners can configure and view details about the organization's Copilot Business subscription. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure and view details about the organization's Copilot Business subscription. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/copilot/billing`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/get(copilot/get-copilot-organization-details)`. @@ -31,8 +32,9 @@ public protocol APIProtocol: Sendable { /// /// Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). /// - /// Only organization owners can configure and view details about the organization's Copilot Business subscription. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure and view details about the organization's Copilot Business subscription. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/copilot/billing/seats`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/seats/get(copilot/list-copilot-seats)`. @@ -44,13 +46,14 @@ public protocol APIProtocol: Sendable { /// Purchases a GitHub Copilot Business seat for all users within each specified team. /// The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. /// /// In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. /// For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". /// For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/copilot/billing/selected_teams`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_teams/post(copilot/add-copilot-for-business-seats-for-teams)`. func copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_teams(_ input: Operations.copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_teams.Input) async throws -> Operations.copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_teams.Output @@ -65,8 +68,9 @@ public protocol APIProtocol: Sendable { /// /// For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_teams`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_teams/delete(copilot/cancel-copilot-seat-assignment-for-teams)`. @@ -78,13 +82,14 @@ public protocol APIProtocol: Sendable { /// Purchases a GitHub Copilot Business seat for each user specified. /// The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. /// /// In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. /// For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". /// For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/copilot/billing/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_users/post(copilot/add-copilot-for-business-seats-for-users)`. func copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_users(_ input: Operations.copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_users.Input) async throws -> Operations.copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_users.Output @@ -99,8 +104,9 @@ public protocol APIProtocol: Sendable { /// /// For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_users/delete(copilot/cancel-copilot-seat-assignment-for-users)`. @@ -111,7 +117,9 @@ public protocol APIProtocol: Sendable { /// /// Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. /// - /// Organization owners can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Organization owners can view GitHub Copilot seat assignment details for members in their organization. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/members/{username}/copilot`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/copilot/get(copilot/get-copilot-seat-details-for-user)`. @@ -128,8 +136,9 @@ extension APIProtocol { /// and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. /// For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". /// - /// Only organization owners can configure and view details about the organization's Copilot Business subscription. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure and view details about the organization's Copilot Business subscription. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/copilot/billing`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/get(copilot/get-copilot-organization-details)`. @@ -148,8 +157,9 @@ extension APIProtocol { /// /// Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). /// - /// Only organization owners can configure and view details about the organization's Copilot Business subscription. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure and view details about the organization's Copilot Business subscription. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/copilot/billing/seats`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/seats/get(copilot/list-copilot-seats)`. @@ -171,13 +181,14 @@ extension APIProtocol { /// Purchases a GitHub Copilot Business seat for all users within each specified team. /// The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. /// /// In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. /// For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". /// For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/copilot/billing/selected_teams`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_teams/post(copilot/add-copilot-for-business-seats-for-teams)`. public func copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_teams( @@ -202,8 +213,9 @@ extension APIProtocol { /// /// For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_teams`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_teams/delete(copilot/cancel-copilot-seat-assignment-for-teams)`. @@ -225,13 +237,14 @@ extension APIProtocol { /// Purchases a GitHub Copilot Business seat for each user specified. /// The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. /// /// In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. /// For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". /// For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/copilot/billing/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_users/post(copilot/add-copilot-for-business-seats-for-users)`. public func copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_users( @@ -256,8 +269,9 @@ extension APIProtocol { /// /// For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_users/delete(copilot/cancel-copilot-seat-assignment-for-users)`. @@ -278,7 +292,9 @@ extension APIProtocol { /// /// Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. /// - /// Organization owners can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Organization owners can view GitHub Copilot seat assignment details for members in their organization. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/members/{username}/copilot`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/copilot/get(copilot/get-copilot-seat-details-for-user)`. @@ -1487,8 +1503,9 @@ public enum Operations { /// and code matching policies. To configure these settings, go to your organization's settings on GitHub.com. /// For more information, see "[Managing policies for Copilot Business in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization)". /// - /// Only organization owners can configure and view details about the organization's Copilot Business subscription. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure and view details about the organization's Copilot Business subscription. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/copilot/billing`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/get(copilot/get-copilot-organization-details)`. @@ -1716,8 +1733,9 @@ public enum Operations { /// /// Lists all Copilot Business seat assignments for an organization that are currently being billed (either active or pending cancellation at the start of the next billing cycle). /// - /// Only organization owners can configure and view details about the organization's Copilot Business subscription. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure and view details about the organization's Copilot Business subscription. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/copilot/billing/seats`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/seats/get(copilot/list-copilot-seats)`. @@ -2017,13 +2035,14 @@ public enum Operations { /// Purchases a GitHub Copilot Business seat for all users within each specified team. /// The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. /// /// In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. /// For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". /// For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/copilot/billing/selected_teams`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_teams/post(copilot/add-copilot-for-business-seats-for-teams)`. public enum copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_teams { @@ -2325,8 +2344,9 @@ public enum Operations { /// /// For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_teams`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_teams/delete(copilot/cancel-copilot-seat-assignment-for-teams)`. @@ -2625,13 +2645,14 @@ public enum Operations { /// Purchases a GitHub Copilot Business seat for each user specified. /// The organization will be billed accordingly. For more information about Copilot Business pricing, see "[Pricing for GitHub Copilot Business](https://docs.github.com/billing/managing-billing-for-github-copilot/about-billing-for-github-copilot#pricing-for-github-copilot-business)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. /// /// In order for an admin to use this endpoint, the organization must have a Copilot Business subscription and a configured suggestion matching policy. /// For more information about setting up a Copilot Business subscription, see "[Setting up a Copilot Business subscription for your organization](https://docs.github.com/billing/managing-billing-for-github-copilot/managing-your-github-copilot-subscription-for-your-organization-or-enterprise#setting-up-a-copilot-business-subscription-for-your-organization)". /// For more information about setting a suggestion matching policy, see "[Configuring suggestion matching policies for GitHub Copilot in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-policies-for-copilot-business-in-your-organization#configuring-suggestion-matching-policies-for-github-copilot-in-your-organization)". /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. + /// /// - Remark: HTTP `POST /orgs/{org}/copilot/billing/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_users/post(copilot/add-copilot-for-business-seats-for-users)`. public enum copilot_sol_add_hyphen_copilot_hyphen_for_hyphen_business_hyphen_seats_hyphen_for_hyphen_users { @@ -2933,8 +2954,9 @@ public enum Operations { /// /// For more information about disabling access to Copilot Business, see "[Revoking access to GitHub Copilot for specific users in your organization](https://docs.github.com/copilot/managing-copilot-business/managing-access-for-copilot-business-in-your-organization#revoking-access-to-github-copilot-for-specific-users-in-your-organization)". /// - /// Only organization owners can configure GitHub Copilot in their organization. You must - /// authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Only organization owners can configure GitHub Copilot in their organization. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `DELETE /orgs/{org}/copilot/billing/selected_users`. /// - Remark: Generated from `#/paths//orgs/{org}/copilot/billing/selected_users/delete(copilot/cancel-copilot-seat-assignment-for-users)`. @@ -3232,7 +3254,9 @@ public enum Operations { /// /// Gets the GitHub Copilot Business seat assignment details for a member of an organization who currently has access to GitHub Copilot. /// - /// Organization owners can view GitHub Copilot seat assignment details for members in their organization. You must authenticate using an access token with the `manage_billing:copilot` scope to use this endpoint. + /// Organization owners can view GitHub Copilot seat assignment details for members in their organization. + /// + /// OAuth app tokens and personal access tokens (classic) need the `manage_billing:copilot` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/members/{username}/copilot`. /// - Remark: Generated from `#/paths//orgs/{org}/members/{username}/copilot/get(copilot/get-copilot-seat-details-for-user)`. From 80ef87e2d423949ffc06a51b3407bb6671e29382 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" Date: Thu, 15 Feb 2024 22:21:21 +0000 Subject: [PATCH 20/20] Commit via running ake Sources/security-advisories --- Sources/security-advisories/Client.swift | 33 +- Sources/security-advisories/Types.swift | 1695 ++-------------------- 2 files changed, 105 insertions(+), 1623 deletions(-) diff --git a/Sources/security-advisories/Client.swift b/Sources/security-advisories/Client.swift index 2e7a25c858..d6956a8914 100644 --- a/Sources/security-advisories/Client.swift +++ b/Sources/security-advisories/Client.swift @@ -348,7 +348,9 @@ public struct Client: APIProtocol { /// /// Lists repository security advisories for an 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 `repository_advisories:write` permission. + /// The authenticated user must be an owner or security manager for the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/security-advisories`. /// - Remark: Generated from `#/paths//orgs/{org}/security-advisories/get(security-advisories/list-org-repository-advisories)`. @@ -508,10 +510,10 @@ public struct Client: APIProtocol { /// List repository security advisories /// /// Lists security advisories in a repository. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - /// in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. /// - /// You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. + /// The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/security-advisories`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/get(security-advisories/list-repository-advisories)`. @@ -672,9 +674,10 @@ public struct Client: APIProtocol { /// Create a repository security advisory /// /// Creates a new repository security advisory. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. /// - /// In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. + /// In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/security-advisories`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/post(security-advisories/create-repository-advisory)`. @@ -956,13 +959,14 @@ public struct Client: APIProtocol { /// Get a repository security advisory /// /// Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - /// You can access any published security advisory on a public repository. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - /// in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. /// - /// You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a + /// Anyone can access any published security advisory on a public repository. + /// + /// The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a /// collaborator on the security advisory. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/security-advisories/{ghsa_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/get(security-advisories/get-repository-advisory)`. public func security_hyphen_advisories_sol_get_hyphen_repository_hyphen_advisory(_ input: Operations.security_hyphen_advisories_sol_get_hyphen_repository_hyphen_advisory.Input) async throws -> Operations.security_hyphen_advisories_sol_get_hyphen_repository_hyphen_advisory.Output { @@ -1072,11 +1076,12 @@ public struct Client: APIProtocol { /// Update a repository security advisory /// /// Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. /// - /// In order to update any security advisory, you must be a security manager or administrator of that repository, + /// In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, /// or a collaborator on the repository security advisory. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/security-advisories/{ghsa_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/patch(security-advisories/update-repository-advisory)`. public func security_hyphen_advisories_sol_update_hyphen_repository_hyphen_advisory(_ input: Operations.security_hyphen_advisories_sol_update_hyphen_repository_hyphen_advisory.Input) async throws -> Operations.security_hyphen_advisories_sol_update_hyphen_repository_hyphen_advisory.Output { @@ -1220,9 +1225,9 @@ public struct Client: APIProtocol { /// /// You may request a CVE for public repositories, but cannot do so for private repositories. /// - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + /// In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. /// - /// In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve/post(security-advisories/create-repository-advisory-cve-request)`. diff --git a/Sources/security-advisories/Types.swift b/Sources/security-advisories/Types.swift index 8f343730e8..2af69c4cd6 100644 --- a/Sources/security-advisories/Types.swift +++ b/Sources/security-advisories/Types.swift @@ -31,7 +31,9 @@ public protocol APIProtocol: Sendable { /// /// Lists repository security advisories for an 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 `repository_advisories:write` permission. + /// The authenticated user must be an owner or security manager for the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/security-advisories`. /// - Remark: Generated from `#/paths//orgs/{org}/security-advisories/get(security-advisories/list-org-repository-advisories)`. @@ -39,10 +41,10 @@ public protocol APIProtocol: Sendable { /// List repository security advisories /// /// Lists security advisories in a repository. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - /// in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. /// - /// You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. + /// The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/security-advisories`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/get(security-advisories/list-repository-advisories)`. @@ -50,9 +52,10 @@ public protocol APIProtocol: Sendable { /// Create a repository security advisory /// /// Creates a new repository security advisory. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. /// - /// In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. + /// In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/security-advisories`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/post(security-advisories/create-repository-advisory)`. @@ -68,24 +71,26 @@ public protocol APIProtocol: Sendable { /// Get a repository security advisory /// /// Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - /// You can access any published security advisory on a public repository. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - /// in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. /// - /// You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a + /// Anyone can access any published security advisory on a public repository. + /// + /// The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a /// collaborator on the security advisory. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/security-advisories/{ghsa_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/get(security-advisories/get-repository-advisory)`. func security_hyphen_advisories_sol_get_hyphen_repository_hyphen_advisory(_ input: Operations.security_hyphen_advisories_sol_get_hyphen_repository_hyphen_advisory.Input) async throws -> Operations.security_hyphen_advisories_sol_get_hyphen_repository_hyphen_advisory.Output /// Update a repository security advisory /// /// Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. /// - /// In order to update any security advisory, you must be a security manager or administrator of that repository, + /// In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, /// or a collaborator on the repository security advisory. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/security-advisories/{ghsa_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/patch(security-advisories/update-repository-advisory)`. func security_hyphen_advisories_sol_update_hyphen_repository_hyphen_advisory(_ input: Operations.security_hyphen_advisories_sol_update_hyphen_repository_hyphen_advisory.Input) async throws -> Operations.security_hyphen_advisories_sol_update_hyphen_repository_hyphen_advisory.Output @@ -95,9 +100,9 @@ public protocol APIProtocol: Sendable { /// /// You may request a CVE for public repositories, but cannot do so for private repositories. /// - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + /// In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. /// - /// In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve/post(security-advisories/create-repository-advisory-cve-request)`. @@ -151,7 +156,9 @@ extension APIProtocol { /// /// Lists repository security advisories for an 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 `repository_advisories:write` permission. + /// The authenticated user must be an owner or security manager for the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/security-advisories`. /// - Remark: Generated from `#/paths//orgs/{org}/security-advisories/get(security-advisories/list-org-repository-advisories)`. @@ -169,10 +176,10 @@ extension APIProtocol { /// List repository security advisories /// /// Lists security advisories in a repository. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - /// in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. /// - /// You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. + /// The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/security-advisories`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/get(security-advisories/list-repository-advisories)`. @@ -190,9 +197,10 @@ extension APIProtocol { /// Create a repository security advisory /// /// Creates a new repository security advisory. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. /// - /// In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. + /// In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/security-advisories`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/post(security-advisories/create-repository-advisory)`. @@ -228,13 +236,14 @@ extension APIProtocol { /// Get a repository security advisory /// /// Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - /// You can access any published security advisory on a public repository. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - /// in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. /// - /// You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a + /// Anyone can access any published security advisory on a public repository. + /// + /// The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a /// collaborator on the security advisory. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/security-advisories/{ghsa_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/get(security-advisories/get-repository-advisory)`. public func security_hyphen_advisories_sol_get_hyphen_repository_hyphen_advisory( @@ -249,11 +258,12 @@ extension APIProtocol { /// Update a repository security advisory /// /// Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. /// - /// In order to update any security advisory, you must be a security manager or administrator of that repository, + /// In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, /// or a collaborator on the repository security advisory. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/security-advisories/{ghsa_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/patch(security-advisories/update-repository-advisory)`. public func security_hyphen_advisories_sol_update_hyphen_repository_hyphen_advisory( @@ -273,9 +283,9 @@ extension APIProtocol { /// /// You may request a CVE for public repositories, but cannot do so for private repositories. /// - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + /// In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. /// - /// In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve/post(security-advisories/create-repository-advisory-cve-request)`. @@ -1436,8 +1446,6 @@ public enum Components { public var full_name: Swift.String /// - Remark: Generated from `#/components/schemas/repository/license`. public var license: Components.Schemas.nullable_hyphen_license_hyphen_simple? - /// - Remark: Generated from `#/components/schemas/repository/organization`. - public var organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? /// - Remark: Generated from `#/components/schemas/repository/forks`. public var forks: Swift.Int /// - Remark: Generated from `#/components/schemas/repository/permissions`. @@ -1650,767 +1658,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/repository/allow_rebase_merge`. public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository`. - public struct template_repositoryPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/name`. - public var name: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/full_name`. - public var full_name: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner`. - public struct ownerPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/login`. - public var login: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/avatar_url`. - public var avatar_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/gravatar_id`. - public var gravatar_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/followers_url`. - public var followers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/following_url`. - public var following_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/gists_url`. - public var gists_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/starred_url`. - public var starred_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/subscriptions_url`. - public var subscriptions_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/organizations_url`. - public var organizations_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/repos_url`. - public var repos_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/received_events_url`. - public var received_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/type`. - public var _type: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner/site_admin`. - public var site_admin: Swift.Bool? - /// Creates a new `ownerPayload`. - /// - /// - Parameters: - /// - login: - /// - id: - /// - node_id: - /// - avatar_url: - /// - gravatar_id: - /// - url: - /// - html_url: - /// - followers_url: - /// - following_url: - /// - gists_url: - /// - starred_url: - /// - subscriptions_url: - /// - organizations_url: - /// - repos_url: - /// - events_url: - /// - received_events_url: - /// - _type: - /// - site_admin: - public init( - login: Swift.String? = nil, - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - avatar_url: Swift.String? = nil, - gravatar_id: Swift.String? = nil, - url: Swift.String? = nil, - html_url: Swift.String? = nil, - followers_url: Swift.String? = nil, - following_url: Swift.String? = nil, - gists_url: Swift.String? = nil, - starred_url: Swift.String? = nil, - subscriptions_url: Swift.String? = nil, - organizations_url: Swift.String? = nil, - repos_url: Swift.String? = nil, - events_url: Swift.String? = nil, - received_events_url: Swift.String? = nil, - _type: Swift.String? = nil, - site_admin: Swift.Bool? = nil - ) { - self.login = login - self.id = id - self.node_id = node_id - self.avatar_url = avatar_url - self.gravatar_id = gravatar_id - self.url = url - self.html_url = html_url - self.followers_url = followers_url - self.following_url = following_url - self.gists_url = gists_url - self.starred_url = starred_url - self.subscriptions_url = subscriptions_url - self.organizations_url = organizations_url - self.repos_url = repos_url - self.events_url = events_url - self.received_events_url = received_events_url - self._type = _type - self.site_admin = site_admin - } - public enum CodingKeys: String, CodingKey { - case login - case id - case node_id - case avatar_url - case gravatar_id - case url - case html_url - case followers_url - case following_url - case gists_url - case starred_url - case subscriptions_url - case organizations_url - case repos_url - case events_url - case received_events_url - case _type = "type" - case site_admin - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository/owner`. - public var owner: Components.Schemas.repository.template_repositoryPayload.ownerPayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/private`. - public var _private: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/description`. - public var description: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/fork`. - public var fork: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/archive_url`. - public var archive_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/assignees_url`. - public var assignees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/blobs_url`. - public var blobs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/branches_url`. - public var branches_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/collaborators_url`. - public var collaborators_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/comments_url`. - public var comments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/commits_url`. - public var commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/compare_url`. - public var compare_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/contents_url`. - public var contents_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/contributors_url`. - public var contributors_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/deployments_url`. - public var deployments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/downloads_url`. - public var downloads_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/forks_url`. - public var forks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_commits_url`. - public var git_commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_refs_url`. - public var git_refs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_tags_url`. - public var git_tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/git_url`. - public var git_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issue_comment_url`. - public var issue_comment_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issue_events_url`. - public var issue_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/issues_url`. - public var issues_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/keys_url`. - public var keys_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/labels_url`. - public var labels_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/languages_url`. - public var languages_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merges_url`. - public var merges_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/milestones_url`. - public var milestones_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/notifications_url`. - public var notifications_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/pulls_url`. - public var pulls_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/releases_url`. - public var releases_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/ssh_url`. - public var ssh_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/stargazers_url`. - public var stargazers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/statuses_url`. - public var statuses_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscribers_url`. - public var subscribers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscription_url`. - public var subscription_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/tags_url`. - public var tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/teams_url`. - public var teams_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/trees_url`. - public var trees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/clone_url`. - public var clone_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/mirror_url`. - public var mirror_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/hooks_url`. - public var hooks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/svn_url`. - public var svn_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/homepage`. - public var homepage: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/language`. - public var language: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/forks_count`. - public var forks_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/stargazers_count`. - public var stargazers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/watchers_count`. - public var watchers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/size`. - public var size: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/default_branch`. - public var default_branch: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/open_issues_count`. - public var open_issues_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/is_template`. - public var is_template: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/topics`. - public var topics: [Swift.String]? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_issues`. - public var has_issues: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_projects`. - public var has_projects: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_wiki`. - public var has_wiki: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_pages`. - public var has_pages: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/has_downloads`. - public var has_downloads: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/archived`. - public var archived: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/disabled`. - public var disabled: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/visibility`. - public var visibility: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/pushed_at`. - public var pushed_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/created_at`. - public var created_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/updated_at`. - public var updated_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions`. - public struct permissionsPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/admin`. - public var admin: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/maintain`. - public var maintain: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/push`. - public var push: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/triage`. - public var triage: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions/pull`. - public var pull: Swift.Bool? - /// Creates a new `permissionsPayload`. - /// - /// - Parameters: - /// - admin: - /// - maintain: - /// - push: - /// - triage: - /// - pull: - public init( - admin: Swift.Bool? = nil, - maintain: Swift.Bool? = nil, - push: Swift.Bool? = nil, - triage: Swift.Bool? = nil, - pull: Swift.Bool? = nil - ) { - self.admin = admin - self.maintain = maintain - self.push = push - self.triage = triage - self.pull = pull - } - public enum CodingKeys: String, CodingKey { - case admin - case maintain - case push - case triage - case pull - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository/permissions`. - public var permissions: Components.Schemas.repository.template_repositoryPayload.permissionsPayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_rebase_merge`. - public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/temp_clone_token`. - public var temp_clone_token: Swift.String? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_squash_merge`. - public var allow_squash_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_auto_merge`. - public var allow_auto_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/delete_branch_on_merge`. - public var delete_branch_on_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_update_branch`. - public var allow_update_branch: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/use_squash_pr_title_as_default`. - public var use_squash_pr_title_as_default: Swift.Bool? - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_title`. - @frozen public enum squash_merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case COMMIT_OR_PR_TITLE = "COMMIT_OR_PR_TITLE" - } - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_title`. - public var squash_merge_commit_title: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_titlePayload? - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_message`. - @frozen public enum squash_merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case COMMIT_MESSAGES = "COMMIT_MESSAGES" - case BLANK = "BLANK" - } - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/squash_merge_commit_message`. - public var squash_merge_commit_message: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_messagePayload? - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_title`. - @frozen public enum merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case MERGE_MESSAGE = "MERGE_MESSAGE" - } - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_title`. - public var merge_commit_title: Components.Schemas.repository.template_repositoryPayload.merge_commit_titlePayload? - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_message`. - @frozen public enum merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case PR_TITLE = "PR_TITLE" - case BLANK = "BLANK" - } - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/repository/template_repository/merge_commit_message`. - public var merge_commit_message: Components.Schemas.repository.template_repositoryPayload.merge_commit_messagePayload? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/allow_merge_commit`. - public var allow_merge_commit: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/template_repository/network_count`. - public var network_count: Swift.Int? - /// Creates a new `template_repositoryPayload`. - /// - /// - Parameters: - /// - id: - /// - node_id: - /// - name: - /// - full_name: - /// - owner: - /// - _private: - /// - html_url: - /// - description: - /// - fork: - /// - url: - /// - archive_url: - /// - assignees_url: - /// - blobs_url: - /// - branches_url: - /// - collaborators_url: - /// - comments_url: - /// - commits_url: - /// - compare_url: - /// - contents_url: - /// - contributors_url: - /// - deployments_url: - /// - downloads_url: - /// - events_url: - /// - forks_url: - /// - git_commits_url: - /// - git_refs_url: - /// - git_tags_url: - /// - git_url: - /// - issue_comment_url: - /// - issue_events_url: - /// - issues_url: - /// - keys_url: - /// - labels_url: - /// - languages_url: - /// - merges_url: - /// - milestones_url: - /// - notifications_url: - /// - pulls_url: - /// - releases_url: - /// - ssh_url: - /// - stargazers_url: - /// - statuses_url: - /// - subscribers_url: - /// - subscription_url: - /// - tags_url: - /// - teams_url: - /// - trees_url: - /// - clone_url: - /// - mirror_url: - /// - hooks_url: - /// - svn_url: - /// - homepage: - /// - language: - /// - forks_count: - /// - stargazers_count: - /// - watchers_count: - /// - size: - /// - default_branch: - /// - open_issues_count: - /// - is_template: - /// - topics: - /// - has_issues: - /// - has_projects: - /// - has_wiki: - /// - has_pages: - /// - has_downloads: - /// - archived: - /// - disabled: - /// - visibility: - /// - pushed_at: - /// - created_at: - /// - updated_at: - /// - permissions: - /// - allow_rebase_merge: - /// - temp_clone_token: - /// - allow_squash_merge: - /// - allow_auto_merge: - /// - delete_branch_on_merge: - /// - allow_update_branch: - /// - use_squash_pr_title_as_default: - /// - squash_merge_commit_title: The default value for a squash merge commit title: - /// - squash_merge_commit_message: The default value for a squash merge commit message: - /// - merge_commit_title: The default value for a merge commit title. - /// - merge_commit_message: The default value for a merge commit message. - /// - allow_merge_commit: - /// - subscribers_count: - /// - network_count: - public init( - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - name: Swift.String? = nil, - full_name: Swift.String? = nil, - owner: Components.Schemas.repository.template_repositoryPayload.ownerPayload? = nil, - _private: Swift.Bool? = nil, - html_url: Swift.String? = nil, - description: Swift.String? = nil, - fork: Swift.Bool? = nil, - url: Swift.String? = nil, - archive_url: Swift.String? = nil, - assignees_url: Swift.String? = nil, - blobs_url: Swift.String? = nil, - branches_url: Swift.String? = nil, - collaborators_url: Swift.String? = nil, - comments_url: Swift.String? = nil, - commits_url: Swift.String? = nil, - compare_url: Swift.String? = nil, - contents_url: Swift.String? = nil, - contributors_url: Swift.String? = nil, - deployments_url: Swift.String? = nil, - downloads_url: Swift.String? = nil, - events_url: Swift.String? = nil, - forks_url: Swift.String? = nil, - git_commits_url: Swift.String? = nil, - git_refs_url: Swift.String? = nil, - git_tags_url: Swift.String? = nil, - git_url: Swift.String? = nil, - issue_comment_url: Swift.String? = nil, - issue_events_url: Swift.String? = nil, - issues_url: Swift.String? = nil, - keys_url: Swift.String? = nil, - labels_url: Swift.String? = nil, - languages_url: Swift.String? = nil, - merges_url: Swift.String? = nil, - milestones_url: Swift.String? = nil, - notifications_url: Swift.String? = nil, - pulls_url: Swift.String? = nil, - releases_url: Swift.String? = nil, - ssh_url: Swift.String? = nil, - stargazers_url: Swift.String? = nil, - statuses_url: Swift.String? = nil, - subscribers_url: Swift.String? = nil, - subscription_url: Swift.String? = nil, - tags_url: Swift.String? = nil, - teams_url: Swift.String? = nil, - trees_url: Swift.String? = nil, - clone_url: Swift.String? = nil, - mirror_url: Swift.String? = nil, - hooks_url: Swift.String? = nil, - svn_url: Swift.String? = nil, - homepage: Swift.String? = nil, - language: Swift.String? = nil, - forks_count: Swift.Int? = nil, - stargazers_count: Swift.Int? = nil, - watchers_count: Swift.Int? = nil, - size: Swift.Int? = nil, - default_branch: Swift.String? = nil, - open_issues_count: Swift.Int? = nil, - is_template: Swift.Bool? = nil, - topics: [Swift.String]? = nil, - has_issues: Swift.Bool? = nil, - has_projects: Swift.Bool? = nil, - has_wiki: Swift.Bool? = nil, - has_pages: Swift.Bool? = nil, - has_downloads: Swift.Bool? = nil, - archived: Swift.Bool? = nil, - disabled: Swift.Bool? = nil, - visibility: Swift.String? = nil, - pushed_at: Swift.String? = nil, - created_at: Swift.String? = nil, - updated_at: Swift.String? = nil, - permissions: Components.Schemas.repository.template_repositoryPayload.permissionsPayload? = nil, - allow_rebase_merge: Swift.Bool? = nil, - temp_clone_token: Swift.String? = nil, - allow_squash_merge: Swift.Bool? = nil, - allow_auto_merge: Swift.Bool? = nil, - delete_branch_on_merge: Swift.Bool? = nil, - allow_update_branch: Swift.Bool? = nil, - use_squash_pr_title_as_default: Swift.Bool? = nil, - squash_merge_commit_title: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_titlePayload? = nil, - squash_merge_commit_message: Components.Schemas.repository.template_repositoryPayload.squash_merge_commit_messagePayload? = nil, - merge_commit_title: Components.Schemas.repository.template_repositoryPayload.merge_commit_titlePayload? = nil, - merge_commit_message: Components.Schemas.repository.template_repositoryPayload.merge_commit_messagePayload? = nil, - allow_merge_commit: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil - ) { - self.id = id - self.node_id = node_id - self.name = name - self.full_name = full_name - self.owner = owner - self._private = _private - self.html_url = html_url - self.description = description - self.fork = fork - self.url = url - self.archive_url = archive_url - self.assignees_url = assignees_url - self.blobs_url = blobs_url - self.branches_url = branches_url - self.collaborators_url = collaborators_url - self.comments_url = comments_url - self.commits_url = commits_url - self.compare_url = compare_url - self.contents_url = contents_url - self.contributors_url = contributors_url - self.deployments_url = deployments_url - self.downloads_url = downloads_url - self.events_url = events_url - self.forks_url = forks_url - self.git_commits_url = git_commits_url - self.git_refs_url = git_refs_url - self.git_tags_url = git_tags_url - self.git_url = git_url - self.issue_comment_url = issue_comment_url - self.issue_events_url = issue_events_url - self.issues_url = issues_url - self.keys_url = keys_url - self.labels_url = labels_url - self.languages_url = languages_url - self.merges_url = merges_url - self.milestones_url = milestones_url - self.notifications_url = notifications_url - self.pulls_url = pulls_url - self.releases_url = releases_url - self.ssh_url = ssh_url - self.stargazers_url = stargazers_url - self.statuses_url = statuses_url - self.subscribers_url = subscribers_url - self.subscription_url = subscription_url - self.tags_url = tags_url - self.teams_url = teams_url - self.trees_url = trees_url - self.clone_url = clone_url - self.mirror_url = mirror_url - self.hooks_url = hooks_url - self.svn_url = svn_url - self.homepage = homepage - self.language = language - self.forks_count = forks_count - self.stargazers_count = stargazers_count - self.watchers_count = watchers_count - self.size = size - self.default_branch = default_branch - self.open_issues_count = open_issues_count - self.is_template = is_template - self.topics = topics - self.has_issues = has_issues - self.has_projects = has_projects - self.has_wiki = has_wiki - self.has_pages = has_pages - self.has_downloads = has_downloads - self.archived = archived - self.disabled = disabled - self.visibility = visibility - self.pushed_at = pushed_at - self.created_at = created_at - self.updated_at = updated_at - self.permissions = permissions - self.allow_rebase_merge = allow_rebase_merge - self.temp_clone_token = temp_clone_token - self.allow_squash_merge = allow_squash_merge - self.allow_auto_merge = allow_auto_merge - self.delete_branch_on_merge = delete_branch_on_merge - self.allow_update_branch = allow_update_branch - self.use_squash_pr_title_as_default = use_squash_pr_title_as_default - self.squash_merge_commit_title = squash_merge_commit_title - self.squash_merge_commit_message = squash_merge_commit_message - self.merge_commit_title = merge_commit_title - self.merge_commit_message = merge_commit_message - self.allow_merge_commit = allow_merge_commit - self.subscribers_count = subscribers_count - self.network_count = network_count - } - public enum CodingKeys: String, CodingKey { - case id - case node_id - case name - case full_name - case owner - case _private = "private" - case html_url - case description - case fork - case url - case archive_url - case assignees_url - case blobs_url - case branches_url - case collaborators_url - case comments_url - case commits_url - case compare_url - case contents_url - case contributors_url - case deployments_url - case downloads_url - case events_url - case forks_url - case git_commits_url - case git_refs_url - case git_tags_url - case git_url - case issue_comment_url - case issue_events_url - case issues_url - case keys_url - case labels_url - case languages_url - case merges_url - case milestones_url - case notifications_url - case pulls_url - case releases_url - case ssh_url - case stargazers_url - case statuses_url - case subscribers_url - case subscription_url - case tags_url - case teams_url - case trees_url - case clone_url - case mirror_url - case hooks_url - case svn_url - case homepage - case language - case forks_count - case stargazers_count - case watchers_count - case size - case default_branch - case open_issues_count - case is_template - case topics - case has_issues - case has_projects - case has_wiki - case has_pages - case has_downloads - case archived - case disabled - case visibility - case pushed_at - case created_at - case updated_at - case permissions - case allow_rebase_merge - case temp_clone_token - case allow_squash_merge - case allow_auto_merge - case delete_branch_on_merge - case allow_update_branch - case use_squash_pr_title_as_default - case squash_merge_commit_title - case squash_merge_commit_message - case merge_commit_title - case merge_commit_message - case allow_merge_commit - case subscribers_count - case network_count - } - } - /// - Remark: Generated from `#/components/schemas/repository/template_repository`. - public var template_repository: Components.Schemas.repository.template_repositoryPayload? /// - Remark: Generated from `#/components/schemas/repository/temp_clone_token`. public var temp_clone_token: Swift.String? /// Whether to allow squash merges for pull requests. @@ -2520,10 +1767,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/repository/web_commit_signoff_required`. public var web_commit_signoff_required: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/repository/network_count`. - public var network_count: Swift.Int? /// - Remark: Generated from `#/components/schemas/repository/open_issues`. public var open_issues: Swift.Int /// - Remark: Generated from `#/components/schemas/repository/watchers`. @@ -2544,7 +1787,6 @@ public enum Components { /// - name: The name of the repository. /// - full_name: /// - license: - /// - organization: /// - forks: /// - permissions: /// - owner: @@ -2617,7 +1859,6 @@ public enum Components { /// - created_at: /// - updated_at: /// - allow_rebase_merge: Whether to allow rebase merges for pull requests. - /// - template_repository: /// - temp_clone_token: /// - allow_squash_merge: Whether to allow squash merges for pull requests. /// - allow_auto_merge: Whether to allow Auto-merge to be used on pull requests. @@ -2631,8 +1872,6 @@ public enum Components { /// - allow_merge_commit: Whether to allow merge commits for pull requests. /// - allow_forking: Whether to allow forking this repo /// - web_commit_signoff_required: Whether to require contributors to sign off on web-based commits - /// - subscribers_count: - /// - network_count: /// - open_issues: /// - watchers: /// - master_branch: @@ -2644,7 +1883,6 @@ public enum Components { name: Swift.String, full_name: Swift.String, license: Components.Schemas.nullable_hyphen_license_hyphen_simple? = nil, - organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? = nil, forks: Swift.Int, permissions: Components.Schemas.repository.permissionsPayload? = nil, owner: Components.Schemas.simple_hyphen_user, @@ -2717,7 +1955,6 @@ public enum Components { created_at: Foundation.Date? = nil, updated_at: Foundation.Date? = nil, allow_rebase_merge: Swift.Bool? = nil, - template_repository: Components.Schemas.repository.template_repositoryPayload? = nil, temp_clone_token: Swift.String? = nil, allow_squash_merge: Swift.Bool? = nil, allow_auto_merge: Swift.Bool? = nil, @@ -2731,8 +1968,6 @@ public enum Components { allow_merge_commit: Swift.Bool? = nil, allow_forking: Swift.Bool? = nil, web_commit_signoff_required: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil, open_issues: Swift.Int, watchers: Swift.Int, master_branch: Swift.String? = nil, @@ -2744,7 +1979,6 @@ public enum Components { self.name = name self.full_name = full_name self.license = license - self.organization = organization self.forks = forks self.permissions = permissions self.owner = owner @@ -2817,7 +2051,6 @@ public enum Components { self.created_at = created_at self.updated_at = updated_at self.allow_rebase_merge = allow_rebase_merge - self.template_repository = template_repository self.temp_clone_token = temp_clone_token self.allow_squash_merge = allow_squash_merge self.allow_auto_merge = allow_auto_merge @@ -2831,8 +2064,6 @@ public enum Components { self.allow_merge_commit = allow_merge_commit self.allow_forking = allow_forking self.web_commit_signoff_required = web_commit_signoff_required - self.subscribers_count = subscribers_count - self.network_count = network_count self.open_issues = open_issues self.watchers = watchers self.master_branch = master_branch @@ -2845,7 +2076,6 @@ public enum Components { case name case full_name case license - case organization case forks case permissions case owner @@ -2918,7 +2148,6 @@ public enum Components { case created_at case updated_at case allow_rebase_merge - case template_repository case temp_clone_token case allow_squash_merge case allow_auto_merge @@ -2932,8 +2161,6 @@ public enum Components { case allow_merge_commit case allow_forking case web_commit_signoff_required - case subscribers_count - case network_count case open_issues case watchers case master_branch @@ -3706,8 +2933,6 @@ public enum Components { public var full_name: Swift.String /// - Remark: Generated from `#/components/schemas/nullable-repository/license`. public var license: Components.Schemas.nullable_hyphen_license_hyphen_simple? - /// - Remark: Generated from `#/components/schemas/nullable-repository/organization`. - public var organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? /// - Remark: Generated from `#/components/schemas/nullable-repository/forks`. public var forks: Swift.Int /// - Remark: Generated from `#/components/schemas/nullable-repository/permissions`. @@ -3920,767 +3145,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/nullable-repository/allow_rebase_merge`. public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository`. - public struct template_repositoryPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/name`. - public var name: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/full_name`. - public var full_name: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner`. - public struct ownerPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/login`. - public var login: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/id`. - public var id: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/node_id`. - public var node_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/avatar_url`. - public var avatar_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/gravatar_id`. - public var gravatar_id: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/followers_url`. - public var followers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/following_url`. - public var following_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/gists_url`. - public var gists_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/starred_url`. - public var starred_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/subscriptions_url`. - public var subscriptions_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/organizations_url`. - public var organizations_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/repos_url`. - public var repos_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/received_events_url`. - public var received_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/type`. - public var _type: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner/site_admin`. - public var site_admin: Swift.Bool? - /// Creates a new `ownerPayload`. - /// - /// - Parameters: - /// - login: - /// - id: - /// - node_id: - /// - avatar_url: - /// - gravatar_id: - /// - url: - /// - html_url: - /// - followers_url: - /// - following_url: - /// - gists_url: - /// - starred_url: - /// - subscriptions_url: - /// - organizations_url: - /// - repos_url: - /// - events_url: - /// - received_events_url: - /// - _type: - /// - site_admin: - public init( - login: Swift.String? = nil, - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - avatar_url: Swift.String? = nil, - gravatar_id: Swift.String? = nil, - url: Swift.String? = nil, - html_url: Swift.String? = nil, - followers_url: Swift.String? = nil, - following_url: Swift.String? = nil, - gists_url: Swift.String? = nil, - starred_url: Swift.String? = nil, - subscriptions_url: Swift.String? = nil, - organizations_url: Swift.String? = nil, - repos_url: Swift.String? = nil, - events_url: Swift.String? = nil, - received_events_url: Swift.String? = nil, - _type: Swift.String? = nil, - site_admin: Swift.Bool? = nil - ) { - self.login = login - self.id = id - self.node_id = node_id - self.avatar_url = avatar_url - self.gravatar_id = gravatar_id - self.url = url - self.html_url = html_url - self.followers_url = followers_url - self.following_url = following_url - self.gists_url = gists_url - self.starred_url = starred_url - self.subscriptions_url = subscriptions_url - self.organizations_url = organizations_url - self.repos_url = repos_url - self.events_url = events_url - self.received_events_url = received_events_url - self._type = _type - self.site_admin = site_admin - } - public enum CodingKeys: String, CodingKey { - case login - case id - case node_id - case avatar_url - case gravatar_id - case url - case html_url - case followers_url - case following_url - case gists_url - case starred_url - case subscriptions_url - case organizations_url - case repos_url - case events_url - case received_events_url - case _type = "type" - case site_admin - } - } - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/owner`. - public var owner: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.ownerPayload? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/private`. - public var _private: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/html_url`. - public var html_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/description`. - public var description: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/fork`. - public var fork: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/url`. - public var url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/archive_url`. - public var archive_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/assignees_url`. - public var assignees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/blobs_url`. - public var blobs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/branches_url`. - public var branches_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/collaborators_url`. - public var collaborators_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/comments_url`. - public var comments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/commits_url`. - public var commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/compare_url`. - public var compare_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/contents_url`. - public var contents_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/contributors_url`. - public var contributors_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/deployments_url`. - public var deployments_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/downloads_url`. - public var downloads_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/events_url`. - public var events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/forks_url`. - public var forks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/git_commits_url`. - public var git_commits_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/git_refs_url`. - public var git_refs_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/git_tags_url`. - public var git_tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/git_url`. - public var git_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/issue_comment_url`. - public var issue_comment_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/issue_events_url`. - public var issue_events_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/issues_url`. - public var issues_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/keys_url`. - public var keys_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/labels_url`. - public var labels_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/languages_url`. - public var languages_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merges_url`. - public var merges_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/milestones_url`. - public var milestones_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/notifications_url`. - public var notifications_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/pulls_url`. - public var pulls_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/releases_url`. - public var releases_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/ssh_url`. - public var ssh_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/stargazers_url`. - public var stargazers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/statuses_url`. - public var statuses_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/subscribers_url`. - public var subscribers_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/subscription_url`. - public var subscription_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/tags_url`. - public var tags_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/teams_url`. - public var teams_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/trees_url`. - public var trees_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/clone_url`. - public var clone_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/mirror_url`. - public var mirror_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/hooks_url`. - public var hooks_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/svn_url`. - public var svn_url: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/homepage`. - public var homepage: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/language`. - public var language: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/forks_count`. - public var forks_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/stargazers_count`. - public var stargazers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/watchers_count`. - public var watchers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/size`. - public var size: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/default_branch`. - public var default_branch: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/open_issues_count`. - public var open_issues_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/is_template`. - public var is_template: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/topics`. - public var topics: [Swift.String]? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_issues`. - public var has_issues: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_projects`. - public var has_projects: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_wiki`. - public var has_wiki: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_pages`. - public var has_pages: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/has_downloads`. - public var has_downloads: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/archived`. - public var archived: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/disabled`. - public var disabled: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/visibility`. - public var visibility: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/pushed_at`. - public var pushed_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/created_at`. - public var created_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/updated_at`. - public var updated_at: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions`. - public struct permissionsPayload: Codable, Hashable, Sendable { - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/admin`. - public var admin: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/maintain`. - public var maintain: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/push`. - public var push: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/triage`. - public var triage: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions/pull`. - public var pull: Swift.Bool? - /// Creates a new `permissionsPayload`. - /// - /// - Parameters: - /// - admin: - /// - maintain: - /// - push: - /// - triage: - /// - pull: - public init( - admin: Swift.Bool? = nil, - maintain: Swift.Bool? = nil, - push: Swift.Bool? = nil, - triage: Swift.Bool? = nil, - pull: Swift.Bool? = nil - ) { - self.admin = admin - self.maintain = maintain - self.push = push - self.triage = triage - self.pull = pull - } - public enum CodingKeys: String, CodingKey { - case admin - case maintain - case push - case triage - case pull - } - } - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/permissions`. - public var permissions: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.permissionsPayload? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_rebase_merge`. - public var allow_rebase_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/temp_clone_token`. - public var temp_clone_token: Swift.String? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_squash_merge`. - public var allow_squash_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_auto_merge`. - public var allow_auto_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/delete_branch_on_merge`. - public var delete_branch_on_merge: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_update_branch`. - public var allow_update_branch: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/use_squash_pr_title_as_default`. - public var use_squash_pr_title_as_default: Swift.Bool? - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/squash_merge_commit_title`. - @frozen public enum squash_merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case COMMIT_OR_PR_TITLE = "COMMIT_OR_PR_TITLE" - } - /// The default value for a squash merge commit title: - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/squash_merge_commit_title`. - public var squash_merge_commit_title: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.squash_merge_commit_titlePayload? - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/squash_merge_commit_message`. - @frozen public enum squash_merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case COMMIT_MESSAGES = "COMMIT_MESSAGES" - case BLANK = "BLANK" - } - /// The default value for a squash merge commit message: - /// - /// - `PR_BODY` - default to the pull request's body. - /// - `COMMIT_MESSAGES` - default to the branch's commit messages. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/squash_merge_commit_message`. - public var squash_merge_commit_message: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.squash_merge_commit_messagePayload? - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merge_commit_title`. - @frozen public enum merge_commit_titlePayload: String, Codable, Hashable, Sendable { - case PR_TITLE = "PR_TITLE" - case MERGE_MESSAGE = "MERGE_MESSAGE" - } - /// The default value for a merge commit title. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merge_commit_title`. - public var merge_commit_title: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.merge_commit_titlePayload? - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merge_commit_message`. - @frozen public enum merge_commit_messagePayload: String, Codable, Hashable, Sendable { - case PR_BODY = "PR_BODY" - case PR_TITLE = "PR_TITLE" - case BLANK = "BLANK" - } - /// The default value for a merge commit message. - /// - /// - `PR_TITLE` - default to the pull request's title. - /// - `PR_BODY` - default to the pull request's body. - /// - `BLANK` - default to a blank commit message. - /// - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/merge_commit_message`. - public var merge_commit_message: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.merge_commit_messagePayload? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/allow_merge_commit`. - public var allow_merge_commit: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository/network_count`. - public var network_count: Swift.Int? - /// Creates a new `template_repositoryPayload`. - /// - /// - Parameters: - /// - id: - /// - node_id: - /// - name: - /// - full_name: - /// - owner: - /// - _private: - /// - html_url: - /// - description: - /// - fork: - /// - url: - /// - archive_url: - /// - assignees_url: - /// - blobs_url: - /// - branches_url: - /// - collaborators_url: - /// - comments_url: - /// - commits_url: - /// - compare_url: - /// - contents_url: - /// - contributors_url: - /// - deployments_url: - /// - downloads_url: - /// - events_url: - /// - forks_url: - /// - git_commits_url: - /// - git_refs_url: - /// - git_tags_url: - /// - git_url: - /// - issue_comment_url: - /// - issue_events_url: - /// - issues_url: - /// - keys_url: - /// - labels_url: - /// - languages_url: - /// - merges_url: - /// - milestones_url: - /// - notifications_url: - /// - pulls_url: - /// - releases_url: - /// - ssh_url: - /// - stargazers_url: - /// - statuses_url: - /// - subscribers_url: - /// - subscription_url: - /// - tags_url: - /// - teams_url: - /// - trees_url: - /// - clone_url: - /// - mirror_url: - /// - hooks_url: - /// - svn_url: - /// - homepage: - /// - language: - /// - forks_count: - /// - stargazers_count: - /// - watchers_count: - /// - size: - /// - default_branch: - /// - open_issues_count: - /// - is_template: - /// - topics: - /// - has_issues: - /// - has_projects: - /// - has_wiki: - /// - has_pages: - /// - has_downloads: - /// - archived: - /// - disabled: - /// - visibility: - /// - pushed_at: - /// - created_at: - /// - updated_at: - /// - permissions: - /// - allow_rebase_merge: - /// - temp_clone_token: - /// - allow_squash_merge: - /// - allow_auto_merge: - /// - delete_branch_on_merge: - /// - allow_update_branch: - /// - use_squash_pr_title_as_default: - /// - squash_merge_commit_title: The default value for a squash merge commit title: - /// - squash_merge_commit_message: The default value for a squash merge commit message: - /// - merge_commit_title: The default value for a merge commit title. - /// - merge_commit_message: The default value for a merge commit message. - /// - allow_merge_commit: - /// - subscribers_count: - /// - network_count: - public init( - id: Swift.Int? = nil, - node_id: Swift.String? = nil, - name: Swift.String? = nil, - full_name: Swift.String? = nil, - owner: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.ownerPayload? = nil, - _private: Swift.Bool? = nil, - html_url: Swift.String? = nil, - description: Swift.String? = nil, - fork: Swift.Bool? = nil, - url: Swift.String? = nil, - archive_url: Swift.String? = nil, - assignees_url: Swift.String? = nil, - blobs_url: Swift.String? = nil, - branches_url: Swift.String? = nil, - collaborators_url: Swift.String? = nil, - comments_url: Swift.String? = nil, - commits_url: Swift.String? = nil, - compare_url: Swift.String? = nil, - contents_url: Swift.String? = nil, - contributors_url: Swift.String? = nil, - deployments_url: Swift.String? = nil, - downloads_url: Swift.String? = nil, - events_url: Swift.String? = nil, - forks_url: Swift.String? = nil, - git_commits_url: Swift.String? = nil, - git_refs_url: Swift.String? = nil, - git_tags_url: Swift.String? = nil, - git_url: Swift.String? = nil, - issue_comment_url: Swift.String? = nil, - issue_events_url: Swift.String? = nil, - issues_url: Swift.String? = nil, - keys_url: Swift.String? = nil, - labels_url: Swift.String? = nil, - languages_url: Swift.String? = nil, - merges_url: Swift.String? = nil, - milestones_url: Swift.String? = nil, - notifications_url: Swift.String? = nil, - pulls_url: Swift.String? = nil, - releases_url: Swift.String? = nil, - ssh_url: Swift.String? = nil, - stargazers_url: Swift.String? = nil, - statuses_url: Swift.String? = nil, - subscribers_url: Swift.String? = nil, - subscription_url: Swift.String? = nil, - tags_url: Swift.String? = nil, - teams_url: Swift.String? = nil, - trees_url: Swift.String? = nil, - clone_url: Swift.String? = nil, - mirror_url: Swift.String? = nil, - hooks_url: Swift.String? = nil, - svn_url: Swift.String? = nil, - homepage: Swift.String? = nil, - language: Swift.String? = nil, - forks_count: Swift.Int? = nil, - stargazers_count: Swift.Int? = nil, - watchers_count: Swift.Int? = nil, - size: Swift.Int? = nil, - default_branch: Swift.String? = nil, - open_issues_count: Swift.Int? = nil, - is_template: Swift.Bool? = nil, - topics: [Swift.String]? = nil, - has_issues: Swift.Bool? = nil, - has_projects: Swift.Bool? = nil, - has_wiki: Swift.Bool? = nil, - has_pages: Swift.Bool? = nil, - has_downloads: Swift.Bool? = nil, - archived: Swift.Bool? = nil, - disabled: Swift.Bool? = nil, - visibility: Swift.String? = nil, - pushed_at: Swift.String? = nil, - created_at: Swift.String? = nil, - updated_at: Swift.String? = nil, - permissions: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.permissionsPayload? = nil, - allow_rebase_merge: Swift.Bool? = nil, - temp_clone_token: Swift.String? = nil, - allow_squash_merge: Swift.Bool? = nil, - allow_auto_merge: Swift.Bool? = nil, - delete_branch_on_merge: Swift.Bool? = nil, - allow_update_branch: Swift.Bool? = nil, - use_squash_pr_title_as_default: Swift.Bool? = nil, - squash_merge_commit_title: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.squash_merge_commit_titlePayload? = nil, - squash_merge_commit_message: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.squash_merge_commit_messagePayload? = nil, - merge_commit_title: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.merge_commit_titlePayload? = nil, - merge_commit_message: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload.merge_commit_messagePayload? = nil, - allow_merge_commit: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil - ) { - self.id = id - self.node_id = node_id - self.name = name - self.full_name = full_name - self.owner = owner - self._private = _private - self.html_url = html_url - self.description = description - self.fork = fork - self.url = url - self.archive_url = archive_url - self.assignees_url = assignees_url - self.blobs_url = blobs_url - self.branches_url = branches_url - self.collaborators_url = collaborators_url - self.comments_url = comments_url - self.commits_url = commits_url - self.compare_url = compare_url - self.contents_url = contents_url - self.contributors_url = contributors_url - self.deployments_url = deployments_url - self.downloads_url = downloads_url - self.events_url = events_url - self.forks_url = forks_url - self.git_commits_url = git_commits_url - self.git_refs_url = git_refs_url - self.git_tags_url = git_tags_url - self.git_url = git_url - self.issue_comment_url = issue_comment_url - self.issue_events_url = issue_events_url - self.issues_url = issues_url - self.keys_url = keys_url - self.labels_url = labels_url - self.languages_url = languages_url - self.merges_url = merges_url - self.milestones_url = milestones_url - self.notifications_url = notifications_url - self.pulls_url = pulls_url - self.releases_url = releases_url - self.ssh_url = ssh_url - self.stargazers_url = stargazers_url - self.statuses_url = statuses_url - self.subscribers_url = subscribers_url - self.subscription_url = subscription_url - self.tags_url = tags_url - self.teams_url = teams_url - self.trees_url = trees_url - self.clone_url = clone_url - self.mirror_url = mirror_url - self.hooks_url = hooks_url - self.svn_url = svn_url - self.homepage = homepage - self.language = language - self.forks_count = forks_count - self.stargazers_count = stargazers_count - self.watchers_count = watchers_count - self.size = size - self.default_branch = default_branch - self.open_issues_count = open_issues_count - self.is_template = is_template - self.topics = topics - self.has_issues = has_issues - self.has_projects = has_projects - self.has_wiki = has_wiki - self.has_pages = has_pages - self.has_downloads = has_downloads - self.archived = archived - self.disabled = disabled - self.visibility = visibility - self.pushed_at = pushed_at - self.created_at = created_at - self.updated_at = updated_at - self.permissions = permissions - self.allow_rebase_merge = allow_rebase_merge - self.temp_clone_token = temp_clone_token - self.allow_squash_merge = allow_squash_merge - self.allow_auto_merge = allow_auto_merge - self.delete_branch_on_merge = delete_branch_on_merge - self.allow_update_branch = allow_update_branch - self.use_squash_pr_title_as_default = use_squash_pr_title_as_default - self.squash_merge_commit_title = squash_merge_commit_title - self.squash_merge_commit_message = squash_merge_commit_message - self.merge_commit_title = merge_commit_title - self.merge_commit_message = merge_commit_message - self.allow_merge_commit = allow_merge_commit - self.subscribers_count = subscribers_count - self.network_count = network_count - } - public enum CodingKeys: String, CodingKey { - case id - case node_id - case name - case full_name - case owner - case _private = "private" - case html_url - case description - case fork - case url - case archive_url - case assignees_url - case blobs_url - case branches_url - case collaborators_url - case comments_url - case commits_url - case compare_url - case contents_url - case contributors_url - case deployments_url - case downloads_url - case events_url - case forks_url - case git_commits_url - case git_refs_url - case git_tags_url - case git_url - case issue_comment_url - case issue_events_url - case issues_url - case keys_url - case labels_url - case languages_url - case merges_url - case milestones_url - case notifications_url - case pulls_url - case releases_url - case ssh_url - case stargazers_url - case statuses_url - case subscribers_url - case subscription_url - case tags_url - case teams_url - case trees_url - case clone_url - case mirror_url - case hooks_url - case svn_url - case homepage - case language - case forks_count - case stargazers_count - case watchers_count - case size - case default_branch - case open_issues_count - case is_template - case topics - case has_issues - case has_projects - case has_wiki - case has_pages - case has_downloads - case archived - case disabled - case visibility - case pushed_at - case created_at - case updated_at - case permissions - case allow_rebase_merge - case temp_clone_token - case allow_squash_merge - case allow_auto_merge - case delete_branch_on_merge - case allow_update_branch - case use_squash_pr_title_as_default - case squash_merge_commit_title - case squash_merge_commit_message - case merge_commit_title - case merge_commit_message - case allow_merge_commit - case subscribers_count - case network_count - } - } - /// - Remark: Generated from `#/components/schemas/nullable-repository/template_repository`. - public var template_repository: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload? /// - Remark: Generated from `#/components/schemas/nullable-repository/temp_clone_token`. public var temp_clone_token: Swift.String? /// Whether to allow squash merges for pull requests. @@ -4790,10 +3254,6 @@ public enum Components { /// /// - Remark: Generated from `#/components/schemas/nullable-repository/web_commit_signoff_required`. public var web_commit_signoff_required: Swift.Bool? - /// - Remark: Generated from `#/components/schemas/nullable-repository/subscribers_count`. - public var subscribers_count: Swift.Int? - /// - Remark: Generated from `#/components/schemas/nullable-repository/network_count`. - public var network_count: Swift.Int? /// - Remark: Generated from `#/components/schemas/nullable-repository/open_issues`. public var open_issues: Swift.Int /// - Remark: Generated from `#/components/schemas/nullable-repository/watchers`. @@ -4814,7 +3274,6 @@ public enum Components { /// - name: The name of the repository. /// - full_name: /// - license: - /// - organization: /// - forks: /// - permissions: /// - owner: @@ -4887,7 +3346,6 @@ public enum Components { /// - created_at: /// - updated_at: /// - allow_rebase_merge: Whether to allow rebase merges for pull requests. - /// - template_repository: /// - temp_clone_token: /// - allow_squash_merge: Whether to allow squash merges for pull requests. /// - allow_auto_merge: Whether to allow Auto-merge to be used on pull requests. @@ -4901,8 +3359,6 @@ public enum Components { /// - allow_merge_commit: Whether to allow merge commits for pull requests. /// - allow_forking: Whether to allow forking this repo /// - web_commit_signoff_required: Whether to require contributors to sign off on web-based commits - /// - subscribers_count: - /// - network_count: /// - open_issues: /// - watchers: /// - master_branch: @@ -4914,7 +3370,6 @@ public enum Components { name: Swift.String, full_name: Swift.String, license: Components.Schemas.nullable_hyphen_license_hyphen_simple? = nil, - organization: Components.Schemas.nullable_hyphen_simple_hyphen_user? = nil, forks: Swift.Int, permissions: Components.Schemas.nullable_hyphen_repository.permissionsPayload? = nil, owner: Components.Schemas.simple_hyphen_user, @@ -4987,7 +3442,6 @@ public enum Components { created_at: Foundation.Date? = nil, updated_at: Foundation.Date? = nil, allow_rebase_merge: Swift.Bool? = nil, - template_repository: Components.Schemas.nullable_hyphen_repository.template_repositoryPayload? = nil, temp_clone_token: Swift.String? = nil, allow_squash_merge: Swift.Bool? = nil, allow_auto_merge: Swift.Bool? = nil, @@ -5001,8 +3455,6 @@ public enum Components { allow_merge_commit: Swift.Bool? = nil, allow_forking: Swift.Bool? = nil, web_commit_signoff_required: Swift.Bool? = nil, - subscribers_count: Swift.Int? = nil, - network_count: Swift.Int? = nil, open_issues: Swift.Int, watchers: Swift.Int, master_branch: Swift.String? = nil, @@ -5014,7 +3466,6 @@ public enum Components { self.name = name self.full_name = full_name self.license = license - self.organization = organization self.forks = forks self.permissions = permissions self.owner = owner @@ -5087,7 +3538,6 @@ public enum Components { self.created_at = created_at self.updated_at = updated_at self.allow_rebase_merge = allow_rebase_merge - self.template_repository = template_repository self.temp_clone_token = temp_clone_token self.allow_squash_merge = allow_squash_merge self.allow_auto_merge = allow_auto_merge @@ -5101,8 +3551,6 @@ public enum Components { self.allow_merge_commit = allow_merge_commit self.allow_forking = allow_forking self.web_commit_signoff_required = web_commit_signoff_required - self.subscribers_count = subscribers_count - self.network_count = network_count self.open_issues = open_issues self.watchers = watchers self.master_branch = master_branch @@ -5115,7 +3563,6 @@ public enum Components { case name case full_name case license - case organization case forks case permissions case owner @@ -5188,7 +3635,6 @@ public enum Components { case created_at case updated_at case allow_rebase_merge - case template_repository case temp_clone_token case allow_squash_merge case allow_auto_merge @@ -5202,8 +3648,6 @@ public enum Components { case allow_merge_commit case allow_forking case web_commit_signoff_required - case subscribers_count - case network_count case open_issues case watchers case master_branch @@ -5571,6 +4015,30 @@ public enum Components { public var code_of_conduct: Components.Schemas.code_hyphen_of_hyphen_conduct_hyphen_simple? /// - Remark: Generated from `#/components/schemas/full-repository/security_and_analysis`. public var security_and_analysis: Components.Schemas.security_hyphen_and_hyphen_analysis? + /// The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + /// + /// - Remark: Generated from `#/components/schemas/full-repository/custom_properties`. + public struct custom_propertiesPayload: Codable, Hashable, Sendable { + /// A container of undocumented properties. + public var additionalProperties: OpenAPIRuntime.OpenAPIObjectContainer + /// Creates a new `custom_propertiesPayload`. + /// + /// - Parameters: + /// - additionalProperties: A container of undocumented properties. + public init(additionalProperties: OpenAPIRuntime.OpenAPIObjectContainer = .init()) { + self.additionalProperties = additionalProperties + } + public init(from decoder: any Decoder) throws { + additionalProperties = try decoder.decodeAdditionalProperties(knownKeys: []) + } + public func encode(to encoder: any Encoder) throws { + try encoder.encodeAdditionalProperties(additionalProperties) + } + } + /// The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. + /// + /// - Remark: Generated from `#/components/schemas/full-repository/custom_properties`. + public var custom_properties: Components.Schemas.full_hyphen_repository.custom_propertiesPayload? /// Creates a new `full_hyphen_repository`. /// /// - Parameters: @@ -5676,6 +4144,7 @@ public enum Components { /// - anonymous_access_enabled: Whether anonymous git access is allowed. /// - code_of_conduct: /// - security_and_analysis: + /// - custom_properties: The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. public init( id: Swift.Int, node_id: Swift.String, @@ -5778,7 +4247,8 @@ public enum Components { watchers: Swift.Int, anonymous_access_enabled: Swift.Bool? = nil, code_of_conduct: Components.Schemas.code_hyphen_of_hyphen_conduct_hyphen_simple? = nil, - security_and_analysis: Components.Schemas.security_hyphen_and_hyphen_analysis? = nil + security_and_analysis: Components.Schemas.security_hyphen_and_hyphen_analysis? = nil, + custom_properties: Components.Schemas.full_hyphen_repository.custom_propertiesPayload? = nil ) { self.id = id self.node_id = node_id @@ -5882,6 +4352,7 @@ public enum Components { self.anonymous_access_enabled = anonymous_access_enabled self.code_of_conduct = code_of_conduct self.security_and_analysis = security_and_analysis + self.custom_properties = custom_properties } public enum CodingKeys: String, CodingKey { case id @@ -5986,6 +4457,7 @@ public enum Components { case anonymous_access_enabled case code_of_conduct case security_and_analysis + case custom_properties } } /// A product affected by the vulnerability detailed in a repository security advisory. @@ -8354,7 +6826,9 @@ public enum Operations { /// /// Lists repository security advisories for an 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 `repository_advisories:write` permission. + /// The authenticated user must be an owner or security manager for the organization to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. /// /// - Remark: HTTP `GET /orgs/{org}/security-advisories`. /// - Remark: Generated from `#/paths//orgs/{org}/security-advisories/get(security-advisories/list-org-repository-advisories)`. @@ -8612,10 +7086,10 @@ public enum Operations { /// List repository security advisories /// /// Lists security advisories in a repository. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - /// in order to get published security advisories in a private repository, or any unpublished security advisories that you have access to. /// - /// You can access unpublished security advisories from a repository if you are a security manager or administrator of that repository, or if you are a collaborator on any security advisory. + /// The authenticated user can access unpublished security advisories from a repository if they are a security manager or administrator of that repository, or if they are a collaborator on any security advisory. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/security-advisories`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/get(security-advisories/list-repository-advisories)`. @@ -8882,9 +7356,10 @@ public enum Operations { /// Create a repository security advisory /// /// Creates a new repository security advisory. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. /// - /// In order to create a draft repository security advisory, you must be a security manager or administrator of that repository. + /// In order to create a draft repository security advisory, the authenticated user must be a security manager or administrator of that repository. + /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/security-advisories`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/post(security-advisories/create-repository-advisory)`. @@ -9324,13 +7799,14 @@ public enum Operations { /// Get a repository security advisory /// /// Get a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - /// You can access any published security advisory on a public repository. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:read` permission - /// in order to get a published security advisory in a private repository, or any unpublished security advisory that you have access to. /// - /// You can access an unpublished security advisory from a repository if you are a security manager or administrator of that repository, or if you are a + /// Anyone can access any published security advisory on a public repository. + /// + /// The authenticated user can access an unpublished security advisory from a repository if they are a security manager or administrator of that repository, or if they are a /// collaborator on the security advisory. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:read` scope to to get a published security advisory in a private repository, or any unpublished security advisory that the authenticated user has access to. + /// /// - Remark: HTTP `GET /repos/{owner}/{repo}/security-advisories/{ghsa_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/get(security-advisories/get-repository-advisory)`. public enum security_hyphen_advisories_sol_get_hyphen_repository_hyphen_advisory { @@ -9524,11 +8000,12 @@ public enum Operations { /// Update a repository security advisory /// /// Update a repository security advisory using its GitHub Security Advisory (GHSA) identifier. - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. /// - /// In order to update any security advisory, you must be a security manager or administrator of that repository, + /// In order to update any security advisory, the authenticated user must be a security manager or administrator of that repository, /// or a collaborator on the repository security advisory. /// + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. + /// /// - Remark: HTTP `PATCH /repos/{owner}/{repo}/security-advisories/{ghsa_id}`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/patch(security-advisories/update-repository-advisory)`. public enum security_hyphen_advisories_sol_update_hyphen_repository_hyphen_advisory { @@ -9785,9 +8262,9 @@ public enum Operations { /// /// You may request a CVE for public repositories, but cannot do so for private repositories. /// - /// You must authenticate using an access token with the `repo` scope or `repository_advisories:write` permission to use this endpoint. + /// In order to request a CVE for a repository security advisory, the authenticated user must be a security manager or administrator of that repository. /// - /// In order to request a CVE for a repository security advisory, you must be a security manager or administrator of that repository. + /// OAuth app tokens and personal access tokens (classic) need the `repo` or `repository_advisories:write` scope to use this endpoint. /// /// - Remark: HTTP `POST /repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve`. /// - Remark: Generated from `#/paths//repos/{owner}/{repo}/security-advisories/{ghsa_id}/cve/post(security-advisories/create-repository-advisory-cve-request)`.