@octokit/openapi 6.2.1 → 6.4.0

package/generated/ghes-3.4.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.2.1",
+    "version": "6.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -55064,7 +55064,7 @@
         "operationId": "actions/create-or-update-org-secret",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/actions#create-or-update-an-organization-secret"
+          "url": "https://docs.github.com/rest/reference/actions#create-or-update-an-organization-secret"
         },
         "parameters": [
           {
@@ -55091,7 +55091,7 @@
                 "properties": {
                   "encrypted_value": {
                     "type": "string",
-                    "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#get-an-organization-public-key) endpoint.",
+                    "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint.",
                     "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
                   },
                   "key_id": {
@@ -55105,8 +55105,10 @@
                   },
                   "selected_repository_ids": {
                     "type": "array",
-                    "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
-                    "items": { "type": "string" }
+                    "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
+                    "items": {
+                      "anyOf": [{ "type": "integer" }, { "type": "string" }]
+                    }
                   }
                 },
                 "required": ["visibility"]
@@ -55117,7 +55119,7 @@
                     "encrypted_value": "c2VjcmV0",
                     "key_id": "012345678912345678",
                     "visibility": "selected",
-                    "selected_repository_ids": ["1296269", "1296280"]
+                    "selected_repository_ids": [1296269, 1296280]
                   }
                 }
               }
@@ -57386,7 +57388,7 @@
         "operationId": "dependabot/create-or-update-org-secret",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#create-or-update-an-organization-secret"
+          "url": "https://docs.github.com/rest/reference/dependabot#create-or-update-an-organization-secret"
         },
         "parameters": [
           {
@@ -57413,7 +57415,7 @@
                 "properties": {
                   "encrypted_value": {
                     "type": "string",
-                    "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#get-an-organization-public-key) endpoint.",
+                    "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/dependabot#get-an-organization-public-key) endpoint.",
                     "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$"
                   },
                   "key_id": {
@@ -57427,8 +57429,10 @@
                   },
                   "selected_repository_ids": {
                     "type": "array",
-                    "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.4/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.",
-                    "items": { "type": "string" }
+                    "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/rest/reference/dependabot#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/rest/reference/dependabot#remove-selected-repository-from-an-organization-secret) endpoints.",
+                    "items": {
+                      "anyOf": [{ "type": "string" }, { "type": "integer" }]
+                    }
                   }
                 },
                 "required": ["visibility"]
@@ -117245,7 +117249,7 @@
                   },
                   "url_template": {
                     "type": "string",
-                    "description": "The URL must contain <num> for the reference number."
+                    "description": "The URL must contain `<num>` for the reference number."
                   }
                 },
                 "required": ["key_prefix", "url_template"]
@@ -145439,7 +145443,7 @@
         "operationId": "code-scanning/list-alerts-for-repo",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository"
+          "url": "https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository"
         },
         "parameters": [
           {
@@ -145512,13 +145516,13 @@
           },
           {
             "name": "sort",
-            "description": "The property by which to sort the results.",
+            "description": "The property by which to sort the results. `number` is deprecated - we recommend that you use `created` instead.",
             "in": "query",
             "required": false,
             "schema": {
               "type": "string",
-              "enum": ["created", "updated", "number"],
-              "default": "number"
+              "enum": ["created", "number", "updated"],
+              "default": "created"
             }
           },
           {
@@ -145711,6 +145715,12 @@
                           "used in tests"
                         ]
                       },
