Skip to content

Commit 4c8810a

Browse files
authored
fix(docs): update information on methods (#728)
1 parent 2b971b4 commit 4c8810a

16 files changed

+168
-47
lines changed

docs/actions/listWorkflowRunsForRepo.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Anyone with read access to the repository can use this endpoint.
1414

1515
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.
1616

17+
This API will return up to 1,000 results for each search when using the following parameters: `actor`, `branch`, `check_suite_id`, `created`, `event`, `head_sha`, `status`.
18+
1719
```js
1820
octokit.rest.actions.listWorkflowRunsForRepo({
1921
owner,

docs/orgs/createWebhook.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@ type: API method
88

99
# Create an organization webhook
1010

11-
Here's how you can create a hook that posts payloads in JSON format:
11+
Create a hook that posts payloads in JSON format.
12+
13+
You must be an organization owner to use this endpoint.
14+
15+
OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or
16+
edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
1217

1318
```js
1419
octokit.rest.orgs.createWebhook({

docs/orgs/deleteWebhook.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ type: API method
88

99
# Delete an organization webhook
1010

11+
You must be an organization owner to use this endpoint.
12+
13+
OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
14+
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
15+
1116
```js
1217
octokit.rest.orgs.deleteWebhook({
1318
org,

docs/orgs/getWebhook.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,13 @@ type: API method
88

99
# Get an organization webhook
1010

11-
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)."
11+
Returns a webhook configured in an organization. To get only the webhook
12+
`config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).
13+
14+
You must be an organization owner to use this endpoint.
15+
16+
OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
17+
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
1218

1319
```js
1420
octokit.rest.orgs.getWebhook({

docs/orgs/getWebhookConfigForOrg.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ type: API method
1010

1111
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)."
1212

13-
OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.
13+
You must be an organization owner to use this endpoint.
14+
15+
OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
16+
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
1417

1518
```js
1619
octokit.rest.orgs.getWebhookConfigForOrg({

docs/orgs/getWebhookDelivery.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ type: API method
1010

1111
Returns a delivery for a webhook configured in an organization.
1212

13+
You must be an organization owner to use this endpoint.
14+
15+
OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
16+
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
17+
1318
```js
1419
octokit.rest.orgs.getWebhookDelivery({
1520
org,

docs/orgs/listWebhookDeliveries.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ type: API method
1010

1111
Returns a list of webhook deliveries for a webhook configured in an organization.
1212

13+
You must be an organization owner to use this endpoint.
14+
15+
OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
16+
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
17+
1318
```js
1419
octokit.rest.orgs.listWebhookDeliveries({
1520
org,

docs/orgs/listWebhooks.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ type: API method
88

99
# List organization webhooks
1010

11+
You must be an organization owner to use this endpoint.
12+
13+
OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
14+
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
15+
1116
```js
1217
octokit.rest.orgs.listWebhooks({
1318
org,

docs/orgs/pingWebhook.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,13 @@ type: API method
88

99
# Ping an organization webhook
1010

11-
This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.
11+
This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)
12+
to be sent to the hook.
13+
14+
You must be an organization owner to use this endpoint.
15+
16+
OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
17+
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
1218

1319
```js
1420
octokit.rest.orgs.pingWebhook({

docs/orgs/redeliverWebhookDelivery.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ type: API method
1010

1111
Redeliver a delivery for a webhook configured in an organization.
1212

13+
You must be an organization owner to use this endpoint.
14+
15+
OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
16+
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
17+
1318
```js
1419
octokit.rest.orgs.redeliverWebhookDelivery({
1520
org,

0 commit comments

Comments
 (0)