@octokit/openapi 6.2.1 → 6.3.0

package/generated/ghes-3.3.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.2.1",
+    "version": "6.3.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" },
@@ -54010,7 +54010,7 @@
                   "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.3/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.3/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.3/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
-                    "items": { "type": "string" }
+                    "items": { "type": "integer" }
                   }
                 },
                 "required": ["visibility"]
@@ -54021,7 +54021,7 @@
                     "encrypted_value": "c2VjcmV0",
                     "key_id": "012345678912345678",
                     "visibility": "selected",
-                    "selected_repository_ids": ["1296269", "1296280"]
+                    "selected_repository_ids": [1296269, 1296280]
                   }
                 }
               }
@@ -54052,7 +54052,7 @@
           "category": "actions",
           "subcategory": "secrets"
         },
-        "x-octokit": {}
+        "x-octokit": { "diff": { "ghes-3.4": { "type": "changed" } } }
       },
       "delete": {
         "summary": "Delete an organization secret",
@@ -109569,7 +109569,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"]
@@ -197121,7 +197121,7 @@
         "operationId": "issues/remove-assignees",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#remove-assignees-from-an-issue"
+          "url": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue"
         },
         "parameters": [
           {
@@ -197147,6 +197147,7 @@
           }
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {
@@ -197157,7 +197158,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"] } }
@@ -198588,6 +198590,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" }
@@ -198618,6 +198623,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,
@@ -327961,7 +327971,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"
         },
         "x-octokit": { "ghes-3.4": "removed" },
         "responses": { "501": { "description": "Not Implemented" } }

package/generated/ghes-3.3.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.2.1",
+    "version": "6.3.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" },
@@ -8483,7 +8483,7 @@
                   "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.3/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.3/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.3/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.",
-                    "items": { "type": "string" }
+                    "items": { "type": "integer" }
                   }
                 },
                 "required": ["visibility"]
@@ -8494,7 +8494,7 @@
                     "encrypted_value": "c2VjcmV0",
                     "key_id": "012345678912345678",
                     "visibility": "selected",
-                    "selected_repository_ids": ["1296269", "1296280"]
+                    "selected_repository_ids": [1296269, 1296280]
                   }
                 }
               }
@@ -8519,7 +8519,7 @@
           "category": "actions",
           "subcategory": "secrets"
         },
-        "x-octokit": {}
+        "x-octokit": { "diff": { "ghes-3.4.json": { "type": "changed" } } }
       },
       "delete": {
         "summary": "Delete an organization secret",
@@ -15548,7 +15548,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"]
@@ -21521,7 +21521,7 @@
                     }
                   },
                   "deployment_branch_policy": {
-                    "$ref": "#/components/schemas/deployment_branch_policy"
+                    "$ref": "#/components/schemas/deployment-branch-policy"
                   }
                 },
                 "additionalProperties": false
@@ -24244,7 +24244,7 @@
         "operationId": "issues/remove-assignees",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/enterprise-server@3.3/rest/reference/issues#remove-assignees-from-an-issue"
+          "url": "https://docs.github.com/rest/reference/issues#remove-assignees-from-an-issue"
         },
         "parameters": [
           { "$ref": "#/components/parameters/owner" },
@@ -24252,6 +24252,7 @@
           { "$ref": "#/components/parameters/issue-number" }
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {
@@ -24262,7 +24263,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"] } }
@@ -37425,7 +37427,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"
         },
         "x-octokit": { "ghes-3.4.json": "removed" },
         "responses": { "501": { "description": "Not Implemented" } }
@@ -40688,7 +40690,7 @@
         ],
         "nullable": true
       },
-      "author_association": {
+      "author-association": {
         "title": "author_association",
         "type": "string",
         "example": "OWNER",
@@ -40854,7 +40856,7 @@
             "$ref": "#/components/schemas/nullable-integration"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -40920,7 +40922,7 @@
           },
           "issue_url": { "type": "string", "format": "uri" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "performed_via_github_app": {
             "$ref": "#/components/schemas/nullable-integration"
@@ -41395,7 +41397,7 @@
             "example": "2011-04-18T23:23:56Z"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           }
         },
         "required": [
@@ -47526,7 +47528,7 @@
           "created_at": { "type": "string", "format": "date-time" },
           "updated_at": { "type": "string", "format": "date-time" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -47571,7 +47573,7 @@
         "properties": { "href": { "type": "string" } },
         "required": ["href"]
       },
-      "auto_merge": {
+      "auto-merge": {
         "title": "Auto merge",
         "description": "The status of auto merging a pull request.",
         "type": "object",
@@ -47787,9 +47789,9 @@
             ]
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
-          "auto_merge": { "$ref": "#/components/schemas/auto_merge" },
+          "auto_merge": { "$ref": "#/components/schemas/auto-merge" },
           "draft": {
             "description": "Indicates whether or not the pull request is a draft.",
             "example": false,
@@ -48513,7 +48515,7 @@
         "example": 30,
         "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)."
       },
-      "deployment_branch_policy": {
+      "deployment-branch-policy": {
         "type": "object",
         "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.",
         "properties": {
@@ -48634,7 +48636,7 @@
             }
           },
           "deployment_branch_policy": {
-            "$ref": "#/components/schemas/deployment_branch_policy"
+            "$ref": "#/components/schemas/deployment-branch-policy"
           }
         },
         "required": [
@@ -49151,7 +49153,7 @@
             "$ref": "#/components/schemas/nullable-integration"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "reactions": { "$ref": "#/components/schemas/reaction-rollup" }
         },
@@ -49281,7 +49283,7 @@
           },
           "rename": { "$ref": "#/components/schemas/issue-event-rename" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "lock_reason": { "type": "string", "nullable": true },
           "performed_via_github_app": {
@@ -49984,7 +49986,7 @@
           },
           "issue_url": { "type": "string", "format": "uri" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "performed_via_github_app": {
             "$ref": "#/components/schemas/nullable-integration"
@@ -50199,7 +50201,7 @@
           "body_html": { "type": "string" },
           "body_text": { "type": "string" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           }
         },
         "required": [
@@ -50306,7 +50308,7 @@
             "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "_links": {
             "type": "object",
@@ -51758,9 +51760,9 @@
             ]
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
-          "auto_merge": { "$ref": "#/components/schemas/auto_merge" },
+          "auto_merge": { "$ref": "#/components/schemas/auto-merge" },
           "draft": {
             "description": "Indicates whether or not the pull request is a draft.",
             "example": false,
@@ -51915,7 +51917,7 @@
           "body_html": { "type": "string" },
           "body_text": { "type": "string" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           }
         },
         "required": [
@@ -51990,7 +51992,7 @@
             "example": "https://api.github.com/repos/octocat/Hello-World/pulls/1"
           },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "_links": {
             "type": "object",
@@ -52677,7 +52679,7 @@
           "body": { "type": "string" },
           "score": { "type": "number" },
           "author_association": {
-            "$ref": "#/components/schemas/author_association"
+            "$ref": "#/components/schemas/author-association"
           },
           "draft": { "type": "boolean" },
           "repository": { "$ref": "#/components/schemas/repository" },

package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.2.1",
+    "version": "6.3.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" },

package/generated/ghes-3.4-diff-to-ghes-3.5.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.2.1",
+    "version": "6.3.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" },

package/generated/ghes-3.4.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "6.2.1",
+    "version": "6.3.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"]
@@ -208637,7 +208641,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 +208667,7 @@
           }
         ],
         "requestBody": {
+          "required": true,
           "content": {
             "application/json": {
               "schema": {
@@ -208673,7 +208678,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 +210110,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 +210143,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,