Skip to content

Commit 21c0f85

Browse files
Merge pull request #54 from Wei18/dependabot/submodules/Submodule/github/rest-api-description-5b52d7f
Bump Submodule/github/rest-api-description from `3a05345` to `5b52d7f`
2 parents 2bc00ab + b1745ed commit 21c0f85

19 files changed

+140
-140
lines changed

Sources/activity/Client.swift

+1-1
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ public struct Client: APIProtocol {
174174
///
175175
/// By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
176176
///
177-
/// **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.
177+
/// **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.
178178
///
179179
/// - Remark: HTTP `GET /feeds`.
180180
/// - Remark: Generated from `#/paths//feeds/get(activity/get-feeds)`.

Sources/activity/Types.swift

+3-3
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public protocol APIProtocol: Sendable {
3232
///
3333
/// By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
3434
///
35-
/// **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.
35+
/// **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.
3636
///
3737
/// - Remark: HTTP `GET /feeds`.
3838
/// - Remark: Generated from `#/paths//feeds/get(activity/get-feeds)`.
@@ -299,7 +299,7 @@ extension APIProtocol {
299299
///
300300
/// By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
301301
///
302-
/// **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.
302+
/// **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.
303303
///
304304
/// - Remark: HTTP `GET /feeds`.
305305
/// - Remark: Generated from `#/paths//feeds/get(activity/get-feeds)`.
@@ -4898,7 +4898,7 @@ public enum Operations {
48984898
///
48994899
/// By default, timeline resources are returned in JSON. You can specify the `application/atom+xml` type in the `Accept` header to return timeline resources in Atom format. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
49004900
///
4901-
/// **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.
4901+
/// **Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.
49024902
///
49034903
/// - Remark: HTTP `GET /feeds`.
49044904
/// - Remark: Generated from `#/paths//feeds/get(activity/get-feeds)`.

Sources/apps/Client.swift

+11-11
Original file line numberDiff line numberDiff line change
@@ -1388,7 +1388,7 @@ public struct Client: APIProtocol {
13881388
}
13891389
/// Delete an app authorization
13901390
///
1391-
/// OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.
1391+
/// OAuth and GitHub application owners can revoke a grant for their application and a specific user. You must use [Basic Authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid OAuth `access_token` as an input parameter and the grant for the token's owner will be deleted.
13921392
/// Deleting an application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).
13931393
///
13941394
/// - Remark: HTTP `DELETE /applications/{client_id}/grant`.
@@ -1464,7 +1464,7 @@ public struct Client: APIProtocol {
14641464
}
14651465
/// Check a token
14661466
///
1467-
/// OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.
1467+
/// OAuth applications and GitHub applications with OAuth authorizations can use this API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) to use this endpoint, where the username is the application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.
14681468
///
14691469
/// - Remark: HTTP `POST /applications/{client_id}/token`.
14701470
/// - Remark: Generated from `#/paths//applications/{client_id}/token/post(apps/check-token)`.
@@ -1581,7 +1581,7 @@ public struct Client: APIProtocol {
15811581
}
15821582
/// Reset a token
15831583
///
1584-
/// OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.
1584+
/// OAuth applications and GitHub applications with OAuth authorizations can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.
15851585
///
15861586
/// - Remark: HTTP `PATCH /applications/{client_id}/token`.
15871587
/// - Remark: Generated from `#/paths//applications/{client_id}/token/patch(apps/reset-token)`.
@@ -1676,7 +1676,7 @@ public struct Client: APIProtocol {
16761676
}
16771677
/// Delete an app token
16781678
///
1679-
/// OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password.
1679+
/// OAuth or GitHub application owners can revoke a single token for an OAuth application or a GitHub application with an OAuth authorization. You must use [Basic Authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) when accessing this endpoint, using the application's `client_id` and `client_secret` as the username and password.
16801680
///
16811681
/// - Remark: HTTP `DELETE /applications/{client_id}/token`.
16821682
/// - Remark: Generated from `#/paths//applications/{client_id}/token/delete(apps/delete-token)`.
@@ -1757,7 +1757,7 @@ public struct Client: APIProtocol {
17571757
///
17581758
/// Invalid tokens will return `404 NOT FOUND`.
17591759
///
1760-
/// You must use [Basic Authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication)
1760+
/// You must use [Basic Authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication)
17611761
/// when accessing this endpoint, using the `client_id` and `client_secret` of the GitHub App
17621762
/// as the username and password.
17631763
///
@@ -2200,7 +2200,7 @@ public struct Client: APIProtocol {
22002200
///
22012201
/// Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
22022202
///
2203-
/// GitHub Apps 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. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
2203+
/// GitHub Apps 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. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
22042204
///
22052205
/// - Remark: HTTP `GET /marketplace_listing/accounts/{account_id}`.
22062206
/// - Remark: Generated from `#/paths//marketplace_listing/accounts/{account_id}/get(apps/get-subscription-plan-for-account)`.
@@ -2310,7 +2310,7 @@ public struct Client: APIProtocol {
23102310
///
23112311
/// Lists all plans that are part of your GitHub Marketplace listing.
23122312
///
2313-
/// GitHub Apps 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. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
2313+
/// GitHub Apps 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. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
23142314
///
23152315
/// - Remark: HTTP `GET /marketplace_listing/plans`.
23162316
/// - Remark: Generated from `#/paths//marketplace_listing/plans/get(apps/list-plans)`.
@@ -2440,7 +2440,7 @@ public struct Client: APIProtocol {
24402440
///
24412441
/// Returns user and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
24422442
///
2443-
/// GitHub Apps 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. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
2443+
/// GitHub Apps 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. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
24442444
///
24452445
/// - Remark: HTTP `GET /marketplace_listing/plans/{plan_id}/accounts`.
24462446
/// - Remark: Generated from `#/paths//marketplace_listing/plans/{plan_id}/accounts/get(apps/list-accounts-for-plan)`.
@@ -2608,7 +2608,7 @@ public struct Client: APIProtocol {
26082608
///
26092609
/// Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
26102610
///
2611-
/// GitHub Apps 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. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
2611+
/// GitHub Apps 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. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
26122612
///
26132613
/// - Remark: HTTP `GET /marketplace_listing/stubbed/accounts/{account_id}`.
26142614
/// - Remark: Generated from `#/paths//marketplace_listing/stubbed/accounts/{account_id}/get(apps/get-subscription-plan-for-account-stubbed)`.
@@ -2698,7 +2698,7 @@ public struct Client: APIProtocol {
26982698
///
26992699
/// Lists all plans that are part of your GitHub Marketplace listing.
27002700
///
2701-
/// GitHub Apps 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. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
2701+
/// GitHub Apps 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. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
27022702
///
27032703
/// - Remark: HTTP `GET /marketplace_listing/stubbed/plans`.
27042704
/// - Remark: Generated from `#/paths//marketplace_listing/stubbed/plans/get(apps/list-plans-stubbed)`.
@@ -2806,7 +2806,7 @@ public struct Client: APIProtocol {
28062806
///
28072807
/// Returns repository and organization accounts associated with the specified plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.
28082808
///
2809-
/// GitHub Apps 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. OAuth apps must use [basic authentication](https://docs.github.com/rest/overview/other-authentication-methods#basic-authentication) with their client ID and client secret to access this endpoint.
2809+
/// GitHub Apps 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. OAuth apps must use [basic authentication](https://docs.github.com/rest/authentication/authenticating-to-the-rest-api#using-basic-authentication) with their client ID and client secret to access this endpoint.
28102810
///
28112811
/// - Remark: HTTP `GET /marketplace_listing/stubbed/plans/{plan_id}/accounts`.
28122812
/// - Remark: Generated from `#/paths//marketplace_listing/stubbed/plans/{plan_id}/accounts/get(apps/list-accounts-for-plan-stubbed)`.

0 commit comments

Comments
 (0)