Skip to content

Commit 33dfa10

Browse files
Merge pull request #63 from Wei18/dependabot/submodules/Submodule/github/rest-api-description-9272e44
Bump Submodule/github/rest-api-description from `3e3e138` to `9272e44`
2 parents 3d7ff4b + ffd7365 commit 33dfa10

40 files changed

+1499
-2386
lines changed

Sources/actions/Client.swift

+2-2
Original file line numberDiff line numberDiff line change
@@ -6809,8 +6809,8 @@ public struct Client: APIProtocol {
68096809
///
68106810
/// Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
68116811
///
6812-
/// **Note:** GitHub Apps can only review their own custom deployment protection rules.
6813-
/// 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).
6812+
/// > [!NOTE]
6813+
/// > 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).
68146814
///
68156815
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
68166816
///

Sources/actions/Types.swift

+8-7
Original file line numberDiff line numberDiff line change
@@ -984,8 +984,8 @@ public protocol APIProtocol: Sendable {
984984
///
985985
/// Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
986986
///
987-
/// **Note:** GitHub Apps can only review their own custom deployment protection rules.
988-
/// 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).
987+
/// > [!NOTE]
988+
/// > 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).
989989
///
990990
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
991991
///
@@ -3027,8 +3027,8 @@ extension APIProtocol {
30273027
///
30283028
/// Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
30293029
///
3030-
/// **Note:** GitHub Apps can only review their own custom deployment protection rules.
3031-
/// 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).
3030+
/// > [!NOTE]
3031+
/// > 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).
30323032
///
30333033
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
30343034
///
@@ -6341,7 +6341,8 @@ public enum Components {
63416341
public var verified_allowed: Swift.Bool?
63426342
/// Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.
63436343
///
6344-
/// **Note**: The `patterns_allowed` setting only applies to public repositories.
6344+
/// > [!NOTE]
6345+
/// > The `patterns_allowed` setting only applies to public repositories.
63456346
///
63466347
/// - Remark: Generated from `#/components/schemas/selected-actions/patterns_allowed`.
63476348
public var patterns_allowed: [Swift.String]?
@@ -23019,8 +23020,8 @@ public enum Operations {
2301923020
///
2302023021
/// Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see "[Using environments for deployment](https://docs.github.com/actions/deployment/targeting-different-environments/using-environments-for-deployment)."
2302123022
///
23022-
/// **Note:** GitHub Apps can only review their own custom deployment protection rules.
23023-
/// 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).
23023+
/// > [!NOTE]
23024+
/// > 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).
2302423025
///
2302523026
/// OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
2302623027
///

Sources/activity/Client.swift

+4-3
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,8 @@ 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.
177+
/// > [!NOTE]
178+
/// > 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.
178179
///
179180
/// - Remark: HTTP `GET /feeds`.
180181
/// - Remark: Generated from `#/paths//feeds/get(activity/get-feeds)`.
@@ -1307,8 +1308,8 @@ public struct Client: APIProtocol {
13071308
}
13081309
/// List repository events
13091310
///
1310-
/// **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
1311-
///
1311+
/// > [!NOTE]
1312+
/// > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
13121313
///
13131314
/// - Remark: HTTP `GET /repos/{owner}/{repo}/events`.
13141315
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/events/get(activity/list-repo-events)`.

Sources/activity/Types.swift

+12-9
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ 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/authentication/authenticating-to-the-rest-api#using-basic-authentication) since current feed URIs use the older, non revocable auth tokens.
35+
/// > [!NOTE]
36+
/// > 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.
3637
///
3738
/// - Remark: HTTP `GET /feeds`.
3839
/// - Remark: Generated from `#/paths//feeds/get(activity/get-feeds)`.
@@ -115,8 +116,8 @@ public protocol APIProtocol: Sendable {
115116
func activity_sol_list_hyphen_public_hyphen_org_hyphen_events(_ input: Operations.activity_sol_list_hyphen_public_hyphen_org_hyphen_events.Input) async throws -> Operations.activity_sol_list_hyphen_public_hyphen_org_hyphen_events.Output
116117
/// List repository events
117118
///
118-
/// **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
119-
///
119+
/// > [!NOTE]
120+
/// > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
120121
///
121122
/// - Remark: HTTP `GET /repos/{owner}/{repo}/events`.
122123
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/events/get(activity/list-repo-events)`.
@@ -299,7 +300,8 @@ extension APIProtocol {
299300
///
300301
/// 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)."
301302
///
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.
303+
/// > [!NOTE]
304+
/// > 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.
303305
///
304306
/// - Remark: HTTP `GET /feeds`.
305307
/// - Remark: Generated from `#/paths//feeds/get(activity/get-feeds)`.
@@ -464,8 +466,8 @@ extension APIProtocol {
464466
}
465467
/// List repository events
466468
///
467-
/// **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
468-
///
469+
/// > [!NOTE]
470+
/// > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
469471
///
470472
/// - Remark: HTTP `GET /repos/{owner}/{repo}/events`.
471473
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/events/get(activity/list-repo-events)`.
@@ -4924,7 +4926,8 @@ public enum Operations {
49244926
///
49254927
/// 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)."
49264928
///
4927-
/// **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.
4929+
/// > [!NOTE]
4930+
/// > 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.
49284931
///
49294932
/// - Remark: HTTP `GET /feeds`.
49304933
/// - Remark: Generated from `#/paths//feeds/get(activity/get-feeds)`.
@@ -7028,8 +7031,8 @@ public enum Operations {
70287031
}
70297032
/// List repository events
70307033
///
7031-
/// **Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
7032-
///
7034+
/// > [!NOTE]
7035+
/// > This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.
70337036
///
70347037
/// - Remark: HTTP `GET /repos/{owner}/{repo}/events`.
70357038
/// - Remark: Generated from `#/paths//repos/{owner}/{repo}/events/get(activity/list-repo-events)`.

Sources/apps/Client.swift

+2-1
Original file line numberDiff line numberDiff line change
@@ -1916,7 +1916,8 @@ public struct Client: APIProtocol {
19161916
}
19171917
/// Get an app
19181918
///
1919-
/// **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`).
1919+
/// > [!NOTE]
1920+
/// > 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`).
19201921
///
19211922
/// - Remark: HTTP `GET /apps/{app_slug}`.
19221923
/// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`.

Sources/apps/Types.swift

+6-3
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,8 @@ public protocol APIProtocol: Sendable {
181181
func apps_sol_scope_hyphen_token(_ input: Operations.apps_sol_scope_hyphen_token.Input) async throws -> Operations.apps_sol_scope_hyphen_token.Output
182182
/// Get an app
183183
///
184-
/// **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`).
184+
/// > [!NOTE]
185+
/// > 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`).
185186
///
186187
/// - Remark: HTTP `GET /apps/{app_slug}`.
187188
/// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`.
@@ -663,7 +664,8 @@ extension APIProtocol {
663664
}
664665
/// Get an app
665666
///
666-
/// **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`).
667+
/// > [!NOTE]
668+
/// > 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`).
667669
///
668670
/// - Remark: HTTP `GET /apps/{app_slug}`.
669671
/// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`.
@@ -8420,7 +8422,8 @@ public enum Operations {
84208422
}
84218423
/// Get an app
84228424
///
8423-
/// **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`).
8425+
/// > [!NOTE]
8426+
/// > 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`).
84248427
///
84258428
/// - Remark: HTTP `GET /apps/{app_slug}`.
84268429
/// - Remark: Generated from `#/paths//apps/{app_slug}/get(apps/get-by-slug)`.

0 commit comments

Comments
 (0)