@octokit/openapi 16.2.0 → 16.4.0

package/generated/ghec.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "16.2.0",
+    "version": "16.4.0",
     "title": "GitHub's official OpenAPI spec + Octokit extension",
     "description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
     "license": {
@@ -786,6 +786,7 @@
                         "description": "The products and respective version ranges affected by the advisory.",
                         "nullable": true,
                         "items": {
+                          "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.",
                           "type": "object",
                           "properties": {
                             "package": {
@@ -830,7 +831,7 @@
                             },
                             "first_patched_version": {
                               "type": "string",
-                              "description": "The package version that resolve the vulnerability.",
+                              "description": "The package version that resolves the vulnerability.",
                               "nullable": true
                             },
                             "vulnerable_functions": {
@@ -1398,6 +1399,7 @@
                       "description": "The products and respective version ranges affected by the advisory.",
                       "nullable": true,
                       "items": {
+                        "description": "A vulnerability describing the product and its affected versions within a GitHub Security Advisory.",
                         "type": "object",
                         "properties": {
                           "package": {
@@ -1442,7 +1444,7 @@
                           },
                           "first_patched_version": {
                             "type": "string",
-                            "description": "The package version that resolve the vulnerability.",
+                            "description": "The package version that resolves the vulnerability.",
                             "nullable": true
                           },
                           "vulnerable_functions": {
@@ -5894,7 +5896,7 @@
     "/app/installations/{installation_id}/access_tokens": {
       "post": {
         "summary": "Create an installation access token for an app",
-        "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access. \n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported. \n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
+        "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token. By default the installation token has access to all repositories that the installation can access.\n\nOptionally, you can use the `repositories` or `repository_ids` body parameters to specify individual repositories that the installation access token can access. If you don't use `repositories` or `repository_ids` to grant access to specific repositories, the installation access token will have access to all repositories that the installation was granted access to. The installation access token cannot be granted access to repositories that the installation was not granted access to. Up to 500 repositories can be listed in this manner.\n\nOptionally, use the `permissions` body parameter to specify the permissions that the installation access token should have. If `permissions` is not specified, the installation access token will have all of the permissions that were granted to the app. The installation access token cannot be granted permissions that the app was not granted.\n\nWhen using the repository or permission parameters to reduce the access of the token, the complexity of the token is increased due to both the number of permissions in the request and the number of repositories the token will have access to. If the complexity is too large, the token will fail to be issued. If this occurs, the error message will indicate the maximum number of repositories that should be requested. For the average application requesting 8 permissions, this limit is around 5000 repositories. With fewer permissions requested, more repositories are supported.\n\nYou must use a [JWT](https://docs.github.com/enterprise-cloud@latest//apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
         "tags": [
           "apps"
         ],
@@ -84118,7 +84120,7 @@
     "/orgs/{org}/hooks": {
       "get": {
         "summary": "List organization webhooks",
-        "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.",
+        "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"
         ],
@@ -84327,7 +84329,7 @@
       },
       "post": {
         "summary": "Create an organization webhook",
-        "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.",
+        "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"
         ],
@@ -84680,7 +84682,7 @@
     "/orgs/{org}/hooks/{hook_id}": {
       "get": {
         "summary": "Get an organization webhook",
-        "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.",
+        "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"
         ],
@@ -84867,7 +84869,7 @@
       },
       "patch": {
         "summary": "Update an organization webhook",
-        "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.",
+        "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"
         ],
@@ -85200,7 +85202,7 @@
       },
       "delete": {
         "summary": "Delete an organization webhook",
-        "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.",
+        "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"
         ],
@@ -85272,7 +85274,7 @@
     "/orgs/{org}/hooks/{hook_id}/config": {
       "get": {
         "summary": "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.",
+        "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"
         ],
@@ -85365,7 +85367,7 @@
       },
       "patch": {
         "summary": "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.",
+        "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"
         ],
@@ -85511,7 +85513,7 @@
     "/orgs/{org}/hooks/{hook_id}/deliveries": {
       "get": {
         "summary": "List deliveries for an organization webhook",
-        "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.",
+        "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"
         ],
@@ -85830,7 +85832,7 @@
     "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}": {
       "get": {
         "summary": "Get a webhook delivery for an organization webhook",
-        "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.",
+        "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"
         ],
@@ -86192,7 +86194,7 @@
     "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts": {
       "post": {
         "summary": "Redeliver a delivery for an organization webhook",
-        "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.",
+        "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"
         ],
@@ -86387,7 +86389,7 @@
     "/orgs/{org}/hooks/{hook_id}/pings": {
       "post": {
         "summary": "Ping an organization webhook",
-        "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.",
+        "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"
         ],