@octokit/openapi 7.9.1 → 7.12.0

package/generated/ghes-3.6.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.9.1",
+    "version": "7.12.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": {
@@ -10081,7 +10081,7 @@
                 },
                 "examples": {
                   "default": {
-                    "$ref": "#/components/examples/organization-custom-repository-role-example-old"
+                    "$ref": "#/components/examples/organization-custom-repository-role-example"
                   }
                 }
               }
@@ -10094,7 +10094,13 @@
           "category": "orgs",
           "subcategory": "custom_roles"
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "api.github.com": {
+              "type": "changed"
+            }
+          }
+        }
       }
     },
     "/orgs/{org}": {
@@ -16080,8 +16086,9 @@
                   },
                   "use_squash_pr_title_as_default": {
                     "type": "boolean",
-                    "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
-                    "default": false
+                    "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+                    "default": false,
+                    "deprecated": true
                   },
                   "squash_merge_commit_title": {
                     "type": "string",
@@ -16619,6 +16626,21 @@
           }
         },
         "responses": {
+          "200": {
+            "description": "Response when the updated information already exists",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/team-full"
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/team-full"
+                  }
+                }
+              }
+            }
+          },
           "201": {
             "description": "Response",
             "content": {
@@ -16633,6 +16655,15 @@
                 }
               }
             }
+          },
+          "403": {
+            "$ref": "#/components/responses/forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/not_found"
+          },
+          "422": {
+            "$ref": "#/components/responses/validation_failed"
           }
         },
         "x-github": {
@@ -20306,8 +20337,9 @@
                   },
                   "use_squash_pr_title_as_default": {
                     "type": "boolean",
-                    "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
-                    "default": false
+                    "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+                    "default": false,
+                    "deprecated": true
                   },
                   "squash_merge_commit_title": {
                     "type": "string",
@@ -23568,7 +23600,7 @@
     },
     "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
       "get": {
-        "summary": "List workflow runs",
+        "summary": "List workflow runs for a workflow",
         "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/enterprise-server@3.6/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.",
         "tags": [
           "actions"
@@ -28847,6 +28879,22 @@
               "default": "all"
             }
           },
+          {
+            "name": "permission",
+            "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "pull",
+                "triage",
+                "push",
+                "maintain",
+                "admin"
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/per-page"
           },
@@ -30398,6 +30446,7 @@
             "description": "The base branch and head branch to compare. This parameter expects the format `{base}...{head}`.",
             "in": "path",
             "required": true,
+            "x-multi-segment": true,
             "schema": {
               "type": "string"
             }