+                      "dismissed_comment": {
+                        "type": "string",
+                        "description": "The dismissal comment associated with the dismissal of the alert.",
+                        "nullable": true,
+                        "maxLength": 280
+                      },
                       "rule": {
                         "type": "object",
                         "properties": {
@@ -145843,6 +145853,7 @@
                         "dismissed_by": null,
                         "dismissed_at": null,
                         "dismissed_reason": null,
+                        "dismissed_comment": null,
                         "rule": {
                           "id": "js/zipslip",
                           "severity": "error",
@@ -145904,6 +145915,7 @@
                         },
                         "dismissed_at": "2020-02-14T12:29:18Z",
                         "dismissed_reason": "false positive",
+                        "dismissed_comment": "This alert is not actually correct, because there's a sanitizer included in the library.",
                         "rule": {
                           "id": "js/zipslip",
                           "severity": "error",
@@ -147578,7 +147590,6 @@
           "200": {
             "description": "Response",
             "content": {
-              "application/json+sarif": { "schema": { "type": "string" } },
               "application/json": {
                 "schema": {
                   "type": "object",
@@ -147684,7 +147695,7 @@
                 },
                 "examples": {
                   "response": {
-                    "summary": "Default response",
+                    "summary": "application/json response",
                     "value": {
                       "ref": "refs/heads/main",
                       "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655",
@@ -147708,6 +147719,54 @@
                     }
                   }
                 }
+              },
+              "application/json+sarif": {
+                "schema": { "type": "object", "additionalProperties": true },
+                "examples": {
+                  "response": {
+                    "summary": "application/json+sarif response",
+                    "value": {
+                      "runs": [
+                        {
+                          "tool": {
+                            "driver": {
+                              "name": "CodeQL",
+                              "organization": "GitHub",
+                              "semanticVersion": "1.0.0",
+                              "rules": [
+                                {
+                                  "id": "js/unused-local-variable",
+                                  "name": "js/unused-local-variable"
+                                }
+                              ]
+                            }
+                          },
+                          "results": [
+                            {
+                              "guid": "326aa09f-9af8-13cf-9851-3d0e5183ec38",
+                              "message": { "text": "Unused variable foo." },
+                              "locations": [
+                                {
+                                  "physicalLocation": {
+                                    "artifactLocation": { "uri": "file1.js" },
+                                    "region": { "startLine": 1 }
+                                  }
+                                }
+                              ],
+                              "ruleId": "js/unused-local-variable",
+                              "properties": [
+                                { "github/alertNumber": 2 },
+                                {
+                                  "github/alertUrl": "https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2"
+                                }
+                              ]
+                            }
+                          ]
+                        }
+                      ]
+                    }
+                  }
+                }
               }
             }
           },
@@ -148009,6 +148068,15 @@
                   }
                 },
                 "required": ["commit_sha", "ref", "sarif"]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "commit_sha": "4b6472266afd7b471e86085a6659e8c7f2b119da",
+                    "ref": "refs/heads/master",
+                    "sarif": "H4sICMLGdF4AA2V4YW1wbGUuc2FyaWYAvVjdbts2FL7PUxDCijaA/CM7iRNfLkPXYgHSNstumlzQ0pHFVCI1korjFgH2ONtr7Ul2KFmy/mOn6QIkjsjDw0/nfN85NL8dEGL9pNwAImqRObECrWM1H40kXQ2XTAfJIlEgXcE1cD10RTQSVDE10K4aKSqZP1AxuKOIKg1ydJU60jSfSh8Hk6EzHA/vlOCWbfa7B6kYPpj90rlsWCZcmbHP5Bs+4oAWIjQD2SMOeJLh2vIQDnIaQerqXHjw8YIgxohybxAyDsS4cAPKsp03K4RcUs6+Up2D+JXpd8mibKIQN9fM/aMCdbyBujGSSQgVxJtx5qX2d2qUcIweQhEuDQf3GBO6CKHkogx/N3MVCKl/AeVKFuf4y5ubsMGDTj1ep+5I7sgmLIpxtU38hLtmMRGSuCFVyip5eKzs5ydh+LztVL6f2m6oih1BkYiuyQIIJWodxVpERPj4sEiWBNNH8EWT0DMG8EAjzKVHXCrB4FkPu/F64NMk1OeC+2yZSNoBOoR7CC0EzYWGbm+xFDFIzbI011+cLjfZtyJkmMZfumAh02uL3NpV2y+MZ6RAjxibyKrNxxJcVjANSb4eBGwZ1M0KsuyR2poLr5rMl8vaDSeVn6eTWEO2j2xIEcmhwlTKNOi4GMOI8gfuZYkvJ7b4v5Tiumyz7RnHeodFzpS8ASIZCH/AYdWi2z3sG8JtFxJ6fF9yR9CdifBr9Pd6d5V2+zbJKjjCFGGmsHuYFy2ytJq9tUxcLSRSQecppOGKrpUxYfxefMEFK+wOGa4hudQByBVT0L+EKtyACxnRsABhEx1QjVDs1KNI9MbpnhqfE45B6FJvu3hRu5VRU9MhZLmK7fqkKyQSTHNoyMqUFMqXCV3CwAeqEwmVokraK8IuBaGvHjQ0gMYrKjnjyw7uk9uD8tgmsBbFMPnU1bV2ZhkJNkuolUiWys3UPWzs5aaIUz9TBe8zMb+6+nT+6fLy91dlE3xzeDDT4zYszb0bW6NjJd0Rvn2EnLvWLFSdKPpBzInzfRgu8ETyMcH8nIfMnJCeC2PyfTA+UKngcnGH7Hw2hGkVQs5YlIRCtdWZYQ4/73es2JlxkfViOEIhoWJq5Oo6UBBfiKIqFBWhiE3jJGbFwVoxBHTRSuIS67sMeplei24X20shLjG+8gqbKC/bESiNMC+wd5q5id0yeS7CJEqXzmrTWNq3k05l84P6f4/bEmXFJjI0fIt1BGQssUnUDkBYeVhE5TqPnMH3jqogDcP0zKcTgLPTMSzOjhbjuVOmW23l1fYNStulfo6sXlFsGLhbDy5RECPRYGCTgOj2bd4nUQEivEd0H7KKYxqnEhFohuur3a3UPskbH/+Yg0+M5P2MHRJu3ziHh3Z2NCrWt3XF1rWTw8Ne/pfbWYXnDSE0SNZQQt1i18q7te2vOhu7ehWuvVyeu0wbLZi24mhoo6aOOTltzG/lgdVvVoXQq5V+pewkFIzL8fjEcadT55jOjpzFzHuOTtDNrMkJPMVQDd7F09RID72O/UPZ0tmctqZ7kWX6EmSZnDpP8GU67SXM8XE3YSrxbKsx6UReZ4y6n/FVZfJjs9Z7stma75W5yQtkzjk5eSJxk1lv4o7+j8TlhaJ2lsKWZO6lruDPBLib3x5ZN/KGWzZ+pn///evv7OOf4iIBv3oY9L/l1wiJ9p0Tc+F1zZnOE9NxXWEus6IQhr5pMfoqxi8WPsuu0azsns4UC6WzNzHIzbeEx4P/AJ3SefgcFAAA"
+                  }
+                }
               }
             }
           }
