@octokit/openapi 7.9.1 → 7.10.0

package/generated/api.github.com.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.9.1",
+    "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": {
@@ -6969,7 +6969,7 @@
                 },
                 "examples": {
                   "default": {
-                    "$ref": "#/components/examples/organization-custom-repository-role-example-old"
+                    "$ref": "#/components/examples/organization-custom-repository-role-example"
                   }
                 }
               }
@@ -10292,6 +10292,305 @@
         "x-octokit": {}
       }
     },
+    "/orgs/{org}/custom_roles": {
+      "post": {
+        "summary": "Create a custom role",
+        "description": "**Note**: This operation is in beta and is subject to change.\n\nCreates a custom repository role that can be used by all repositories owned by the organization.\n\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.\nGitHub Apps must have the `organization_custom_roles:write` 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/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"",
+        "tags": [
+          "orgs"
+        ],
+        "operationId": "orgs/create-custom-role",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/orgs#create-a-custom-role"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/org"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The name of the custom role."
+                  },
+                  "description": {
+                    "type": "string",
+                    "description": "A short description about the intended usage of this role or what permissions it grants."
+                  },
+                  "base_role": {
+                    "type": "string",
+                    "enum": [
+                      "read",
+                      "triage",
+                      "write",
+                      "maintain"
+                    ],
+                    "description": "The system role from which this role inherits permissions."
+                  },
+                  "permissions": {
+                    "type": "array",
+                    "description": "A list of additional permissions included in this role.",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                },
+                "required": [
+                  "name",
+                  "base_role",
+                  "permissions"
+                ]
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "name": "Labeler",
+                    "description": "A role for issue and PR labelers",
+                    "base_role": "read",
+                    "permissions": [
+                      "add_label"
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/organization-custom-repository-role"
+                },
+                "examples": {
+                  "default": {
+                    "value": {
+                      "id": 8030,
+                      "name": "Labeler",
+                      "description": "A role for issue and PR labelers",
+                      "base_role": "read",
+                      "permissions": [
+                        "add_label"
+                      ],
+                      "organization": {
+                        "login": "github",
+                        "id": 9919,
+                        "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
+                        "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
+                        "gravatar_id": "",
+                        "url": "https://api.github.com/users/github",
+                        "html_url": "https://github.com/github",
+                        "followers_url": "https://api.github.com/users/github/followers",
+                        "following_url": "https://api.github.com/users/github/following{/other_user}",
+                        "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+                        "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+                        "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+                        "organizations_url": "https://api.github.com/users/github/orgs",
+                        "repos_url": "https://api.github.com/users/github/repos",
+                        "events_url": "https://api.github.com/users/github/events{/privacy}",
+                        "received_events_url": "https://api.github.com/users/github/received_events",
+                        "type": "Organization",
+                        "site_admin": false
+                      },
+                      "created_at": "2022-07-04T22:19:11Z",
+                      "updated_at": "2022-07-04T22:19:11Z"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "$ref": "#/components/responses/not_found"
+          },
+          "422": {
+            "$ref": "#/components/responses/validation_failed"
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "orgs",
+          "subcategory": "custom-roles"
+        },
+        "x-octokit": {}
+      }
+    },
+    "/orgs/{org}/custom_roles/{role_id}": {
+      "patch": {
+        "summary": "Update a custom role",
+        "description": "**Note**: This operation is in beta and subject to change.\n\nUpdates a custom repository role that can be used by all repositories owned by the organization.\n\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.\nGitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.\n\nFor more information about custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"",
+        "tags": [
+          "orgs"
+        ],
+        "operationId": "orgs/update-custom-role",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/orgs#update-a-custom-role"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/org"
+          },
+          {
+            "$ref": "#/components/parameters/role-id"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "The name of the custom role."
+                  },
+                  "description": {
+                    "type": "string",
+                    "description": "A short description about who this role is for or what permissions it grants."
+                  },
+                  "base_role": {
+                    "type": "string",
+                    "enum": [
+                      "read",
+                      "triage",
+                      "write",
+                      "maintain"
+                    ],
+                    "description": "The system role from which this role inherits permissions."
+                  },
+                  "permissions": {
+                    "type": "array",
+                    "description": "A list of additional permissions included in this role. If specified, these permissions will replace any currently set on the role.",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                }
+              },
+              "examples": {
+                "default": {
+                  "value": {
+                    "name": "Labeler",
+                    "description": "A role for issue and PR labelers",
+                    "base_role": "read",
+                    "permissions": [
+                      "add_label",
+                      "remove_label"
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/organization-custom-repository-role"
+                },
+                "examples": {
+                  "default": {
+                    "value": {
+                      "id": 8030,
+                      "name": "Labeler",
+                      "description": "A role for issue and PR labelers",
+                      "base_role": "read",
+                      "permissions": [
+                        "add_label",
+                        "remove_label"
+                      ],
+                      "organization": {
+                        "login": "github",
+                        "id": 9919,
+                        "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
+                        "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
+                        "gravatar_id": "",
+                        "url": "https://api.github.com/users/github",
+                        "html_url": "https://github.com/github",
+                        "followers_url": "https://api.github.com/users/github/followers",
+                        "following_url": "https://api.github.com/users/github/following{/other_user}",
+                        "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+                        "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+                        "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+                        "organizations_url": "https://api.github.com/users/github/orgs",
+                        "repos_url": "https://api.github.com/users/github/repos",
+                        "events_url": "https://api.github.com/users/github/events{/privacy}",
+                        "received_events_url": "https://api.github.com/users/github/received_events",
+                        "type": "Organization",
+                        "site_admin": false
+                      },
+                      "created_at": "2022-07-04T22:19:11Z",
+                      "updated_at": "2022-07-04T22:19:11Z"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "$ref": "#/components/responses/not_found"
+          },
+          "422": {
+            "$ref": "#/components/responses/validation_failed"
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "category": "orgs",
+          "subcategory": "custom-roles"
+        },
+        "x-octokit": {}
+      },
+      "delete": {
+        "summary": "Delete a custom role",
+        "description": "**Note**: This operation is in beta and is subject to change.\n\nDeletes a custom role from an organization. Once the custom role has been deleted, any\nuser, team, or invitation with the deleted custom role will be reassigned the inherited role.\n\nTo use this endpoint the authenticated user must be an administrator for the organization and must use an access token with `admin:org` scope.\nGitHub Apps must have the `organization_custom_roles:write` organization permission to use this endpoint.\n\nFor more information about custom repository roles, see \"[Managing custom repository roles for an organization](https://docs.github.com/organizations/managing-peoples-access-to-your-organization-with-roles/managing-custom-repository-roles-for-an-organization).\"",
+        "tags": [
+          "orgs"
+        ],
+        "operationId": "orgs/delete-custom-role",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/orgs#delete-a-custom-role"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/org"
+          },
+          {
+            "$ref": "#/components/parameters/role-id"
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "Response"
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "previews": [],
+          "category": "orgs",
+          "subcategory": "custom-roles"
+        },
+        "x-octokit": {}
+      }
+    },
     "/orgs/{org}/dependabot/secrets": {
       "get": {
         "summary": "List organization secrets",
@@ -11035,6 +11334,53 @@
         "x-octokit": {}
       }
     },
+    "/orgs/{org}/fine_grained_permissions": {
+      "get": {
+        "summary": "List fine-grained permissions for an organization",
+        "description": "**Note**: This operation is in beta and subject to change.\n\nLists the fine-grained permissions available for an organization.\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.",
+        "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"
+        },
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/org"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/components/schemas/organization-fine-grained-permission"
+                  }
+                },
+                "examples": {
+                  "default": {
+                    "$ref": "#/components/examples/organization-fine-grained-permission-example"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": false,
+          "enabledForGitHubApps": true,
+          "previews": [],
+          "category": "orgs",
+          "subcategory": "custom-roles"
+        },
+        "x-octokit": {}
+      }
+    },
     "/orgs/{org}/hooks": {
       "get": {
         "summary": "List organization webhooks",
@@ -13708,15 +14054,15 @@
     },
     "/orgs/{org}/packages/{package_type}/{package_name}/versions": {
       "get": {
-        "summary": "Get all package versions for a package owned by an organization",
-        "description": "Returns all package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
+        "summary": "List package versions for a package owned by an organization",
+        "description": "Lists package versions for a package owned by an organization.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
         "tags": [
           "packages"
         ],
         "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"
         },
         "parameters": [
           {
@@ -14484,8 +14830,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",
@@ -19395,8 +19742,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",
@@ -22915,7 +23263,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/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"
@@ -31012,7 +31360,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",
@@ -56051,15 +56399,15 @@
     },
     "/user/packages/{package_type}/{package_name}/versions": {
       "get": {
-        "summary": "Get all package versions for a package owned by the authenticated user",
-        "description": "Returns all package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
+        "summary": "List package versions for a package owned by the authenticated user",
+        "description": "Lists package versions for a package owned by the authenticated user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
         "tags": [
           "packages"
         ],
         "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"
         },
         "parameters": [
           {
@@ -58547,15 +58895,15 @@
     },
     "/users/{username}/packages/{package_type}/{package_name}/versions": {
       "get": {
-        "summary": "Get all package versions for a package owned by a user",
-        "description": "Returns all package versions for a public package owned by a specified user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
+        "summary": "List package versions for a package owned by a user",
+        "description": "Lists package versions for a public package owned by a specified user.\n\nTo use this endpoint, you must authenticate using an access token with the `packages:read` scope.\nIf `package_type` is not `container`, your token must also include the `repo` scope.",
         "tags": [
           "packages"
         ],
         "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"
         },
         "parameters": [
           {
@@ -61660,8 +62008,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",
@@ -66618,8 +66967,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",
@@ -67323,6 +67673,39 @@
           "name": {
             "description": "The name of the custom role.",
             "type": "string"
+          },
+          "description": {
+            "description": "A short description about who this role is for or what permissions it grants.",
+            "type": "string",
+            "nullable": true
+          },
+          "base_role": {
+            "type": "string",
+            "description": "The system role from which this role inherits permissions.",
+            "enum": [
+              "read",
+              "triage",
+              "write",
+              "maintain"
+            ]
+          },
+          "permissions": {
+            "description": "A list of additional permissions included in this role.",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "organization": {
+            "$ref": "#/components/schemas/simple-user"
+          },
+          "created_at": {
+            "type": "string",
+            "format": "date-time"
+          },
+          "updated_at": {
+            "type": "string",
+            "format": "date-time"
           }
         },
         "required": [
@@ -68506,6 +68889,23 @@
           "node_id"
         ]
       },
+      "organization-fine-grained-permission": {
+        "title": "Organization Fine-Grained Permission",
+        "description": "Fine-grained permissions available for the organization",
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "name",
+          "description"
+        ]
+      },
       "org-hook": {
         "title": "Org Hook",
         "description": "Org Hook",
@@ -91963,17 +92363,76 @@
           }
         ]
       },
-      "organization-custom-repository-role-example-old": {
+      "organization-custom-repository-role-example": {
         "value": {
           "total_count": 2,
           "custom_roles": [
             {
               "id": 8030,
-              "name": "Developer"
+              "name": "Security Engineer",
+              "description": "Able to contribute code and maintain the security pipeline",
+              "base_role": "maintain",
+              "permissions": [
+                "delete_alerts_code_scanning"
+              ],
+              "organization": {
+                "login": "github",
+                "id": 9919,
+                "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
+                "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
+                "gravatar_id": "",
+                "url": "https://api.github.com/users/github",
+                "html_url": "https://github.com/github",
+                "followers_url": "https://api.github.com/users/github/followers",
+                "following_url": "https://api.github.com/users/github/following{/other_user}",
+                "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+                "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+                "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+                "organizations_url": "https://api.github.com/users/github/orgs",
+                "repos_url": "https://api.github.com/users/github/repos",
+                "events_url": "https://api.github.com/users/github/events{/privacy}",
+                "received_events_url": "https://api.github.com/users/github/received_events",
+                "type": "Organization",
+                "site_admin": false
+              },
+              "created_at": "2022-07-04T22:19:11Z",
+              "updated_at": "2022-07-04T22:20:11Z"
             },
             {
               "id": 8031,
-              "name": "Designer"
+              "name": "Community manager",
+              "description": "Able to handle all the community interactions without being able to contribute code",
+              "base_role": "read",
+              "permissions": [
+                "mark_as_duplicate",
+                "manage_settings_pages",
+                "manage_settings_wiki",
+                "set_social_preview",
+                "edit_repo_metadata",
+                "toggle_discussion_comment_minimize"
+              ],
+              "organization": {
+                "login": "github",
+                "id": 9919,
+                "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=",
+                "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4",
+                "gravatar_id": "",
+                "url": "https://api.github.com/users/github",
+                "html_url": "https://github.com/github",
+                "followers_url": "https://api.github.com/users/github/followers",
+                "following_url": "https://api.github.com/users/github/following{/other_user}",
+                "gists_url": "https://api.github.com/users/github/gists{/gist_id}",
+                "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}",
+                "subscriptions_url": "https://api.github.com/users/github/subscriptions",
+                "organizations_url": "https://api.github.com/users/github/orgs",
+                "repos_url": "https://api.github.com/users/github/repos",
+                "events_url": "https://api.github.com/users/github/events{/privacy}",
+                "received_events_url": "https://api.github.com/users/github/received_events",
+                "type": "Organization",
+                "site_admin": false
+              },
+              "created_at": "2022-07-05T12:01:11Z",
+              "updated_at": "2022-07-05T12:20:11Z"
             }
           ]
         }
@@ -93375,6 +93834,22 @@
           }
         ]
       },
+      "organization-fine-grained-permission-example": {
+        "value": [
+          {
+            "name": "add_assignee",
+            "description": "Assign or remove a user"
+          },
+          {
+            "name": "remove_assignee",
+            "description": "Remove an assigned user"
+          },
+          {
+            "name": "add_label",
+            "description": "Add or remove a label"
+          }
+        ]
+      },
       "org-hook-items": {
         "value": [
           {
@@ -112948,6 +113423,15 @@
           "type": "string"
         }
       },
+      "role-id": {
+        "name": "role_id",
+        "description": "The unique identifier of the role.",
+        "in": "path",
+        "required": true,
+        "schema": {
+          "type": "integer"
+        }
+      },
       "group-id": {
         "name": "group_id",
         "description": "The unique identifier of the group.",