@@ -30539,7 +30588,7 @@
       },
       "put": {
         "summary": "Create or update file contents",
-        "description": "Creates a new file or replaces an existing file in a repository.",
+        "description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
         "tags": [
           "repos"
         ],
@@ -30758,7 +30807,7 @@
                   },
                   "sha": {
                     "type": "string",
-                    "description": "The blob SHA of the file being replaced."
+                    "description": "The blob SHA of the file being deleted."
                   },
                   "branch": {
                     "type": "string",
@@ -33806,7 +33855,7 @@
     "/repos/{owner}/{repo}/git/trees/{tree_sha}": {
       "get": {
         "summary": "Get a tree",
-        "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.",
+        "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time.\n\n\n**Note**: The limit for the `tree` array is 100,000 entries with a maximum size of 7 MB when using the `recursive` parameter.",
         "tags": [
           "git"
         ],
@@ -33879,7 +33928,7 @@
     "/repos/{owner}/{repo}/hooks": {
       "get": {
         "summary": "List repository webhooks",
-        "description": "",
+        "description": "Lists webhooks for a repository. `last response` may return null if there have not been any deliveries within 30 days.",
         "tags": [
           "repos"
         ],
@@ -54507,6 +54556,70 @@
         }
       }
     },
+    "/orgs/{org}/custom_roles": {
+      "post": {
+        "summary": "Create a custom role",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
+        "tags": [
+          "orgs"
+        ],
+        "operationId": "orgs/create-custom-role",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/orgs#create-a-custom-role"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      }
+    },
+    "/orgs/{org}/custom_roles/{role_id}": {
+      "delete": {
+        "summary": "Delete a custom role",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
+        "tags": [
+          "orgs"
+        ],
+        "operationId": "orgs/delete-custom-role",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/orgs#delete-a-custom-role"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      },
+      "patch": {
+        "summary": "Update a custom role",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
+        "tags": [
+          "orgs"
+        ],
+        "operationId": "orgs/update-custom-role",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/orgs#update-a-custom-role"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      }
+    },
     "/orgs/{org}/external-group/{group_id}": {
       "get": {
         "summary": "Get an external group",
@@ -54573,6 +54686,28 @@
         }
       }
     },
+    "/orgs/{org}/fine_grained_permissions": {
+      "get": {
+        "summary": "List fine-grained permissions for an organization",
+        "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
+        "tags": [
+          "orgs"
+        ],
+        "operationId": "orgs/list-fine-grained-permissions",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/orgs#list-fine-grained-permissions-for-an-organization"
+        },
+        "x-octokit": {
+          "api.github.com": "removed"
+        },
+        "responses": {
+          "501": {
+            "description": "Not Implemented"
+          }
+        }
+      }
+    },
     "/orgs/{org}/interaction-limits": {
       "get": {
         "summary": "Get interaction restrictions for an organization",
@@ -54939,7 +55074,7 @@
     },
     "/orgs/{org}/packages/{package_type}/{package_name}/versions": {
       "get": {
-        "summary": "Get all package versions for a package owned by an organization",
+        "summary": "List package versions for a package owned by an organization",
         "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
         "tags": [
           "packages"
@@ -54947,7 +55082,7 @@
         "operationId": "packages/get-all-package-versions-for-package-owned-by-org",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-an-organization"
+          "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-an-organization"
         },
         "x-octokit": {
           "api.github.com": "removed"
@@ -57422,7 +57557,7 @@
     },
     "/user/packages/{package_type}/{package_name}/versions": {
       "get": {
-        "summary": "Get all package versions for a package owned by the authenticated user",
+        "summary": "List package versions for a package owned by the authenticated user",
         "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
         "tags": [
           "packages"
@@ -57430,7 +57565,7 @@
         "operationId": "packages/get-all-package-versions-for-package-owned-by-authenticated-user",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
+          "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-the-authenticated-user"
         },
         "x-octokit": {
           "api.github.com": "removed"
@@ -57678,7 +57813,7 @@
     },
     "/users/{username}/packages/{package_type}/{package_name}/versions": {
       "get": {
-        "summary": "Get all package versions for a package owned by a user",
+        "summary": "List package versions for a package owned by a user",
         "description": "This endpoint does not exist in GitHub Enterprise Server 3.6. It was added in api.github.com",
         "tags": [
           "packages"
@@ -57686,7 +57821,7 @@
         "operationId": "packages/get-all-package-versions-for-package-owned-by-user",
         "externalDocs": {
           "description": "API method documentation",
-          "url": "https://docs.github.com/rest/reference/packages#get-all-package-versions-for-a-package-owned-by-a-user"
+          "url": "https://docs.github.com/rest/packages#get-all-package-versions-for-a-package-owned-by-a-user"
         },
         "x-octokit": {
           "api.github.com": "removed"
@@ -60863,8 +60998,9 @@
           },
           "use_squash_pr_title_as_default": {
             "type": "boolean",
-            "description": "Whether a squash merge commit can use the pull request title as default.",
-            "default": false
+            "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+            "default": false,
+            "deprecated": true
           },
           "squash_merge_commit_title": {
             "type": "string",
@@ -64970,8 +65106,9 @@
           },
           "use_squash_pr_title_as_default": {
             "type": "boolean",
-            "description": "Whether a squash merge commit can use the pull request title as default.",
-            "default": false
+            "description": "Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+            "default": false,
+            "deprecated": true
           },
           "squash_merge_commit_title": {
             "type": "string",
@@ -87785,7 +87922,7 @@
           }
         ]
       },
-      "organization-custom-repository-role-example-old": {
+      "organization-custom-repository-role-example": {
         "value": {
           "total_count": 2,
           "custom_roles": [

package/generated/github.ae-anicca-diff-to-api.github.com.deref.json

@@ -11861,6 +11861,13 @@
       "/orgs/{org}/credential-authorizations/{credential_id}": [
         "delete"
       ],
+      "/orgs/{org}/custom_roles": [
+        "post"
+      ],
+      "/orgs/{org}/custom_roles/{role_id}": [
+        "delete",
+        "patch"
+      ],
       "/orgs/{org}/dependabot/secrets": [
         "get"
       ],
@@ -11886,6 +11893,9 @@
       "/orgs/{org}/failed_invitations": [
         "get"
       ],
+      "/orgs/{org}/fine_grained_permissions": [
+        "get"
+      ],
       "/orgs/{org}/interaction-limits": [
         "get",
         "put",

package/generated/github.ae-diff-to-api.github.com.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.9.1",
+    "version": "7.12.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": {
@@ -41676,8 +41676,9 @@
                   },
                   "use_squash_pr_title_as_default": {
                     "type": "boolean",
-                    "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
-                    "default": false
+                    "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+                    "default": false,
+                    "deprecated": true
                   },
                   "squash_merge_commit_title": {
                     "type": "string",
@@ -52468,8 +52469,9 @@
                   },
                   "use_squash_pr_title_as_default": {
                     "type": "boolean",
-                    "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
-                    "default": false
+                    "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+                    "default": false,
+                    "deprecated": true
                   },
                   "squash_merge_commit_title": {
                     "type": "string",
@@ -72907,7 +72909,7 @@
     },
     "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
       "get": {
-        "summary": "List workflow runs",
+        "summary": "List workflow runs for a workflow",
         "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.",
         "tags": [
           "actions"
@@ -89315,6 +89317,22 @@
               "default": "all"
             }
           },
+          {
+            "name": "permission",
+            "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "pull",
+                "triage",
+                "push",
+                "maintain",
+                "admin"
+              ]
+            }
+          },
           {
             "name": "per_page",
             "description": "The number of results per page (max 100).",

package/generated/github.ae-diff-to-api.github.com.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.9.1",
+    "version": "7.12.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": {
@@ -5118,8 +5118,9 @@
                   },
                   "use_squash_pr_title_as_default": {
                     "type": "boolean",
-                    "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
-                    "default": false
+                    "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+                    "default": false,
+                    "deprecated": true
                   },
                   "squash_merge_commit_title": {
                     "type": "string",
@@ -5619,8 +5620,9 @@
                   },
                   "use_squash_pr_title_as_default": {
                     "type": "boolean",
-                    "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message.",
-                    "default": false
+                    "description": "Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.",
+                    "default": false,
+                    "deprecated": true
                   },
                   "squash_merge_commit_title": {
                     "type": "string",
@@ -6125,7 +6127,7 @@
     },
     "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": {
       "get": {
-        "summary": "List workflow runs",
+        "summary": "List workflow runs for a workflow",
         "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.",
         "tags": [
           "actions"
@@ -6970,6 +6972,22 @@
               "default": "all"
             }
           },
+          {
+            "name": "permission",
+            "description": "Filter collaborators by the permissions they have on the repository. If not specified, all collaborators will be returned.",
+            "in": "query",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "enum": [
+                "pull",
+                "triage",
+                "push",
+                "maintain",
+                "admin"
+              ]
+            }
+          },
           {
             "$ref": "#/components/parameters/per-page"
           },