Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Updates @octokit/types 13.1.0, updates docs #727

Merged
merged 2 commits into from
Apr 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions docs/actions/listWorkflowRunsForRepo.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,6 @@ Anyone with read access to the repository can use this endpoint.

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

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`.

```js
octokit.rest.actions.listWorkflowRunsForRepo({
owner,
Expand Down
7 changes: 1 addition & 6 deletions docs/orgs/createWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,7 @@ type: API method

# Create an organization webhook

Create a hook that posts payloads in JSON format.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or
edit webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
Here's how you can create a hook that posts payloads in JSON format:

```js
octokit.rest.orgs.createWebhook({
Expand Down
5 changes: 0 additions & 5 deletions docs/orgs/deleteWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ type: API method

# Delete an organization webhook

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.deleteWebhook({
org,
Expand Down
11 changes: 11 additions & 0 deletions docs/orgs/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,17 @@ When the value of `two_factor_requirement_enabled` is `true`, the organization r

To see the full details about an organization, the authenticated user must be an organization owner.

The values returned by this endpoint are set by the "Update an organization" endpoint. If your organization set a default security configuration (beta), the following values retrieved from the "Update an organization" endpoint have been overwritten by that configuration:

- advanced_security_enabled_for_new_repositories
- dependabot_alerts_enabled_for_new_repositories
- dependabot_security_updates_enabled_for_new_repositories
- dependency_graph_enabled_for_new_repositories
- secret_scanning_enabled_for_new_repositories
- secret_scanning_push_protection_enabled_for_new_repositories

For more information on security configurations, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)."

OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to see the full details about an organization.

To see information about an organization's GitHub plan, GitHub Apps need the `Organization plan` permission.
Expand Down
8 changes: 1 addition & 7 deletions docs/orgs/getWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,7 @@ type: API method

# Get an organization webhook

Returns a webhook configured in an organization. To get only the webhook
`config` properties, see "[Get a webhook configuration for an organization](/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization).

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
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)."

```js
octokit.rest.orgs.getWebhook({
Expand Down
5 changes: 1 addition & 4 deletions docs/orgs/getWebhookConfigForOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,7 @@ type: API method

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

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.

```js
octokit.rest.orgs.getWebhookConfigForOrg({
Expand Down
5 changes: 0 additions & 5 deletions docs/orgs/getWebhookDelivery.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ type: API method

Returns a delivery for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.getWebhookDelivery({
org,
Expand Down
5 changes: 0 additions & 5 deletions docs/orgs/listWebhookDeliveries.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ type: API method

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

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.listWebhookDeliveries({
org,
Expand Down
5 changes: 0 additions & 5 deletions docs/orgs/listWebhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@ type: API method

# List organization webhooks

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.listWebhooks({
org,
Expand Down
8 changes: 1 addition & 7 deletions docs/orgs/pingWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,7 @@ type: API method

# Ping an organization webhook

This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event)
to be sent to the hook.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
This will trigger a [ping event](https://docs.github.com/webhooks/#ping-event) to be sent to the hook.

```js
octokit.rest.orgs.pingWebhook({
Expand Down
5 changes: 0 additions & 5 deletions docs/orgs/redeliverWebhookDelivery.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,6 @@ type: API method

Redeliver a delivery for a webhook configured in an organization.

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.

```js
octokit.rest.orgs.redeliverWebhookDelivery({
org,
Expand Down
13 changes: 12 additions & 1 deletion docs/orgs/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,17 @@ type: API method

Updates the organization's profile and member privileges.

With security configurations (beta), your organization can choose a default security configuration which will automatically apply a set of security enablement settings to new repositories in your organization based on their visibility. For targeted repositories, the following attributes will be overridden by the default security configuration:

- advanced_security_enabled_for_new_repositories
- dependabot_alerts_enabled_for_new_repositories
- dependabot_security_updates_enabled_for_new_repositories
- dependency_graph_enabled_for_new_repositories
- secret_scanning_enabled_for_new_repositories
- secret_scanning_push_protection_enabled_for_new_repositories

For more information on setting a default security configuration, see "[Enabling security features at scale](https://docs.github.com/code-security/securing-your-organization/introduction-to-securing-your-organization-at-scale/about-enabling-security-features-at-scale)."

The authenticated user must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.
Expand Down Expand Up @@ -70,7 +81,7 @@ The shorthand name of the company.
</td></tr>
<tr><td>description</td><td>no</td><td>

The description of the company.
The description of the company. The maximum size is 160 characters.

</td></tr>
<tr><td>has_organization_projects</td><td>no</td><td>
Expand Down
11 changes: 1 addition & 10 deletions docs/orgs/updateWebhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,7 @@ type: API method

# Update an organization webhook

Updates a webhook configured in an organization. When you update a webhook,
the `secret` will be overwritten. If you previously had a `secret` set, you must
provide the same `secret` or set a new `secret` or the secret will be removed. If
you are only updating individual webhook `config` properties, use "[Update a webhook
configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)".

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
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)."

```js
octokit.rest.orgs.updateWebhook({
Expand Down
5 changes: 1 addition & 4 deletions docs/orgs/updateWebhookConfigForOrg.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,7 @@ type: API method

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

You must be an organization owner to use this endpoint.

OAuth app tokens and personal access tokens (classic) need `admin:org_hook` scope. OAuth apps cannot list, view, or edit
webhooks that they did not create and users cannot list, view, or edit webhooks that were created by OAuth apps.
OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.

```js
octokit.rest.orgs.updateWebhookConfigForOrg({
Expand Down
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"author": "Gregor Martynus (https://twitter.com/gr2m)",
"license": "MIT",
"dependencies": {
"@octokit/types": "^13.0.0"
"@octokit/types": "^13.1.0"
},
"devDependencies": {
"@octokit/core": "^6.0.0",
Expand Down
Loading