@octokit/openapi 7.8.0 → 7.10.0

package/generated/ghes-3.6.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.8.0",
+    "version": "7.10.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",
@@ -20306,8 +20313,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",
@@ -22081,7 +22089,13 @@
           "category": "actions",
           "subcategory": "workflow-runs"
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "api.github.com": {
+              "type": "changed"
+            }
+          }
+        }
       }
     },
     "/repos/{owner}/{repo}/actions/runs/{run_id}": {
@@ -23562,7 +23576,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"
@@ -23653,7 +23667,13 @@
           "category": "actions",
           "subcategory": "workflow-runs"
         },
-        "x-octokit": {}
+        "x-octokit": {
+          "diff": {
+            "api.github.com": {
+              "type": "changed"
+            }
+          }
+        }
       }
     },
     "/repos/{owner}/{repo}/assignees": {
@@ -30746,7 +30766,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",
@@ -35927,6 +35947,11 @@
                   },
                   "state_reason": {
                     "type": "string",
+                    "enum": [
+                      "completed",
+                      "not_planned",
+                      "reopened"
+                    ],
                     "nullable": true,
                     "description": "The reason for the current state",
                     "example": "not_planned"
@@ -54490,6 +54515,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",
@@ -54556,6 +54645,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",
@@ -54922,7 +55033,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"
@@ -54930,7 +55041,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"
@@ -57405,7 +57516,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"
@@ -57413,7 +57524,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"
@@ -57661,7 +57772,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"
@@ -57669,7 +57780,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"
@@ -60846,8 +60957,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",
@@ -62825,7 +62937,12 @@
             "description": "The reason for the current state",
             "example": "not_planned",
             "type": "string",
-            "nullable": true
+            "nullable": true,
+            "enum": [
+              "completed",
+              "reopened",
+              "not_planned"
+            ]
           },
           "title": {
             "description": "Title of the issue",
@@ -64948,8 +65065,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",
@@ -75202,7 +75320,12 @@
             "description": "The reason for the current state",
             "example": "not_planned",
             "type": "string",
-            "nullable": true
+            "nullable": true,
+            "enum": [
+              "completed",
+              "reopened",
+              "not_planned"
+            ]
           },
           "title": {
             "description": "Title of the issue",
@@ -87758,7 +87881,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

@@ -8023,6 +8023,16 @@
                   "type": "integer"
                 },
                 "style": "form"
+              },
+              {
+                "description": "Only returns workflow runs that are associated with the specified `head_sha`.",
+                "in": "query",
+                "name": "head_sha",
+                "required": false,
+                "schema": {
+                  "type": "string"
+                },
+                "style": "form"
               }
             ]
           },
@@ -8310,6 +8320,16 @@
                   "type": "integer"
                 },
                 "style": "form"
+              },
+              {
+                "description": "Only returns workflow runs that are associated with the specified `head_sha`.",
+                "in": "query",
+                "name": "head_sha",
+                "required": false,
+                "schema": {
+                  "type": "string"
+                },
+                "style": "form"
               }
             ]
           },
@@ -11841,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"
       ],
