Skip to content

Commit 2dbe51b

Browse files
authored
Merge pull request #45 from Wei18/dependabot/submodules/Submodule/github/rest-api-description-e5a5460
Bump Submodule/github/rest-api-description from `c8a0850` to `e5a5460`
2 parents 0fc67e1 + 9c8dd2b commit 2dbe51b

File tree

3 files changed

+253
-25
lines changed

3 files changed

+253
-25
lines changed

Sources/orgs/Client.swift

+63-6
Original file line numberDiff line numberDiff line change
@@ -822,6 +822,11 @@ public struct Client: APIProtocol {
822822
}
823823
/// List organization webhooks
824824
///
825+
/// You must be an organization owner to use this endpoint.
826+
///
827+
/// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
828+
/// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
829+
///
825830
/// - Remark: HTTP `GET /orgs/{org}/hooks`.
826831
/// - Remark: Generated from `#/paths//orgs/{org}/hooks/get(orgs/list-webhooks)`.
827832
public func orgs_sol_list_hyphen_webhooks(_ input: Operations.orgs_sol_list_hyphen_webhooks.Input) async throws -> Operations.orgs_sol_list_hyphen_webhooks.Output {
@@ -928,7 +933,12 @@ public struct Client: APIProtocol {
928933
}
929934
/// Create an organization webhook
930935
///
931-
/// Here's how you can create a hook that posts payloads in JSON format:
936+
/// Create a hook that posts payloads in JSON format.
937+
///
938+
/// You must be an organization owner to use this endpoint.
939+
///
940+
/// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or
941+
/// edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
932942
///
933943
/// - Remark: HTTP `POST /orgs/{org}/hooks`.
934944
/// - Remark: Generated from `#/paths//orgs/{org}/hooks/post(orgs/create-webhook)`.
@@ -1053,7 +1063,13 @@ public struct Client: APIProtocol {
10531063
}
10541064
/// Get an organization webhook
10551065
///
1056-
/// Returns a webhook configured in an organization. To get only the webhook `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization)."
1066+
/// Returns a webhook configured in an organization. To get only the webhook
1067+
/// `config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).
1068+
///
1069+
/// You must be an organization owner to use this endpoint.
1070+
///
1071+
/// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
1072+
/// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
10571073
///
10581074
/// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}`.
10591075
/// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/get(orgs/get-webhook)`.
@@ -1140,7 +1156,16 @@ public struct Client: APIProtocol {
11401156
}
11411157
/// Update an organization webhook
11421158
///
1143-
/// Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)."
1159+
/// Updates a webhook configured in an organization. When you update a webhook,
1160+
/// the `secret` will be overwritten. If you previously had a `secret` set, you must
1161+
/// provide the same `secret` or set a new `secret` or the secret will be removed. If
1162+
/// you are only updating individual webhook `config` properties, use "[Update a webhook
1163+
/// configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)".
1164+
///
1165+
/// You must be an organization owner to use this endpoint.
1166+
///
1167+
/// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
1168+
/// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
11441169
///
11451170
/// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}`.
11461171
/// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/patch(orgs/update-webhook)`.
@@ -1260,6 +1285,11 @@ public struct Client: APIProtocol {
12601285
}
12611286
/// Delete an organization webhook
12621287
///
1288+
/// You must be an organization owner to use this endpoint.
1289+
///
1290+
/// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
1291+
/// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
1292+
///
12631293
/// - Remark: HTTP `DELETE /orgs/{org}/hooks/{hook_id}`.
12641294
/// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/delete(orgs/delete-webhook)`.
12651295
public func orgs_sol_delete_hyphen_webhook(_ input: Operations.orgs_sol_delete_hyphen_webhook.Input) async throws -> Operations.orgs_sol_delete_hyphen_webhook.Output {
@@ -1327,7 +1357,10 @@ public struct Client: APIProtocol {
13271357
///
13281358
/// 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)."
13291359
///
1330-
/// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.
1360+
/// You must be an organization owner to use this endpoint.
1361+
///
1362+
/// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
1363+
/// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
13311364
///
13321365
/// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/config`.
13331366
/// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/get(orgs/get-webhook-config-for-org)`.
@@ -1394,7 +1427,10 @@ public struct Client: APIProtocol {
13941427
///
13951428
/// 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)."
13961429
///
1397-
/// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.
1430+
/// You must be an organization owner to use this endpoint.
1431+
///
1432+
/// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
1433+
/// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
13981434
///
13991435
/// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}/config`.
14001436
/// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/patch(orgs/update-webhook-config-for-org)`.
@@ -1472,6 +1508,11 @@ public struct Client: APIProtocol {
14721508
///
14731509
/// Returns a list of webhook deliveries for a webhook configured in an organization.
14741510
///
1511+
/// You must be an organization owner to use this endpoint.
1512+
///
1513+
/// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
1514+
/// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
1515+
///
14751516
/// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/deliveries`.
14761517
/// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/get(orgs/list-webhook-deliveries)`.
14771518
public func orgs_sol_list_hyphen_webhook_hyphen_deliveries(_ input: Operations.orgs_sol_list_hyphen_webhook_hyphen_deliveries.Input) async throws -> Operations.orgs_sol_list_hyphen_webhook_hyphen_deliveries.Output {
@@ -1611,6 +1652,11 @@ public struct Client: APIProtocol {
16111652
///
16121653
/// Returns a delivery for a webhook configured in an organization.
16131654
///
1655+
/// You must be an organization owner to use this endpoint.
1656+
///
1657+
/// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
1658+
/// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
1659+
///
16141660
/// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}`.
16151661
/// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/get(orgs/get-webhook-delivery)`.
16161662
public func orgs_sol_get_hyphen_webhook_hyphen_delivery(_ input: Operations.orgs_sol_get_hyphen_webhook_hyphen_delivery.Input) async throws -> Operations.orgs_sol_get_hyphen_webhook_hyphen_delivery.Output {
@@ -1730,6 +1776,11 @@ public struct Client: APIProtocol {
17301776
///
17311777
/// Redeliver a delivery for a webhook configured in an organization.
17321778
///
1779+
/// You must be an organization owner to use this endpoint.
1780+
///
1781+
/// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
1782+
/// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
1783+
///
17331784
/// - Remark: HTTP `POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts`.
17341785
/// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts/post(orgs/redeliver-webhook-delivery)`.
17351786
public func orgs_sol_redeliver_hyphen_webhook_hyphen_delivery(_ input: Operations.orgs_sol_redeliver_hyphen_webhook_hyphen_delivery.Input) async throws -> Operations.orgs_sol_redeliver_hyphen_webhook_hyphen_delivery.Output {
@@ -1847,7 +1898,13 @@ public struct Client: APIProtocol {
18471898
}
18481899
/// Ping an organization webhook
18491900
///
1850-
/// This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
1901+
/// This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)
1902+
/// to be sent to the hook.
1903+
///
1904+
/// You must be an organization owner to use this endpoint.
1905+
///
1906+
/// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
1907+
/// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
18511908
///
18521909
/// - Remark: HTTP `POST /orgs/{org}/hooks/{hook_id}/pings`.
18531910
/// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/pings/post(orgs/ping-webhook)`.

0 commit comments

Comments
 (0)