@octokit/openapi 7.9.1 → 7.12.0

package/generated/ghes-3.5.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": {
@@ -9637,7 +9637,7 @@
                 },
                 "examples": {
                   "default": {
-                    "$ref": "#/components/examples/organization-custom-repository-role-example-old"
+                    "$ref": "#/components/examples/organization-custom-repository-role-example"
                   }
                 }
               }
@@ -15658,8 +15658,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",
@@ -16203,6 +16204,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": {
@@ -16217,6 +16233,15 @@
                 }
               }
             }
+          },
+          "403": {
+            "$ref": "#/components/responses/forbidden"
+          },
+          "404": {
+            "$ref": "#/components/responses/not_found"
+          },
+          "422": {
+            "$ref": "#/components/responses/validation_failed"
           }
         },
         "x-github": {
@@ -19908,8 +19933,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",
@@ -23072,7 +23098,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.5/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"
@@ -28353,6 +28379,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"
           },
@@ -29916,6 +29958,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"
             }
@@ -30057,7 +30100,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"
         ],
@@ -30276,7 +30319,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",
@@ -33268,7 +33311,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"
         ],
@@ -33341,7 +33384,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"
         ],
@@ -83151,7 +83194,7 @@
           }
         ]
       },
-      "organization-custom-repository-role-example-old": {
+      "organization-custom-repository-role-example": {
         "value": {
           "total_count": 2,
           "custom_roles": [

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

@@ -17568,6 +17568,42 @@
           }
         }
       },
+      "/organizations/{organization_id}/custom_roles": {
+        "get": {
+          "responses": {
+            "changed": {
+              "200": {
+                "content": {
+                  "changed": {
+                    "application/json": {
+                      "schema_changed": {
+                        "properties_changed": {
+                          "changed": {
+                            "custom_roles": {
+                              "items_changed": {
+                                "properties_changed": {
+                                  "removed": [
+                                    "base_role",
+                                    "created_at",
+                                    "description",
+                                    "organization",
+                                    "permissions",
+                                    "updated_at"
+                                  ]
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
       "/orgs/{org}": {
         "get": {
           "responses": {
@@ -18602,6 +18638,13 @@
       "/orgs/{org}/credential-authorizations/{credential_id}": [
         "delete"
       ],
+      "/orgs/{org}/custom_roles": [
+        "post"
+      ],
+      "/orgs/{org}/custom_roles/{role_id}": [
+        "delete",
+        "patch"
+      ],
       "/orgs/{org}/external-group/{group_id}": [
         "get"
       ],
@@ -18611,6 +18654,9 @@
       "/orgs/{org}/failed_invitations": [
         "get"
       ],
+      "/orgs/{org}/fine_grained_permissions": [
+        "get"
+      ],
       "/orgs/{org}/interaction-limits": [
         "get",
         "put",

package/generated/ghes-3.6-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": {
@@ -9553,8 +9553,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",
@@ -21783,6 +21784,102 @@
         }
       }
     },
+    "/organizations/{organization_id}/custom_roles": {
+      "get": {
+        "summary": "List custom repository roles in an organization",
+        "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.6/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
+        "tags": [
+          "orgs"
+        ],
+        "operationId": "orgs/list-custom-roles",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#list-custom-repository-roles-in-an-organization"
+        },
+        "parameters": [
+          {
+            "name": "organization_id",
+            "description": "The unique identifier of the organization.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response - list of custom role names",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "total_count": {
+                      "description": "The number of custom roles in this organization",
+                      "example": 3,
+                      "type": "integer"
+                    },
+                    "custom_roles": {
+                      "type": "array",
+                      "items": {
+                        "title": "Organization Custom Repository Role",
+                        "description": "Custom repository roles created by organization administrators",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "description": "The unique identifier of the custom role.",
+                            "type": "integer"
+                          },
+                          "name": {
+                            "description": "The name of the custom role.",
+                            "type": "string"
+                          }
+                        },
+                        "required": [
+                          "id",
+                          "name"
+                        ]
+                      }
+                    }
+                  }
+                },
+                "examples": {
+                  "default": {
+                    "value": {
+                      "total_count": 2,
+                      "custom_roles": [
+                        {
+                          "id": 8030,
+                          "name": "Developer"
+                        },
+                        {
+                          "id": 8031,
+                          "name": "Designer"
+                        }
+                      ]
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "orgs",
+          "subcategory": "custom_roles"
+        },
+        "x-octokit": {
+          "diff": {
+            "api.github.com": {
+              "type": "changed"
+            }
+          }
+        }
+      }
+    },
     "/orgs/{org}": {
       "get": {
         "summary": "Get an organization",
@@ -30100,8 +30197,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",
@@ -31866,8 +31964,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",
@@ -32448,7 +32547,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"
@@ -34640,8 +34739,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",
@@ -36406,8 +36506,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",
@@ -37810,6 +37911,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).",
@@ -39910,8 +40027,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",
@@ -41348,8 +41466,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",
@@ -42541,8 +42660,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",
@@ -51539,8 +51659,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",

package/generated/ghes-3.6-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": {
@@ -4706,6 +4706,74 @@
         }
       }
     },
+    "/organizations/{organization_id}/custom_roles": {
+      "get": {
+        "summary": "List custom repository roles in an organization",
+        "description": "List the custom repository roles available in this organization. In order to see custom\nrepository roles in an organization, the authenticated user must be an organization owner.\n\nTo use this endpoint the authenticated user must be an administrator for the organization or of an repository of the organizaiton and must use an access token with `admin:org repo` scope.\nGitHub Apps must have the `organization_custom_roles:read` organization permission to use this endpoint.\n\nFor more information on custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/enterprise-server@3.6/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization)\".",
+        "tags": [
+          "orgs"
+        ],
+        "operationId": "orgs/list-custom-roles",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/enterprise-server@3.6/rest/reference/orgs#list-custom-repository-roles-in-an-organization"
+        },
+        "parameters": [
+          {
+            "name": "organization_id",
+            "description": "The unique identifier of the organization.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response - list of custom role names",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "total_count": {
+                      "description": "The number of custom roles in this organization",
+                      "example": 3,
+                      "type": "integer"
+                    },
+                    "custom_roles": {
+                      "type": "array",
+                      "items": {
+                        "$ref": "#/components/schemas/organization-custom-repository-role"
+                      }
+                    }
+                  }
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/organization-custom-repository-role-example"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "orgs",
+          "subcategory": "custom_roles"
+        },
+        "x-octokit": {
+          "diff": {
+            "api.github.com": {
+              "type": "changed"
+            }
+          }
+        }
+      }
+    },
     "/orgs/{org}": {
       "get": {
         "summary": "Get an organization",
@@ -6080,7 +6148,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"
@@ -6522,6 +6590,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"
           },
@@ -11291,6 +11375,25 @@
           "verifiable_password_authentication"
         ]
       },
+      "organization-custom-repository-role": {
+        "title": "Organization Custom Repository Role",
+        "description": "Custom repository roles created by organization administrators",
+        "type": "object",
+        "properties": {
+          "id": {
+            "description": "The unique identifier of the custom role.",
+            "type": "integer"
+          },
+          "name": {
+            "description": "The name of the custom role.",
+            "type": "string"
+          }
+        },
+        "required": [
+          "id",
+          "name"
+        ]
+      },
       "organization-full": {
         "title": "Organization Full",
         "description": "Organization Full",
@@ -15260,8 +15363,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",
@@ -17323,8 +17427,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",
@@ -18775,6 +18880,21 @@
           "installed_version": "3.6.0"
         }
       },
+      "organization-custom-repository-role-example": {
+        "value": {
+          "total_count": 2,
+          "custom_roles": [
+            {
+              "id": 8030,
+              "name": "Developer"
+            },
+            {
+              "id": 8031,
+              "name": "Designer"
+            }
+          ]
+        }
+      },
       "organization-full-default-response": {
         "summary": "Default response",
         "value": {