diff --git a/Sources/orgs/Client.swift b/Sources/orgs/Client.swift index 30497be08fa..92a140444fc 100644 --- a/Sources/orgs/Client.swift +++ b/Sources/orgs/Client.swift @@ -822,6 +822,11 @@ public struct Client: APIProtocol { } /// List organization webhooks /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `GET /orgs/{org}/hooks`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/get(orgs/list-webhooks)`. 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 { } /// Create an organization webhook /// - /// Here's how you can create a hook that posts payloads in JSON format: + /// Create a hook that posts payloads in JSON format. + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or + /// edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `POST /orgs/{org}/hooks`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/post(orgs/create-webhook)`. @@ -1053,7 +1063,13 @@ public struct Client: APIProtocol { } /// Get an organization webhook /// - /// 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)." + /// 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). + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/get(orgs/get-webhook)`. @@ -1140,7 +1156,16 @@ public struct Client: APIProtocol { } /// Update an organization webhook /// - /// 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)." + /// 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)". + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/patch(orgs/update-webhook)`. @@ -1260,6 +1285,11 @@ public struct Client: APIProtocol { } /// Delete an organization webhook /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `DELETE /orgs/{org}/hooks/{hook_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/delete(orgs/delete-webhook)`. 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 { /// /// 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)." /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/config`. /// - 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 { /// /// 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)." /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}/config`. /// - 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 { /// /// Returns a list of webhook deliveries for a webhook configured in an organization. /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/deliveries`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/get(orgs/list-webhook-deliveries)`. 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 { /// /// Returns a delivery for a webhook configured in an organization. /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/get(orgs/get-webhook-delivery)`. 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 { /// /// Redeliver a delivery for a webhook configured in an organization. /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts/post(orgs/redeliver-webhook-delivery)`. 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 { } /// Ping an organization webhook /// - /// This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + /// This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) + /// to be sent to the hook. + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `POST /orgs/{org}/hooks/{hook_id}/pings`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/pings/post(orgs/ping-webhook)`. diff --git a/Sources/orgs/Types.swift b/Sources/orgs/Types.swift index 6985e9e4ee4..36cf0f61819 100644 --- a/Sources/orgs/Types.swift +++ b/Sources/orgs/Types.swift @@ -98,32 +98,62 @@ public protocol APIProtocol: Sendable { func orgs_sol_list_hyphen_failed_hyphen_invitations(_ input: Operations.orgs_sol_list_hyphen_failed_hyphen_invitations.Input) async throws -> Operations.orgs_sol_list_hyphen_failed_hyphen_invitations.Output /// List organization webhooks /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `GET /orgs/{org}/hooks`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/get(orgs/list-webhooks)`. func orgs_sol_list_hyphen_webhooks(_ input: Operations.orgs_sol_list_hyphen_webhooks.Input) async throws -> Operations.orgs_sol_list_hyphen_webhooks.Output /// Create an organization webhook /// - /// Here's how you can create a hook that posts payloads in JSON format: + /// Create a hook that posts payloads in JSON format. + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or + /// edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `POST /orgs/{org}/hooks`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/post(orgs/create-webhook)`. func orgs_sol_create_hyphen_webhook(_ input: Operations.orgs_sol_create_hyphen_webhook.Input) async throws -> Operations.orgs_sol_create_hyphen_webhook.Output /// Get an organization webhook /// - /// 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)." + /// 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). + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/get(orgs/get-webhook)`. func orgs_sol_get_hyphen_webhook(_ input: Operations.orgs_sol_get_hyphen_webhook.Input) async throws -> Operations.orgs_sol_get_hyphen_webhook.Output /// Update an organization webhook /// - /// 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)." + /// 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)". + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/patch(orgs/update-webhook)`. func orgs_sol_update_hyphen_webhook(_ input: Operations.orgs_sol_update_hyphen_webhook.Input) async throws -> Operations.orgs_sol_update_hyphen_webhook.Output /// Delete an organization webhook /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `DELETE /orgs/{org}/hooks/{hook_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/delete(orgs/delete-webhook)`. func orgs_sol_delete_hyphen_webhook(_ input: Operations.orgs_sol_delete_hyphen_webhook.Input) async throws -> Operations.orgs_sol_delete_hyphen_webhook.Output @@ -131,7 +161,10 @@ public protocol APIProtocol: Sendable { /// /// 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)." /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/get(orgs/get-webhook-config-for-org)`. @@ -140,7 +173,10 @@ public protocol APIProtocol: Sendable { /// /// 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)." /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/patch(orgs/update-webhook-config-for-org)`. @@ -149,6 +185,11 @@ public protocol APIProtocol: Sendable { /// /// Returns a list of webhook deliveries for a webhook configured in an organization. /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/deliveries`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/get(orgs/list-webhook-deliveries)`. 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 @@ -156,6 +197,11 @@ public protocol APIProtocol: Sendable { /// /// Returns a delivery for a webhook configured in an organization. /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/get(orgs/get-webhook-delivery)`. 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 @@ -163,12 +209,23 @@ public protocol APIProtocol: Sendable { /// /// Redeliver a delivery for a webhook configured in an organization. /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts/post(orgs/redeliver-webhook-delivery)`. 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 /// Ping an organization webhook /// - /// This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + /// This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) + /// to be sent to the hook. + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `POST /orgs/{org}/hooks/{hook_id}/pings`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/pings/post(orgs/ping-webhook)`. @@ -887,6 +944,11 @@ extension APIProtocol { } /// List organization webhooks /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `GET /orgs/{org}/hooks`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/get(orgs/list-webhooks)`. public func orgs_sol_list_hyphen_webhooks( @@ -902,7 +964,12 @@ extension APIProtocol { } /// Create an organization webhook /// - /// Here's how you can create a hook that posts payloads in JSON format: + /// Create a hook that posts payloads in JSON format. + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or + /// edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `POST /orgs/{org}/hooks`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/post(orgs/create-webhook)`. @@ -919,7 +986,13 @@ extension APIProtocol { } /// Get an organization webhook /// - /// 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)." + /// 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). + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/get(orgs/get-webhook)`. @@ -934,7 +1007,16 @@ extension APIProtocol { } /// Update an organization webhook /// - /// 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)." + /// 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)". + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/patch(orgs/update-webhook)`. @@ -951,6 +1033,11 @@ extension APIProtocol { } /// Delete an organization webhook /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `DELETE /orgs/{org}/hooks/{hook_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/delete(orgs/delete-webhook)`. public func orgs_sol_delete_hyphen_webhook( @@ -966,7 +1053,10 @@ extension APIProtocol { /// /// 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)." /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/get(orgs/get-webhook-config-for-org)`. @@ -983,7 +1073,10 @@ extension APIProtocol { /// /// 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)." /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/patch(orgs/update-webhook-config-for-org)`. @@ -1002,6 +1095,11 @@ extension APIProtocol { /// /// Returns a list of webhook deliveries for a webhook configured in an organization. /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/deliveries`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/get(orgs/list-webhook-deliveries)`. public func orgs_sol_list_hyphen_webhook_hyphen_deliveries( @@ -1019,6 +1117,11 @@ extension APIProtocol { /// /// Returns a delivery for a webhook configured in an organization. /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/get(orgs/get-webhook-delivery)`. public func orgs_sol_get_hyphen_webhook_hyphen_delivery( @@ -1034,6 +1137,11 @@ extension APIProtocol { /// /// Redeliver a delivery for a webhook configured in an organization. /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts/post(orgs/redeliver-webhook-delivery)`. public func orgs_sol_redeliver_hyphen_webhook_hyphen_delivery( @@ -1047,7 +1155,13 @@ extension APIProtocol { } /// Ping an organization webhook /// - /// This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + /// This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) + /// to be sent to the hook. + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `POST /orgs/{org}/hooks/{hook_id}/pings`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/pings/post(orgs/ping-webhook)`. @@ -8752,6 +8866,11 @@ public enum Operations { } /// List organization webhooks /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `GET /orgs/{org}/hooks`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/get(orgs/list-webhooks)`. public enum orgs_sol_list_hyphen_webhooks { @@ -8951,7 +9070,12 @@ public enum Operations { } /// Create an organization webhook /// - /// Here's how you can create a hook that posts payloads in JSON format: + /// Create a hook that posts payloads in JSON format. + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or + /// edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `POST /orgs/{org}/hooks`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/post(orgs/create-webhook)`. @@ -9249,7 +9373,13 @@ public enum Operations { } /// Get an organization webhook /// - /// 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)." + /// 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). + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/get(orgs/get-webhook)`. @@ -9413,7 +9543,16 @@ public enum Operations { } /// Update an organization webhook /// - /// 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)." + /// 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)". + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/patch(orgs/update-webhook)`. @@ -9687,6 +9826,11 @@ public enum Operations { } /// Delete an organization webhook /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `DELETE /orgs/{org}/hooks/{hook_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/delete(orgs/delete-webhook)`. public enum orgs_sol_delete_hyphen_webhook { @@ -9827,7 +9971,10 @@ public enum Operations { /// /// 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)." /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/get(orgs/get-webhook-config-for-org)`. @@ -9970,7 +10117,10 @@ public enum Operations { /// /// 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)." /// - /// OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint. + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `PATCH /orgs/{org}/hooks/{hook_id}/config`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/config/patch(orgs/update-webhook-config-for-org)`. @@ -10157,6 +10307,11 @@ public enum Operations { /// /// Returns a list of webhook deliveries for a webhook configured in an organization. /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/deliveries`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/get(orgs/list-webhook-deliveries)`. public enum orgs_sol_list_hyphen_webhook_hyphen_deliveries { @@ -10382,6 +10537,11 @@ public enum Operations { /// /// Returns a delivery for a webhook configured in an organization. /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `GET /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/get(orgs/get-webhook-delivery)`. public enum orgs_sol_get_hyphen_webhook_hyphen_delivery { @@ -10580,6 +10740,11 @@ public enum Operations { /// /// Redeliver a delivery for a webhook configured in an organization. /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. + /// /// - Remark: HTTP `POST /orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts/post(orgs/redeliver-webhook-delivery)`. public enum orgs_sol_redeliver_hyphen_webhook_hyphen_delivery { @@ -10748,7 +10913,13 @@ public enum Operations { } /// Ping an organization webhook /// - /// This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook. + /// This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) + /// to be sent to the hook. + /// + /// You must be an organization owner to use this endpoint. + /// + /// OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit + /// webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps. /// /// - Remark: HTTP `POST /orgs/{org}/hooks/{hook_id}/pings`. /// - Remark: Generated from `#/paths//orgs/{org}/hooks/{hook_id}/pings/post(orgs/ping-webhook)`. diff --git a/Submodule/github/rest-api-description b/Submodule/github/rest-api-description index c8a0850a580..e5a54606e07 160000 --- a/Submodule/github/rest-api-description +++ b/Submodule/github/rest-api-description @@ -1 +1 @@ -Subproject commit c8a0850a580b898a451e86e574e26df0b94302ec +Subproject commit e5a54606e0754e4d4d2d083c635f86337f93b775