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

* WIP octokit/openapi updated * WIP octokit/openapi updated
octokit · Apr 5, 2024 · 2b971b4 · 2b971b4
1 parent 1138da0
commit 2b971b4
Show file tree

Hide file tree

Showing 18 changed files with 89 additions and 166 deletions.
diff --git a/docs/actions/listWorkflowRunsForRepo.md b/docs/actions/listWorkflowRunsForRepo.md
@@ -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,

diff --git a/docs/orgs/createWebhook.md b/docs/orgs/createWebhook.md
@@ -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({

diff --git a/docs/orgs/deleteWebhook.md b/docs/orgs/deleteWebhook.md
@@ -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,

diff --git a/docs/orgs/get.md b/docs/orgs/get.md
@@ -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.

diff --git a/docs/orgs/getWebhook.md b/docs/orgs/getWebhook.md
@@ -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({

diff --git a/docs/orgs/getWebhookConfigForOrg.md b/docs/orgs/getWebhookConfigForOrg.md
@@ -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({

diff --git a/docs/orgs/getWebhookDelivery.md b/docs/orgs/getWebhookDelivery.md
@@ -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,

diff --git a/docs/orgs/listWebhookDeliveries.md b/docs/orgs/listWebhookDeliveries.md
@@ -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,

diff --git a/docs/orgs/listWebhooks.md b/docs/orgs/listWebhooks.md
@@ -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,

diff --git a/docs/orgs/pingWebhook.md b/docs/orgs/pingWebhook.md
@@ -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({

diff --git a/docs/orgs/redeliverWebhookDelivery.md b/docs/orgs/redeliverWebhookDelivery.md
@@ -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,

diff --git a/docs/orgs/update.md b/docs/orgs/update.md
@@ -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.
@@ -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>

diff --git a/docs/orgs/updateWebhook.md b/docs/orgs/updateWebhook.md
@@ -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({

diff --git a/docs/orgs/updateWebhookConfigForOrg.md b/docs/orgs/updateWebhookConfigForOrg.md
@@ -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({

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -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",