diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index afa1576c41..66769248b5 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -10369,7 +10369,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10426,7 +10426,7 @@ }, "post": { "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or \nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10566,7 +10566,7 @@ "/orgs/{org}/hooks/{hook_id}": { "get": { "summary": "Get an organization webhook", - "description": "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).\"", + "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10612,7 +10612,7 @@ }, "patch": { "summary": "Update an organization webhook", - "description": "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).\"", + "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10725,7 +10725,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10761,7 +10761,7 @@ "/orgs/{org}/hooks/{hook_id}/config": { "get": { "summary": "Get a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10804,7 +10804,7 @@ }, "patch": { "summary": "Update a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10884,7 +10884,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries": { "get": { "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10952,7 +10952,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { "get": { "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.", + "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -11006,7 +11006,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an organization webhook", - "description": "Redeliver a delivery for a webhook configured in an organization.", + "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -11048,7 +11048,7 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 412b43d350..cda96f4ee0 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -7517,7 +7517,10 @@ paths: "/orgs/{org}/hooks": get: summary: List organization webhooks - description: '' + description: "You must be an organization owner to use this endpoint. \n\nOAuth + app tokens and personal access tokens (classic) need `admin:org_hook` scope. + OAuth apps cannot list, view, or edit \nwebhooks that they did not create + and users cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhooks @@ -7552,8 +7555,11 @@ paths: subcategory: webhooks post: summary: Create an organization webhook - description: 'Here''s how you can create a hook that posts payloads in JSON - format:' + description: "Create a hook that posts payloads in JSON format.\n\nYou must + be an organization owner to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or \nedit webhooks that they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/create-webhook @@ -7649,8 +7655,12 @@ paths: "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook - description: 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)." + description: "Returns a webhook configured in an organization. To get only the + webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app + tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth + apps cannot list, view, or edit \nwebhooks that they did not create and users + cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook @@ -7679,11 +7689,15 @@ paths: subcategory: webhooks patch: summary: Update an organization webhook - description: 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)." + description: "Updates a webhook configured in an organization. When you update + a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` + set, you must\nprovide the same `secret` or set a new `secret` or the secret + will be removed. If\nyou are only updating individual webhook `config` properties, + use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". + \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app + tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth + apps cannot list, view, or edit \nwebhooks that they did not create and users + cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook @@ -7758,7 +7772,10 @@ paths: subcategory: webhooks delete: summary: Delete an organization webhook - description: '' + description: "You must be an organization owner to use this endpoint. \n\nOAuth + app tokens and personal access tokens (classic) need `admin:org_hook` scope. + OAuth apps cannot list, view, or edit \nwebhooks that they did not create + and users cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/delete-webhook @@ -7781,10 +7798,13 @@ paths: "/orgs/{org}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for an organization - description: |- - 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. + description: "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).\"\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-config-for-org @@ -7811,10 +7831,13 @@ paths: subcategory: webhooks patch: summary: Update a webhook configuration for an organization - description: |- - 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. + description: "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).\"\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook-config-for-org @@ -7865,8 +7888,12 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook - description: Returns a list of webhook deliveries for a webhook configured in - an organization. + description: "Returns a list of webhook deliveries for a webhook configured + in an organization.\n\nYou must be an organization owner to use this endpoint. + \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` + scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not + create and users cannot list, view, or edit webhooks that were created by + OAuth apps." tags: - orgs operationId: orgs/list-webhook-deliveries @@ -7907,7 +7934,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook - description: Returns a delivery for a webhook configured in an organization. + description: "Returns a delivery for a webhook configured in an organization.\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-delivery @@ -7940,7 +7971,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook - description: Redeliver a delivery for a webhook configured in an organization. + description: "Redeliver a delivery for a webhook configured in an organization.\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/redeliver-webhook-delivery @@ -7966,8 +8001,12 @@ paths: "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook - description: This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) - to be sent to the hook. + description: "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto + be sent to the hook.\n\nYou must be an organization owner to use this endpoint. + \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` + scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not + create and users cannot list, view, or edit webhooks that were created by + OAuth apps." tags: - orgs operationId: orgs/ping-webhook diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index afa1576c41..66769248b5 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -10369,7 +10369,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10426,7 +10426,7 @@ }, "post": { "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or \nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10566,7 +10566,7 @@ "/orgs/{org}/hooks/{hook_id}": { "get": { "summary": "Get an organization webhook", - "description": "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).\"", + "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10612,7 +10612,7 @@ }, "patch": { "summary": "Update an organization webhook", - "description": "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).\"", + "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10725,7 +10725,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10761,7 +10761,7 @@ "/orgs/{org}/hooks/{hook_id}/config": { "get": { "summary": "Get a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10804,7 +10804,7 @@ }, "patch": { "summary": "Update a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10884,7 +10884,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries": { "get": { "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -10952,7 +10952,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { "get": { "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.", + "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -11006,7 +11006,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an organization webhook", - "description": "Redeliver a delivery for a webhook configured in an organization.", + "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -11048,7 +11048,7 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 412b43d350..cda96f4ee0 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -7517,7 +7517,10 @@ paths: "/orgs/{org}/hooks": get: summary: List organization webhooks - description: '' + description: "You must be an organization owner to use this endpoint. \n\nOAuth + app tokens and personal access tokens (classic) need `admin:org_hook` scope. + OAuth apps cannot list, view, or edit \nwebhooks that they did not create + and users cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhooks @@ -7552,8 +7555,11 @@ paths: subcategory: webhooks post: summary: Create an organization webhook - description: 'Here''s how you can create a hook that posts payloads in JSON - format:' + description: "Create a hook that posts payloads in JSON format.\n\nYou must + be an organization owner to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or \nedit webhooks that they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/create-webhook @@ -7649,8 +7655,12 @@ paths: "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook - description: 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)." + description: "Returns a webhook configured in an organization. To get only the + webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app + tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth + apps cannot list, view, or edit \nwebhooks that they did not create and users + cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook @@ -7679,11 +7689,15 @@ paths: subcategory: webhooks patch: summary: Update an organization webhook - description: 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)." + description: "Updates a webhook configured in an organization. When you update + a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` + set, you must\nprovide the same `secret` or set a new `secret` or the secret + will be removed. If\nyou are only updating individual webhook `config` properties, + use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". + \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app + tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth + apps cannot list, view, or edit \nwebhooks that they did not create and users + cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook @@ -7758,7 +7772,10 @@ paths: subcategory: webhooks delete: summary: Delete an organization webhook - description: '' + description: "You must be an organization owner to use this endpoint. \n\nOAuth + app tokens and personal access tokens (classic) need `admin:org_hook` scope. + OAuth apps cannot list, view, or edit \nwebhooks that they did not create + and users cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/delete-webhook @@ -7781,10 +7798,13 @@ paths: "/orgs/{org}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for an organization - description: |- - 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. + description: "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).\"\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-config-for-org @@ -7811,10 +7831,13 @@ paths: subcategory: webhooks patch: summary: Update a webhook configuration for an organization - description: |- - 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. + description: "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).\"\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook-config-for-org @@ -7865,8 +7888,12 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook - description: Returns a list of webhook deliveries for a webhook configured in - an organization. + description: "Returns a list of webhook deliveries for a webhook configured + in an organization.\n\nYou must be an organization owner to use this endpoint. + \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` + scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not + create and users cannot list, view, or edit webhooks that were created by + OAuth apps." tags: - orgs operationId: orgs/list-webhook-deliveries @@ -7907,7 +7934,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook - description: Returns a delivery for a webhook configured in an organization. + description: "Returns a delivery for a webhook configured in an organization.\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-delivery @@ -7940,7 +7971,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook - description: Redeliver a delivery for a webhook configured in an organization. + description: "Redeliver a delivery for a webhook configured in an organization.\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/redeliver-webhook-delivery @@ -7966,8 +8001,12 @@ paths: "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook - description: This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) - to be sent to the hook. + description: "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto + be sent to the hook.\n\nYou must be an organization owner to use this endpoint. + \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` + scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not + create and users cannot list, view, or edit webhooks that were created by + OAuth apps." tags: - orgs operationId: orgs/ping-webhook diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 1f3d538842..5b0c6bdef6 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -79629,7 +79629,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -79861,7 +79861,7 @@ }, "post": { "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or \nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -80255,7 +80255,7 @@ "/orgs/{org}/hooks/{hook_id}": { "get": { "summary": "Get an organization webhook", - "description": "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).\"", + "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -80465,7 +80465,7 @@ }, "patch": { "summary": "Update an organization webhook", - "description": "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).\"", + "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -80837,7 +80837,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -80908,7 +80908,7 @@ "/orgs/{org}/hooks/{hook_id}/config": { "get": { "summary": "Get a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -81008,7 +81008,7 @@ }, "patch": { "summary": "Update a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -81169,7 +81169,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries": { "get": { "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -81529,7 +81529,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { "get": { "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.", + "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -81942,7 +81942,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an organization webhook", - "description": "Redeliver a delivery for a webhook configured in an organization.", + "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -82150,7 +82150,7 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index af251d3714..ab14434bba 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -21223,7 +21223,10 @@ paths: "/orgs/{org}/hooks": get: summary: List organization webhooks - description: '' + description: "You must be an organization owner to use this endpoint. \n\nOAuth + app tokens and personal access tokens (classic) need `admin:org_hook` scope. + OAuth apps cannot list, view, or edit \nwebhooks that they did not create + and users cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhooks @@ -21350,8 +21353,11 @@ paths: subcategory: webhooks post: summary: Create an organization webhook - description: 'Here''s how you can create a hook that posts payloads in JSON - format:' + description: "Create a hook that posts payloads in JSON format.\n\nYou must + be an organization owner to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or \nedit webhooks that they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/create-webhook @@ -21455,8 +21461,12 @@ paths: "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook - description: 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)." + description: "Returns a webhook configured in an organization. To get only the + webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app + tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth + apps cannot list, view, or edit \nwebhooks that they did not create and users + cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook @@ -21489,11 +21499,15 @@ paths: subcategory: webhooks patch: summary: Update an organization webhook - description: 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)." + description: "Updates a webhook configured in an organization. When you update + a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` + set, you must\nprovide the same `secret` or set a new `secret` or the secret + will be removed. If\nyou are only updating individual webhook `config` properties, + use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". + \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app + tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth + apps cannot list, view, or edit \nwebhooks that they did not create and users + cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook @@ -21575,7 +21589,10 @@ paths: subcategory: webhooks delete: summary: Delete an organization webhook - description: '' + description: "You must be an organization owner to use this endpoint. \n\nOAuth + app tokens and personal access tokens (classic) need `admin:org_hook` scope. + OAuth apps cannot list, view, or edit \nwebhooks that they did not create + and users cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/delete-webhook @@ -21597,10 +21614,13 @@ paths: "/orgs/{org}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for an organization - description: |- - 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. + description: "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).\"\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-config-for-org @@ -21625,10 +21645,13 @@ paths: subcategory: webhooks patch: summary: Update a webhook configuration for an organization - description: |- - 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. + description: "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).\"\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook-config-for-org @@ -21673,8 +21696,12 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook - description: Returns a list of webhook deliveries for a webhook configured in - an organization. + description: "Returns a list of webhook deliveries for a webhook configured + in an organization.\n\nYou must be an organization owner to use this endpoint. + \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` + scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not + create and users cannot list, view, or edit webhooks that were created by + OAuth apps." tags: - orgs operationId: orgs/list-webhook-deliveries @@ -21711,7 +21738,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook - description: Returns a delivery for a webhook configured in an organization. + description: "Returns a delivery for a webhook configured in an organization.\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-delivery @@ -21740,7 +21771,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook - description: Redeliver a delivery for a webhook configured in an organization. + description: "Redeliver a delivery for a webhook configured in an organization.\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/redeliver-webhook-delivery @@ -21763,8 +21798,12 @@ paths: "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook - description: This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) - to be sent to the hook. + description: "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto + be sent to the hook.\n\nYou must be an organization owner to use this endpoint. + \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` + scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not + create and users cannot list, view, or edit webhooks that were created by + OAuth apps." tags: - orgs operationId: orgs/ping-webhook diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index 1f3d538842..5b0c6bdef6 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -79629,7 +79629,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -79861,7 +79861,7 @@ }, "post": { "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or \nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -80255,7 +80255,7 @@ "/orgs/{org}/hooks/{hook_id}": { "get": { "summary": "Get an organization webhook", - "description": "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).\"", + "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -80465,7 +80465,7 @@ }, "patch": { "summary": "Update an organization webhook", - "description": "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).\"", + "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -80837,7 +80837,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -80908,7 +80908,7 @@ "/orgs/{org}/hooks/{hook_id}/config": { "get": { "summary": "Get a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -81008,7 +81008,7 @@ }, "patch": { "summary": "Update a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -81169,7 +81169,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries": { "get": { "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -81529,7 +81529,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { "get": { "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.", + "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -81942,7 +81942,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an organization webhook", - "description": "Redeliver a delivery for a webhook configured in an organization.", + "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -82150,7 +82150,7 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.", + "description": "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index af251d3714..ab14434bba 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -21223,7 +21223,10 @@ paths: "/orgs/{org}/hooks": get: summary: List organization webhooks - description: '' + description: "You must be an organization owner to use this endpoint. \n\nOAuth + app tokens and personal access tokens (classic) need `admin:org_hook` scope. + OAuth apps cannot list, view, or edit \nwebhooks that they did not create + and users cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhooks @@ -21350,8 +21353,11 @@ paths: subcategory: webhooks post: summary: Create an organization webhook - description: 'Here''s how you can create a hook that posts payloads in JSON - format:' + description: "Create a hook that posts payloads in JSON format.\n\nYou must + be an organization owner to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or \nedit webhooks that they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/create-webhook @@ -21455,8 +21461,12 @@ paths: "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook - description: 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)." + description: "Returns a webhook configured in an organization. To get only the + webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app + tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth + apps cannot list, view, or edit \nwebhooks that they did not create and users + cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook @@ -21489,11 +21499,15 @@ paths: subcategory: webhooks patch: summary: Update an organization webhook - description: 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)." + description: "Updates a webhook configured in an organization. When you update + a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` + set, you must\nprovide the same `secret` or set a new `secret` or the secret + will be removed. If\nyou are only updating individual webhook `config` properties, + use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". + \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app + tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth + apps cannot list, view, or edit \nwebhooks that they did not create and users + cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook @@ -21575,7 +21589,10 @@ paths: subcategory: webhooks delete: summary: Delete an organization webhook - description: '' + description: "You must be an organization owner to use this endpoint. \n\nOAuth + app tokens and personal access tokens (classic) need `admin:org_hook` scope. + OAuth apps cannot list, view, or edit \nwebhooks that they did not create + and users cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/delete-webhook @@ -21597,10 +21614,13 @@ paths: "/orgs/{org}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for an organization - description: |- - 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. + description: "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).\"\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-config-for-org @@ -21625,10 +21645,13 @@ paths: subcategory: webhooks patch: summary: Update a webhook configuration for an organization - description: |- - 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. + description: "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).\"\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook-config-for-org @@ -21673,8 +21696,12 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook - description: Returns a list of webhook deliveries for a webhook configured in - an organization. + description: "Returns a list of webhook deliveries for a webhook configured + in an organization.\n\nYou must be an organization owner to use this endpoint. + \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` + scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not + create and users cannot list, view, or edit webhooks that were created by + OAuth apps." tags: - orgs operationId: orgs/list-webhook-deliveries @@ -21711,7 +21738,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook - description: Returns a delivery for a webhook configured in an organization. + description: "Returns a delivery for a webhook configured in an organization.\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-delivery @@ -21740,7 +21771,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook - description: Redeliver a delivery for a webhook configured in an organization. + description: "Redeliver a delivery for a webhook configured in an organization.\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/redeliver-webhook-delivery @@ -21763,8 +21798,12 @@ paths: "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook - description: This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) - to be sent to the hook. + description: "This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)\nto + be sent to the hook.\n\nYou must be an organization owner to use this endpoint. + \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` + scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not + create and users cannot list, view, or edit webhooks that were created by + OAuth apps." tags: - orgs operationId: orgs/ping-webhook diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index b3d760a35d..9c17389872 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -96636,7 +96636,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -96868,7 +96868,7 @@ }, "post": { "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -97262,7 +97262,7 @@ "/orgs/{org}/hooks/{hook_id}": { "get": { "summary": "Get an organization webhook", - "description": "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).\"", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -97472,7 +97472,7 @@ }, "patch": { "summary": "Update an organization webhook", - "description": "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).\"", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -97844,7 +97844,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -97915,7 +97915,7 @@ "/orgs/{org}/hooks/{hook_id}/config": { "get": { "summary": "Get a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98015,7 +98015,7 @@ }, "patch": { "summary": "Update a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98176,7 +98176,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries": { "get": { "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98536,7 +98536,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { "get": { "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98949,7 +98949,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an organization webhook", - "description": "Redeliver a delivery for a webhook configured in an organization.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -99157,7 +99157,7 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) to be sent to the hook.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 9193fdbb0b..75e34cf5cd 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -26391,7 +26391,11 @@ paths: "/orgs/{org}/hooks": get: summary: List organization webhooks - description: '' + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhooks @@ -26518,8 +26522,11 @@ paths: subcategory: webhooks post: summary: Create an organization webhook - description: 'Here''s how you can create a hook that posts payloads in JSON - format:' + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/create-webhook @@ -26623,8 +26630,11 @@ paths: "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook - description: 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)." + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook @@ -26657,11 +26667,11 @@ paths: subcategory: webhooks patch: summary: Update an organization webhook - description: 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)." + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook @@ -26743,7 +26753,11 @@ paths: subcategory: webhooks delete: summary: Delete an organization webhook - description: '' + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/delete-webhook @@ -26765,10 +26779,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for an organization - description: |- - 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. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-config-for-org @@ -26793,10 +26808,11 @@ paths: subcategory: webhooks patch: summary: Update a webhook configuration for an organization - description: |- - 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. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook-config-for-org @@ -26841,8 +26857,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook - description: Returns a list of webhook deliveries for a webhook configured in - an organization. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhook-deliveries @@ -26879,7 +26898,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook - description: Returns a delivery for a webhook configured in an organization. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-delivery @@ -26908,7 +26931,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook - description: Redeliver a delivery for a webhook configured in an organization. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/redeliver-webhook-delivery @@ -26931,8 +26958,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook - description: This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) - to be sent to the hook. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/ping-webhook diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index b3d760a35d..9c17389872 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -96636,7 +96636,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -96868,7 +96868,7 @@ }, "post": { "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -97262,7 +97262,7 @@ "/orgs/{org}/hooks/{hook_id}": { "get": { "summary": "Get an organization webhook", - "description": "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).\"", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -97472,7 +97472,7 @@ }, "patch": { "summary": "Update an organization webhook", - "description": "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).\"", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -97844,7 +97844,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -97915,7 +97915,7 @@ "/orgs/{org}/hooks/{hook_id}/config": { "get": { "summary": "Get a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98015,7 +98015,7 @@ }, "patch": { "summary": "Update a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98176,7 +98176,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries": { "get": { "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98536,7 +98536,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { "get": { "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98949,7 +98949,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an organization webhook", - "description": "Redeliver a delivery for a webhook configured in an organization.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -99157,7 +99157,7 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) to be sent to the hook.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 9193fdbb0b..75e34cf5cd 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -26391,7 +26391,11 @@ paths: "/orgs/{org}/hooks": get: summary: List organization webhooks - description: '' + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhooks @@ -26518,8 +26522,11 @@ paths: subcategory: webhooks post: summary: Create an organization webhook - description: 'Here''s how you can create a hook that posts payloads in JSON - format:' + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/create-webhook @@ -26623,8 +26630,11 @@ paths: "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook - description: 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)." + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook @@ -26657,11 +26667,11 @@ paths: subcategory: webhooks patch: summary: Update an organization webhook - description: 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)." + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook @@ -26743,7 +26753,11 @@ paths: subcategory: webhooks delete: summary: Delete an organization webhook - description: '' + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/delete-webhook @@ -26765,10 +26779,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for an organization - description: |- - 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. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-config-for-org @@ -26793,10 +26808,11 @@ paths: subcategory: webhooks patch: summary: Update a webhook configuration for an organization - description: |- - 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. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook-config-for-org @@ -26841,8 +26857,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook - description: Returns a list of webhook deliveries for a webhook configured in - an organization. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhook-deliveries @@ -26879,7 +26898,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook - description: Returns a delivery for a webhook configured in an organization. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-delivery @@ -26908,7 +26931,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook - description: Redeliver a delivery for a webhook configured in an organization. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/redeliver-webhook-delivery @@ -26931,8 +26958,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook - description: This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) - to be sent to the hook. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/ping-webhook diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 9af30f23dd..761e303eea 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -14934,7 +14934,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -14991,7 +14991,7 @@ }, "post": { "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15131,7 +15131,7 @@ "/orgs/{org}/hooks/{hook_id}": { "get": { "summary": "Get an organization webhook", - "description": "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).\"", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15177,7 +15177,7 @@ }, "patch": { "summary": "Update an organization webhook", - "description": "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).\"", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15290,7 +15290,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15326,7 +15326,7 @@ "/orgs/{org}/hooks/{hook_id}/config": { "get": { "summary": "Get a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15369,7 +15369,7 @@ }, "patch": { "summary": "Update a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15449,7 +15449,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries": { "get": { "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15517,7 +15517,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { "get": { "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15571,7 +15571,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an organization webhook", - "description": "Redeliver a delivery for a webhook configured in an organization.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15613,7 +15613,7 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) to be sent to the hook.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 853471dca3..b958d92a7c 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -10829,7 +10829,11 @@ paths: "/orgs/{org}/hooks": get: summary: List organization webhooks - description: '' + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhooks @@ -10864,8 +10868,11 @@ paths: subcategory: webhooks post: summary: Create an organization webhook - description: 'Here''s how you can create a hook that posts payloads in JSON - format:' + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/create-webhook @@ -10961,8 +10968,11 @@ paths: "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook - description: 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)." + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook @@ -10991,11 +11001,11 @@ paths: subcategory: webhooks patch: summary: Update an organization webhook - description: 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)." + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook @@ -11070,7 +11080,11 @@ paths: subcategory: webhooks delete: summary: Delete an organization webhook - description: '' + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/delete-webhook @@ -11093,10 +11107,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for an organization - description: |- - 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. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-config-for-org @@ -11123,10 +11138,11 @@ paths: subcategory: webhooks patch: summary: Update a webhook configuration for an organization - description: |- - 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. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook-config-for-org @@ -11177,8 +11193,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook - description: Returns a list of webhook deliveries for a webhook configured in - an organization. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhook-deliveries @@ -11219,7 +11238,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook - description: Returns a delivery for a webhook configured in an organization. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-delivery @@ -11252,7 +11275,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook - description: Redeliver a delivery for a webhook configured in an organization. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/redeliver-webhook-delivery @@ -11278,8 +11305,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook - description: This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) - to be sent to the hook. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/ping-webhook diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 9af30f23dd..761e303eea 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -14934,7 +14934,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -14991,7 +14991,7 @@ }, "post": { "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15131,7 +15131,7 @@ "/orgs/{org}/hooks/{hook_id}": { "get": { "summary": "Get an organization webhook", - "description": "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).\"", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15177,7 +15177,7 @@ }, "patch": { "summary": "Update an organization webhook", - "description": "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).\"", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15290,7 +15290,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15326,7 +15326,7 @@ "/orgs/{org}/hooks/{hook_id}/config": { "get": { "summary": "Get a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15369,7 +15369,7 @@ }, "patch": { "summary": "Update a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15449,7 +15449,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries": { "get": { "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15517,7 +15517,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { "get": { "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15571,7 +15571,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an organization webhook", - "description": "Redeliver a delivery for a webhook configured in an organization.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15613,7 +15613,7 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) to be sent to the hook.", + "description": "You must be an organization owner or have the \"Manage organization webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit webhooks \nthat they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 853471dca3..b958d92a7c 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -10829,7 +10829,11 @@ paths: "/orgs/{org}/hooks": get: summary: List organization webhooks - description: '' + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhooks @@ -10864,8 +10868,11 @@ paths: subcategory: webhooks post: summary: Create an organization webhook - description: 'Here''s how you can create a hook that posts payloads in JSON - format:' + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/create-webhook @@ -10961,8 +10968,11 @@ paths: "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook - description: 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)." + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook @@ -10991,11 +11001,11 @@ paths: subcategory: webhooks patch: summary: Update an organization webhook - description: 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)." + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook @@ -11070,7 +11080,11 @@ paths: subcategory: webhooks delete: summary: Delete an organization webhook - description: '' + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/delete-webhook @@ -11093,10 +11107,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for an organization - description: |- - 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. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-config-for-org @@ -11123,10 +11138,11 @@ paths: subcategory: webhooks patch: summary: Update a webhook configuration for an organization - description: |- - 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. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook-config-for-org @@ -11177,8 +11193,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook - description: Returns a list of webhook deliveries for a webhook configured in - an organization. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhook-deliveries @@ -11219,7 +11238,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook - description: Returns a delivery for a webhook configured in an organization. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-delivery @@ -11252,7 +11275,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook - description: Redeliver a delivery for a webhook configured in an organization. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/redeliver-webhook-delivery @@ -11278,8 +11305,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook - description: This will trigger a [ping event](https://docs.github.com/enterprise-cloud@latest//webhooks/#ping-event) - to be sent to the hook. + description: "You must be an organization owner or have the \"Manage organization + webhooks\" permission to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or edit webhooks \nthat they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/ping-webhook diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json index 2602bbd374..e484f30162 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json @@ -98131,7 +98131,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98363,7 +98363,7 @@ }, "post": { "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or \nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98757,7 +98757,7 @@ "/orgs/{org}/hooks/{hook_id}": { "get": { "summary": "Get an organization webhook", - "description": "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).\"", + "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98967,7 +98967,7 @@ }, "patch": { "summary": "Update an organization webhook", - "description": "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).\"", + "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -99339,7 +99339,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -99410,7 +99410,7 @@ "/orgs/{org}/hooks/{hook_id}/config": { "get": { "summary": "Get a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -99510,7 +99510,7 @@ }, "patch": { "summary": "Update a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -99671,7 +99671,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries": { "get": { "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -100031,7 +100031,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { "get": { "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.", + "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -100444,7 +100444,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an organization webhook", - "description": "Redeliver a delivery for a webhook configured in an organization.", + "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -100652,7 +100652,7 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) to be sent to the hook.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml index 25139855d4..196eaa0d0e 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml @@ -24745,7 +24745,10 @@ paths: "/orgs/{org}/hooks": get: summary: List organization webhooks - description: '' + description: "You must be an organization owner to use this endpoint. \n\nOAuth + app tokens and personal access tokens (classic) need `admin:org_hook` scope. + OAuth apps cannot list, view, or edit \nwebhooks that they did not create + and users cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhooks @@ -24872,8 +24875,11 @@ paths: subcategory: webhooks post: summary: Create an organization webhook - description: 'Here''s how you can create a hook that posts payloads in JSON - format:' + description: "Create a hook that posts payloads in JSON format.\n\nYou must + be an organization owner to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or \nedit webhooks that they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/create-webhook @@ -24977,8 +24983,12 @@ paths: "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook - description: 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)." + description: "Returns a webhook configured in an organization. To get only the + webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app + tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth + apps cannot list, view, or edit \nwebhooks that they did not create and users + cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook @@ -25004,11 +25014,15 @@ paths: subcategory: webhooks patch: summary: Update an organization webhook - description: 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)." + description: "Updates a webhook configured in an organization. When you update + a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` + set, you must\nprovide the same `secret` or set a new `secret` or the secret + will be removed. If\nyou are only updating individual webhook `config` properties, + use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". + \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app + tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth + apps cannot list, view, or edit \nwebhooks that they did not create and users + cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook @@ -25090,7 +25104,10 @@ paths: subcategory: webhooks delete: summary: Delete an organization webhook - description: '' + description: "You must be an organization owner to use this endpoint. \n\nOAuth + app tokens and personal access tokens (classic) need `admin:org_hook` scope. + OAuth apps cannot list, view, or edit \nwebhooks that they did not create + and users cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/delete-webhook @@ -25112,10 +25129,13 @@ paths: "/orgs/{org}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for an organization - description: |- - 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. + description: "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).\"\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-config-for-org @@ -25140,10 +25160,13 @@ paths: subcategory: webhooks patch: summary: Update a webhook configuration for an organization - description: |- - 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. + description: "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).\"\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook-config-for-org @@ -25188,8 +25211,12 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook - description: Returns a list of webhook deliveries for a webhook configured in - an organization. + description: "Returns a list of webhook deliveries for a webhook configured + in an organization.\n\nYou must be an organization owner to use this endpoint. + \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` + scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not + create and users cannot list, view, or edit webhooks that were created by + OAuth apps." tags: - orgs operationId: orgs/list-webhook-deliveries @@ -25226,7 +25253,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook - description: Returns a delivery for a webhook configured in an organization. + description: "Returns a delivery for a webhook configured in an organization.\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-delivery @@ -25255,7 +25286,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook - description: Redeliver a delivery for a webhook configured in an organization. + description: "Redeliver a delivery for a webhook configured in an organization.\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/redeliver-webhook-delivery @@ -25278,8 +25313,12 @@ paths: "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook - description: This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) - to be sent to the hook. + description: "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event)\nto + be sent to the hook.\n\nYou must be an organization owner to use this endpoint. + \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` + scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not + create and users cannot list, view, or edit webhooks that were created by + OAuth apps." tags: - orgs operationId: orgs/ping-webhook diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.json b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.json index 2602bbd374..e484f30162 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.json +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.json @@ -98131,7 +98131,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98363,7 +98363,7 @@ }, "post": { "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or \nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98757,7 +98757,7 @@ "/orgs/{org}/hooks/{hook_id}": { "get": { "summary": "Get an organization webhook", - "description": "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).\"", + "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -98967,7 +98967,7 @@ }, "patch": { "summary": "Update an organization webhook", - "description": "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).\"", + "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -99339,7 +99339,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -99410,7 +99410,7 @@ "/orgs/{org}/hooks/{hook_id}/config": { "get": { "summary": "Get a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -99510,7 +99510,7 @@ }, "patch": { "summary": "Update a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -99671,7 +99671,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries": { "get": { "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -100031,7 +100031,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { "get": { "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.", + "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -100444,7 +100444,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": { "post": { "summary": "Redeliver a delivery for an organization webhook", - "description": "Redeliver a delivery for a webhook configured in an organization.", + "description": "Redeliver a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -100652,7 +100652,7 @@ "/orgs/{org}/hooks/{hook_id}/pings": { "post": { "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) to be sent to the hook.", + "description": "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event)\nto be sent to the hook.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.yaml b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.yaml index 25139855d4..196eaa0d0e 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.yaml +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.yaml @@ -24745,7 +24745,10 @@ paths: "/orgs/{org}/hooks": get: summary: List organization webhooks - description: '' + description: "You must be an organization owner to use this endpoint. \n\nOAuth + app tokens and personal access tokens (classic) need `admin:org_hook` scope. + OAuth apps cannot list, view, or edit \nwebhooks that they did not create + and users cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/list-webhooks @@ -24872,8 +24875,11 @@ paths: subcategory: webhooks post: summary: Create an organization webhook - description: 'Here''s how you can create a hook that posts payloads in JSON - format:' + description: "Create a hook that posts payloads in JSON format.\n\nYou must + be an organization owner to use this endpoint. \n\nOAuth app tokens and personal + access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, + view, or \nedit webhooks that they did not create and users cannot list, view, + or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/create-webhook @@ -24977,8 +24983,12 @@ paths: "/orgs/{org}/hooks/{hook_id}": get: summary: Get an organization webhook - description: 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)." + description: "Returns a webhook configured in an organization. To get only the + webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). + \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app + tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth + apps cannot list, view, or edit \nwebhooks that they did not create and users + cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook @@ -25004,11 +25014,15 @@ paths: subcategory: webhooks patch: summary: Update an organization webhook - description: 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)." + description: "Updates a webhook configured in an organization. When you update + a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` + set, you must\nprovide the same `secret` or set a new `secret` or the secret + will be removed. If\nyou are only updating individual webhook `config` properties, + use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". + \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app + tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth + apps cannot list, view, or edit \nwebhooks that they did not create and users + cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook @@ -25090,7 +25104,10 @@ paths: subcategory: webhooks delete: summary: Delete an organization webhook - description: '' + description: "You must be an organization owner to use this endpoint. \n\nOAuth + app tokens and personal access tokens (classic) need `admin:org_hook` scope. + OAuth apps cannot list, view, or edit \nwebhooks that they did not create + and users cannot list, view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/delete-webhook @@ -25112,10 +25129,13 @@ paths: "/orgs/{org}/hooks/{hook_id}/config": get: summary: Get a webhook configuration for an organization - description: |- - 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. + description: "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).\"\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-config-for-org @@ -25140,10 +25160,13 @@ paths: subcategory: webhooks patch: summary: Update a webhook configuration for an organization - description: |- - 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. + description: "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).\"\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/update-webhook-config-for-org @@ -25188,8 +25211,12 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries": get: summary: List deliveries for an organization webhook - description: Returns a list of webhook deliveries for a webhook configured in - an organization. + description: "Returns a list of webhook deliveries for a webhook configured + in an organization.\n\nYou must be an organization owner to use this endpoint. + \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` + scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not + create and users cannot list, view, or edit webhooks that were created by + OAuth apps." tags: - orgs operationId: orgs/list-webhook-deliveries @@ -25226,7 +25253,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": get: summary: Get a webhook delivery for an organization webhook - description: Returns a delivery for a webhook configured in an organization. + description: "Returns a delivery for a webhook configured in an organization.\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/get-webhook-delivery @@ -25255,7 +25286,11 @@ paths: "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": post: summary: Redeliver a delivery for an organization webhook - description: Redeliver a delivery for a webhook configured in an organization. + description: "Redeliver a delivery for a webhook configured in an organization.\n\nYou + must be an organization owner to use this endpoint. \n\nOAuth app tokens and + personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot + list, view, or edit \nwebhooks that they did not create and users cannot list, + view, or edit webhooks that were created by OAuth apps." tags: - orgs operationId: orgs/redeliver-webhook-delivery @@ -25278,8 +25313,12 @@ paths: "/orgs/{org}/hooks/{hook_id}/pings": post: summary: Ping an organization webhook - description: This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event) - to be sent to the hook. + description: "This will trigger a [ping event](https://docs.github.com/enterprise-server@3.10/webhooks/#ping-event)\nto + be sent to the hook.\n\nYou must be an organization owner to use this endpoint. + \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` + scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not + create and users cannot list, view, or edit webhooks that were created by + OAuth apps." tags: - orgs operationId: orgs/ping-webhook diff --git a/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.json b/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.json index c69dfa2595..b22355d38c 100644 --- a/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.json +++ b/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.json @@ -15471,7 +15471,7 @@ "/orgs/{org}/hooks": { "get": { "summary": "List organization webhooks", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15528,7 +15528,7 @@ }, "post": { "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "description": "Create a hook that posts payloads in JSON format.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or \nedit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15668,7 +15668,7 @@ "/orgs/{org}/hooks/{hook_id}": { "get": { "summary": "Get an organization webhook", - "description": "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).\"", + "description": "Returns a webhook configured in an organization. To get only the webhook\n`config` properties, see \"[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization). \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15714,7 +15714,7 @@ }, "patch": { "summary": "Update an organization webhook", - "description": "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).\"", + "description": "Updates a webhook configured in an organization. When you update a webhook,\nthe `secret` will be overwritten. If you previously had a `secret` set, you must\nprovide the same `secret` or set a new `secret` or the secret will be removed. If\nyou are only updating individual webhook `config` properties, use \"[Update a webhook\nconfiguration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)\". \n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15827,7 +15827,7 @@ }, "delete": { "summary": "Delete an organization webhook", - "description": "", + "description": "You must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15863,7 +15863,7 @@ "/orgs/{org}/hooks/{hook_id}/config": { "get": { "summary": "Get a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15906,7 +15906,7 @@ }, "patch": { "summary": "Update a webhook configuration for an organization", - "description": "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).\"\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.", + "description": "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).\"\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -15986,7 +15986,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries": { "get": { "summary": "List deliveries for an organization webhook", - "description": "Returns a list of webhook deliveries for a webhook configured in an organization.", + "description": "Returns a list of webhook deliveries for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit \nwebhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.", "tags": [ "orgs" ], @@ -16054,7 +16054,7 @@ "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": { "get": { "summary": "Get a webhook delivery for an organization webhook", - "description": "Returns a delivery for a webhook configured in an organization.", + "description": "Returns a delivery for a webhook configured in an organization.\n\nYou must be an organization owner to use this endpoint. \n\nOAuth app tokens and personal access tokens (classic) need `admin:org_hook` {"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}