@@ -11866,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.8.0",
+    "version": "7.10.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": {
@@ -16715,7 +16715,12 @@
                         "description": "The reason for the current state",
                         "example": "not_planned",
                         "type": "string",
-                        "nullable": true
+                        "nullable": true,
+                        "enum": [
+                          "completed",
+                          "reopened",
+                          "not_planned"
+                        ]
                       },
                       "title": {
                         "description": "Title of the issue",
@@ -32141,7 +32146,12 @@
                         "description": "The reason for the current state",
                         "example": "not_planned",
                         "type": "string",
-                        "nullable": true
+                        "nullable": true,
+                        "enum": [
+                          "completed",
+                          "reopened",
+                          "not_planned"
+                        ]
                       },
                       "title": {
                         "description": "Title of the issue",
@@ -41666,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",
@@ -52458,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",
@@ -72897,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"
@@ -101945,7 +101957,12 @@
                                 "description": "The reason for the current state",
                                 "example": "not_planned",
                                 "type": "string",
-                                "nullable": true
+                                "nullable": true,
+                                "enum": [
+                                  "completed",
+                                  "reopened",
+                                  "not_planned"
+                                ]
                               },
                               "title": {
                                 "description": "Title of the issue",
@@ -117237,7 +117254,12 @@
                         "description": "The reason for the current state",
                         "example": "not_planned",
                         "type": "string",
-                        "nullable": true
+                        "nullable": true,
+                        "enum": [
+                          "completed",
+                          "reopened",
+                          "not_planned"
+                        ]
                       },
                       "title": {
                         "description": "Title of the issue",
@@ -120024,7 +120046,12 @@
                       "description": "The reason for the current state",
                       "example": "not_planned",
                       "type": "string",
-                      "nullable": true
+                      "nullable": true,
+                      "enum": [
+                        "completed",
+                        "reopened",
+                        "not_planned"
+                      ]
                     },
                     "title": {
                       "description": "Title of the issue",
@@ -122936,7 +122963,12 @@
                             "description": "The reason for the current state",
                             "example": "not_planned",
                             "type": "string",
-                            "nullable": true
+                            "nullable": true,
+                            "enum": [
+                              "completed",
+                              "reopened",
+                              "not_planned"
+                            ]
                           },
                           "title": {
                             "description": "Title of the issue",
@@ -126779,7 +126811,12 @@
                           "description": "The reason for the current state",
                           "example": "not_planned",
                           "type": "string",
-                          "nullable": true
+                          "nullable": true,
+                          "enum": [
+                            "completed",
+                            "reopened",
+                            "not_planned"
+                          ]
                         },
                         "title": {
                           "description": "Title of the issue",
@@ -130504,7 +130541,12 @@
                       "description": "The reason for the current state",
                       "example": "not_planned",
                       "type": "string",
-                      "nullable": true
+                      "nullable": true,
+                      "enum": [
+                        "completed",
+                        "reopened",
+                        "not_planned"
+                      ]
                     },
                     "title": {
                       "description": "Title of the issue",
@@ -133134,6 +133176,11 @@
                   },
                   "state_reason": {
                     "type": "string",
+                    "enum": [
+                      "completed",
+                      "not_planned",
+                      "reopened"
+                    ],
                     "nullable": true,
                     "description": "The reason for the current state",
                     "example": "not_planned"
@@ -133263,7 +133310,12 @@
                       "description": "The reason for the current state",
                       "example": "not_planned",
                       "type": "string",
-                      "nullable": true
+                      "nullable": true,
+                      "enum": [
+                        "completed",
+                        "reopened",
+                        "not_planned"
+                      ]
                     },
                     "title": {
                       "description": "Title of the issue",
@@ -136053,7 +136105,12 @@
                       "description": "The reason for the current state",
                       "example": "not_planned",
                       "type": "string",
-                      "nullable": true
+                      "nullable": true,
+                      "enum": [
+                        "completed",
+                        "reopened",
+                        "not_planned"
+                      ]
                     },
                     "title": {
                       "description": "Title of the issue",
@@ -170881,7 +170938,12 @@
                         "description": "The reason for the current state",
                         "example": "not_planned",
                         "type": "string",
-                        "nullable": true
+                        "nullable": true,
+                        "enum": [
+                          "completed",
+                          "reopened",
+                          "not_planned"
+                        ]
                       },
                       "title": {
                         "description": "Title of the issue",
@@ -188970,7 +189032,12 @@
                                 "description": "The reason for the current state",
                                 "example": "not_planned",
                                 "type": "string",
-                                "nullable": true
+                                "nullable": true,
+                                "enum": [
+                                  "completed",
+                                  "reopened",
+                                  "not_planned"
+                                ]
                               },
                               "title": {
                                 "description": "Title of the issue",
@@ -192102,7 +192169,12 @@
                                 "description": "The reason for the current state",
                                 "example": "not_planned",
                                 "type": "string",
-                                "nullable": true
+                                "nullable": true,
+                                "enum": [
+                                  "completed",
+                                  "reopened",
+                                  "not_planned"
+                                ]
                               },
                               "title": {
                                 "description": "Title of the issue",