@@ -208637,7 +208705,7 @@
         "operationId": "issues/remove-assignees",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.4/rest/reference/issues#remove-assignees-from-an-issue"
+          "url": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue"
         },
         "parameters": [
           {
@@ -208663,6 +208731,7 @@
           }
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {
@@ -208673,7 +208742,8 @@
                     "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._",
                     "items": { "type": "string" }
                   }
-                }
+                },
+                "required": ["assignees"]
               },
               "examples": {
                 "default": { "value": { "assignees": ["hubot", "other_user"] } }
@@ -210104,6 +210174,9 @@
                             "allow_auto_merge": { "type": "boolean" },
                             "delete_branch_on_merge": { "type": "boolean" },
                             "allow_update_branch": { "type": "boolean" },
+                            "use_squash_pr_title_as_default": {
+                              "type": "boolean"
+                            },
                             "allow_merge_commit": { "type": "boolean" },
                             "subscribers_count": { "type": "integer" },
                             "network_count": { "type": "integer" }
@@ -210134,6 +210207,11 @@
                           "type": "boolean",
                           "example": false
                         },
+                        "use_squash_pr_title_as_default": {
+                          "type": "boolean",
+                          "description": "Whether a squash merge commit can use the pull request title as default.",
+                          "default": false
+                        },
                         "allow_merge_commit": {
                           "description": "Whether to allow merge commits for pull requests.",
                           "default": true,