@octokit/openapi 14.1.0 → 15.0.0

package/generated/api.github.com.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "14.1.0",
+    "version": "15.0.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": {
@@ -261,21 +261,7 @@
             "in": "query",
             "description": "If specified, only advisories for these ecosystems will be returned.",
             "schema": {
-              "type": "string",
-              "enum": [
-                "actions",
-                "composer",
-                "erlang",
-                "go",
-                "maven",
-                "npm",
-                "nuget",
-                "other",
-                "pip",
-                "pub",
-                "rubygems",
-                "rust"
-              ]
+              "$ref": "#/components/schemas/security-advisory-ecosystems"
             }
           },
           {
@@ -11199,7 +11185,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"
         ],
@@ -11257,7 +11243,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"
         ],
@@ -11394,7 +11380,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"
         ],
@@ -11441,7 +11427,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"
         ],
@@ -11553,7 +11539,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"
         ],
@@ -11590,7 +11576,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"
         ],
@@ -11634,7 +11620,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"
         ],
@@ -11715,7 +11701,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"
         ],
@@ -11784,7 +11770,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"
         ],
@@ -11839,7 +11825,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"
         ],
@@ -11882,7 +11868,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"
         ],
@@ -24204,7 +24190,7 @@
     "/repos/{owner}/{repo}/actions/runs": {
       "get": {
         "summary": "List workflow runs for a repository",
-        "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.",
+        "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/rest/guides/getting-started-with-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with a private repository.\n\nThis 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`.",
         "tags": [
           "actions"
         ],
@@ -36623,6 +36609,9 @@
           "204": {
             "description": "Response"
           },
+          "404": {
+            "$ref": "#/components/responses/not_found"
+          },
           "422": {
             "$ref": "#/components/responses/validation_failed"
           }
@@ -47202,6 +47191,9 @@
           "404": {
             "$ref": "#/components/responses/not_found"
           },
+          "406": {
+            "$ref": "#/components/responses/unacceptable"
+          },
           "500": {
             "$ref": "#/components/responses/internal_error"
           },
@@ -83280,8 +83272,7 @@
     },
     "repository-dispatch-sample.collected": {
       "post": {
-        "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
-        "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.",
+        "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.",
         "operationId": "repository-dispatch/sample.collected",
         "externalDocs": {
           "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch"
@@ -87888,7 +87879,8 @@
           },
           "hub_url": {
             "type": "string",
-            "format": "uri-template"
+            "format": "uri-template",
+            "deprecated": true
           },
           "issue_search_url": {
             "type": "string",
@@ -87984,7 +87976,6 @@
           "followers_url",
           "following_url",
           "gists_url",
-          "hub_url",
           "issue_search_url",
           "issues_url",
           "keys_url",
@@ -100040,12 +100031,12 @@
           }
         }
       },
-      "repository-rule-params-thresholds": {
-        "title": "Thresholds",
-        "description": "This setting will not take effect unless at least one code scanning status check is enabled.",
+      "repository-rule-params-code-scanning-threshold": {
+        "title": "CodeScanningThreshold",
+        "description": "A tool and its thresholds.",
         "type": "object",
         "properties": {
-          "code_scanning_alert_threshold": {
+          "alerts": {
             "type": "string",
             "description": "Code scanning alert threshold",
             "enum": [
@@ -100055,7 +100046,7 @@
               "all"
             ]
           },
-          "code_scanning_security_alert_threshold": {
+          "security_alerts": {
             "type": "string",
             "description": "Code scanning security alert threshold.",
             "enum": [
@@ -100065,11 +100056,16 @@
               "medium_or_higher",
               "all"
             ]
+          },
+          "tool": {
+            "type": "string",
+            "description": "The name of a code scanning tool"
           }
         },
         "required": [
-          "code_scanning_alert_threshold",
-          "code_scanning_security_alert_threshold"
+          "alerts",
+          "security_alerts",
+          "tool"
         ]
       },
       "repository-rule": {
@@ -115792,6 +115788,64 @@
           "commit_url"
         ]
       },
+      "secret-scanning-location-wiki-commit": {
+        "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.",
+        "type": "object",
+        "properties": {
+          "path": {
+            "type": "string",
+            "description": "The file path of the wiki page",
+            "example": "/example/Home.md"
+          },
+          "start_line": {
+            "type": "number",
+            "description": "Line number at which the secret starts in the file"
+          },
+          "end_line": {
+            "type": "number",
+            "description": "Line number at which the secret ends in the file"
+          },
+          "start_column": {
+            "type": "number",
+            "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII."
+          },
+          "end_column": {
+            "type": "number",
+            "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII."
+          },
+          "blob_sha": {
+            "type": "string",
+            "description": "SHA-1 hash ID of the associated blob",
+            "example": "af5626b4a114abcb82d63db7c8082c3c4756e51b"
+          },
+          "page_url": {
+            "type": "string",
+            "description": "The GitHub URL to get the associated wiki page",
+            "example": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
+          },
+          "commit_sha": {
+            "type": "string",
+            "description": "SHA-1 hash ID of the associated commit",
+            "example": "302c0b7e200761c9dd9b57e57db540ee0b4293a5"
+          },
+          "commit_url": {
+            "type": "string",
+            "description": "The GitHub URL to get the associated wiki commit",
+            "example": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
+          }
+        },
+        "required": [
+          "path",
+          "start_line",
+          "end_line",
+          "start_column",
+          "end_column",
+          "blob_sha",
+          "page_url",
+          "commit_sha",
+          "commit_url"
+        ]
+      },
       "secret-scanning-location-issue-title": {
         "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.",
         "type": "object",
@@ -115964,6 +116018,7 @@
             "type": "string",
             "enum": [
               "commit",
+              "wiki_commit",
               "issue_title",
               "issue_body",
               "issue_comment",
@@ -115984,6 +116039,9 @@
               {
                 "$ref": "#/components/schemas/secret-scanning-location-commit"
               },
+              {
+                "$ref": "#/components/schemas/secret-scanning-location-wiki-commit"
+              },
               {
                 "$ref": "#/components/schemas/secret-scanning-location-issue-title"
               },
@@ -116019,11 +116077,7 @@
               }
             ]
           }
-        },
-        "required": [
-          "type",
-          "details"
-        ]
+        }
       },
       "repository-advisory-create": {
         "type": "object",
@@ -262955,9 +263009,7 @@
         "properties": {
           "action": {
             "type": "string",
-            "enum": [
-              "sample.collected"
-            ]
+            "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
           },
           "branch": {
             "type": "string"
@@ -262965,7 +263017,8 @@
           "client_payload": {
             "type": "object",
             "nullable": true,
-            "additionalProperties": true
+            "additionalProperties": true,
+            "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body."
           },
           "enterprise": {
             "$ref": "#/components/schemas/enterprise-webhooks"
@@ -301533,6 +301586,20 @@
               "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
             }
           },
+          {
+            "type": "wiki_commit",
+            "details": {
+              "path": "/example/Home.md",
+              "start_line": 1,
+              "end_line": 1,
+              "start_column": 1,
+              "end_column": 64,
+              "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b",
+              "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5",
+              "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5",
+              "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5"
+            }
+          },
           {
             "type": "issue_title",
             "details": {
@@ -310086,6 +310153,16 @@
             }
           }
         }
+      },
+      "unacceptable": {
+        "description": "Unacceptable",
+        "content": {
+          "application/json": {
+            "schema": {
+              "$ref": "#/components/schemas/basic-error"
+            }
+          }
+        }
       }
     },
     "headers": {