Skip to content

Commit b551db5

Browse files
authored
Merge pull request #26 from Wei18/dependabot/submodules/Submodule/github/rest-api-description-e3b351a
2 parents f73f412 + 80ef87e commit b551db5

39 files changed

+4177
-9897
lines changed

Sources/actions/Client.swift

Lines changed: 329 additions & 300 deletions
Large diffs are not rendered by default.

Sources/actions/Types.swift

Lines changed: 987 additions & 1683 deletions
Large diffs are not rendered by default.

Sources/apps/Client.swift

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -825,10 +825,10 @@ public struct Client: APIProtocol {
825825
}
826826
/// List installations for the authenticated app
827827
///
828-
/// 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.
829-
///
830828
/// The permissions the installation has are included under the `permissions` key.
831829
///
830+
/// 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.
831+
///
832832
/// - Remark: HTTP `GET /app/installations`.
833833
/// - Remark: Generated from `#/paths//app/installations/get(apps/list-installations)`.
834834
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 {
17451745
}
17461746
/// Create a scoped access token
17471747
///
1748-
/// 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`.
1748+
/// Use a non-scoped user access token to create a repository-scoped and/or permission-scoped user access token. You can specify
1749+
/// which repositories the token can access and which permissions are granted to the
1750+
/// token.
1751+
///
1752+
/// Invalid tokens will return `404 NOT FOUND`.
1753+
///
1754+
/// You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)
1755+
/// when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App
1756+
/// as the username and password.
17491757
///
17501758
/// - Remark: HTTP `POST /applications/{client_id}/token/scoped`.
17511759
/// - Remark: Generated from `#/paths//applications/{client_id}/token/scoped/post(apps/scope-token)`.
@@ -1908,8 +1916,6 @@ public struct Client: APIProtocol {
19081916
///
19091917
/// **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`).
19101918
///
1911-
/// 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.
1912-
///
19131919
/// - Remark: HTTP `GET /apps/{app_slug}`.
19141920
/// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`.
19151921
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 {
20182024
///
20192025
/// List repositories that an app installation can access.
20202026
///
2021-
/// 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.
2022-
///
20232027
/// - Remark: HTTP `GET /installation/repositories`.
20242028
/// - Remark: Generated from `#/paths//installation/repositories/get(apps/list-repos-accessible-to-installation)`.
20252029
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 {
21522156
///
21532157
/// 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.
21542158
///
2155-
/// 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.
2156-
///
21572159
/// - Remark: HTTP `DELETE /installation/token`.
21582160
/// - Remark: Generated from `#/paths//installation/token/delete(apps/revoke-installation-access-token)`.
21592161
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 {
30993101
///
31003102
/// Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
31013103
///
3102-
/// 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.
3103-
///
31043104
/// 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.
31053105
///
31063106
/// You can find the permissions for the installation under the `permissions` key.
@@ -3237,8 +3237,6 @@ public struct Client: APIProtocol {
32373237
///
32383238
/// 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.
32393239
///
3240-
/// 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.
3241-
///
32423240
/// The access the user has to each repository is included in the hash under the `permissions` key.
32433241
///
32443242
/// - Remark: HTTP `GET /user/installations/{installation_id}/repositories`.
@@ -3373,8 +3371,6 @@ public struct Client: APIProtocol {
33733371
///
33743372
/// Add a single repository to an installation. The authenticated user must have admin access to the repository.
33753373
///
3376-
/// 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.
3377-
///
33783374
/// - Remark: HTTP `PUT /user/installations/{installation_id}/repositories/{repository_id}`.
33793375
/// - Remark: Generated from `#/paths//user/installations/{installation_id}/repositories/{repository_id}/put(apps/add-repo-to-installation-for-authenticated-user)`.
33803376
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 {
34663462
///
34673463
/// 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`.
34683464
///
3469-
/// 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.
3470-
///
34713465
/// - Remark: HTTP `DELETE /user/installations/{installation_id}/repositories/{repository_id}`.
34723466
/// - Remark: Generated from `#/paths//user/installations/{installation_id}/repositories/{repository_id}/delete(apps/remove-repo-from-installation-for-authenticated-user)`.
34733467
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 {
35593553
}
35603554
/// List subscriptions for the authenticated user
35613555
///
3562-
/// 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).
3556+
/// Lists the active subscriptions for the authenticated user.
35633557
///
35643558
/// - Remark: HTTP `GET /user/marketplace_purchases`.
35653559
/// - Remark: Generated from `#/paths//user/marketplace_purchases/get(apps/list-subscriptions-for-authenticated-user)`.
@@ -3689,7 +3683,7 @@ public struct Client: APIProtocol {
36893683
}
36903684
/// List subscriptions for the authenticated user (stubbed)
36913685
///
3692-
/// 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).
3686+
/// Lists the active subscriptions for the authenticated user.
36933687
///
36943688
/// - Remark: HTTP `GET /user/marketplace_purchases/stubbed`.
36953689
/// - Remark: Generated from `#/paths//user/marketplace_purchases/stubbed/get(apps/list-subscriptions-for-authenticated-user-stubbed)`.

0 commit comments

Comments
 (0)