You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Sources/apps/Client.swift
+13-19Lines changed: 13 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -825,10 +825,10 @@ public struct Client: APIProtocol {
825
825
}
826
826
/// List installations for the authenticated app
827
827
///
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
-
///
830
828
/// The permissions the installation has are included under the `permissions` key.
831
829
///
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
+
///
832
832
/// - Remark: HTTP `GET /app/installations`.
833
833
/// - Remark: Generated from `#/paths//app/installations/get(apps/list-installations)`.
@@ -1745,7 +1745,15 @@ public struct Client: APIProtocol {
1745
1745
}
1746
1746
/// Create a scoped access token
1747
1747
///
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
/// - Remark: Generated from `#/paths//applications/{client_id}/token/scoped/post(apps/scope-token)`.
@@ -1908,8 +1916,6 @@ public struct Client: APIProtocol {
1908
1916
///
1909
1917
/// **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`).
1910
1918
///
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
-
///
1913
1919
/// - Remark: HTTP `GET /apps/{app_slug}`.
1914
1920
/// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`.
@@ -2018,8 +2024,6 @@ public struct Client: APIProtocol {
2018
2024
///
2019
2025
/// List repositories that an app installation can access.
2020
2026
///
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.
@@ -2152,8 +2156,6 @@ public struct Client: APIProtocol {
2152
2156
///
2153
2157
/// 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.
2154
2158
///
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
-
///
2157
2159
/// - Remark: HTTP `DELETE /installation/token`.
2158
2160
/// - Remark: Generated from `#/paths//installation/token/delete(apps/revoke-installation-access-token)`.
@@ -3099,8 +3101,6 @@ public struct Client: APIProtocol {
3099
3101
///
3100
3102
/// Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.
3101
3103
///
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
-
///
3104
3104
/// 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.
3105
3105
///
3106
3106
/// You can find the permissions for the installation under the `permissions` key.
@@ -3237,8 +3237,6 @@ public struct Client: APIProtocol {
3237
3237
///
3238
3238
/// 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.
3239
3239
///
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
-
///
3242
3240
/// The access the user has to each repository is included in the hash under the `permissions` key.
@@ -3373,8 +3371,6 @@ public struct Client: APIProtocol {
3373
3371
///
3374
3372
/// Add a single repository to an installation. The authenticated user must have admin access to the repository.
3375
3373
///
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.
@@ -3466,8 +3462,6 @@ public struct Client: APIProtocol {
3466
3462
///
3467
3463
/// 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`.
3468
3464
///
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.
@@ -3559,7 +3553,7 @@ public struct Client: APIProtocol {
3559
3553
}
3560
3554
/// List subscriptions for the authenticated user
3561
3555
///
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.
/// - Remark: Generated from `#/paths//user/marketplace_purchases/get(apps/list-subscriptions-for-authenticated-user)`.
@@ -3689,7 +3683,7 @@ public struct Client: APIProtocol {
3689
3683
}
3690
3684
/// List subscriptions for the authenticated user (stubbed)
3691
3685
///
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.
0 commit comments