@octokit/openapi 7.12.1 → 7.13.0

package/generated/api.github.com.deref.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.3",
   "info": {
-    "version": "7.12.1",
+    "version": "7.13.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": {
@@ -207680,7 +207680,7 @@
             }
           },
           "403": {
-            "description": "Response if the repository is archived or if github advanced security is not enabled for this repository",
+            "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
             "content": {
               "application/json": {
                 "schema": {
@@ -208903,7 +208903,7 @@
             }
           },
           "403": {
-            "description": "Response if the repository is archived or if github advanced security is not enabled for this repository",
+            "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
             "content": {
               "application/json": {
                 "schema": {
@@ -208984,6 +208984,713 @@
         "x-octokit": {}
       }
     },
+    "/repos/{owner}/{repo}/code-scanning/codeql/databases": {
+      "get": {
+        "summary": "List CodeQL databases for a repository",
+        "description": "Lists the CodeQL databases that are available in a repository.\n\nFor private repositories, you must use an access token with the `security_events` scope.\nFor public repositories, you can use tokens with the `security_events` or `public_repo` scope.\nGitHub Apps must have the `contents` read permission to use this endpoint.",
+        "tags": [
+          "code-scanning"
+        ],
+        "operationId": "code-scanning/list-codeql-databases",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/code-scanning#list-codeql-databases"
+        },
+        "parameters": [
+          {
+            "name": "owner",
+            "description": "The account owner of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "repo",
+            "description": "The name of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "title": "CodeQL Database",
+                    "description": "A CodeQL database.",
+                    "type": "object",
+                    "properties": {
+                      "id": {
+                        "type": "integer",
+                        "description": "The ID of the CodeQL database."
+                      },
+                      "name": {
+                        "type": "string",
+                        "description": "The name of the CodeQL database."
+                      },
+                      "language": {
+                        "type": "string",
+                        "description": "The language of the CodeQL database."
+                      },
+                      "uploader": {
+                        "title": "Simple User",
+                        "description": "Simple User",
+                        "type": "object",
+                        "properties": {
+                          "name": {
+                            "nullable": true,
+                            "type": "string"
+                          },
+                          "email": {
+                            "nullable": true,
+                            "type": "string"
+                          },
+                          "login": {
+                            "type": "string",
+                            "example": "octocat"
+                          },
+                          "id": {
+                            "type": "integer",
+                            "example": 1
+                          },
+                          "node_id": {
+                            "type": "string",
+                            "example": "MDQ6VXNlcjE="
+                          },
+                          "avatar_url": {
+                            "type": "string",
+                            "format": "uri",
+                            "example": "https://github.com/images/error/octocat_happy.gif"
+                          },
+                          "gravatar_id": {
+                            "type": "string",
+                            "example": "41d064eb2195891e12d0413f63227ea7",
+                            "nullable": true
+                          },
+                          "url": {
+                            "type": "string",
+                            "format": "uri",
+                            "example": "https://api.github.com/users/octocat"
+                          },
+                          "html_url": {
+                            "type": "string",
+                            "format": "uri",
+                            "example": "https://github.com/octocat"
+                          },
+                          "followers_url": {
+                            "type": "string",
+                            "format": "uri",
+                            "example": "https://api.github.com/users/octocat/followers"
+                          },
+                          "following_url": {
+                            "type": "string",
+                            "example": "https://api.github.com/users/octocat/following{/other_user}"
+                          },
+                          "gists_url": {
+                            "type": "string",
+                            "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+                          },
+                          "starred_url": {
+                            "type": "string",
+                            "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+                          },
+                          "subscriptions_url": {
+                            "type": "string",
+                            "format": "uri",
+                            "example": "https://api.github.com/users/octocat/subscriptions"
+                          },
+                          "organizations_url": {
+                            "type": "string",
+                            "format": "uri",
+                            "example": "https://api.github.com/users/octocat/orgs"
+                          },
+                          "repos_url": {
+                            "type": "string",
+                            "format": "uri",
+                            "example": "https://api.github.com/users/octocat/repos"
+                          },
+                          "events_url": {
+                            "type": "string",
+                            "example": "https://api.github.com/users/octocat/events{/privacy}"
+                          },
+                          "received_events_url": {
+                            "type": "string",
+                            "format": "uri",
+                            "example": "https://api.github.com/users/octocat/received_events"
+                          },
+                          "type": {
+                            "type": "string",
+                            "example": "User"
+                          },
+                          "site_admin": {
+                            "type": "boolean"
+                          },
+                          "starred_at": {
+                            "type": "string",
+                            "example": "\"2020-07-09T00:17:55Z\""
+                          }
+                        },
+                        "required": [
+                          "avatar_url",
+                          "events_url",
+                          "followers_url",
+                          "following_url",
+                          "gists_url",
+                          "gravatar_id",
+                          "html_url",
+                          "id",
+                          "node_id",
+                          "login",
+                          "organizations_url",
+                          "received_events_url",
+                          "repos_url",
+                          "site_admin",
+                          "starred_url",
+                          "subscriptions_url",
+                          "type",
+                          "url"
+                        ]
+                      },
+                      "content_type": {
+                        "type": "string",
+                        "description": "The MIME type of the CodeQL database file."
+                      },
+                      "size": {
+                        "type": "integer",
+                        "description": "The size of the CodeQL database file in bytes."
+                      },
+                      "created_at": {
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+                      },
+                      "updated_at": {
+                        "type": "string",
+                        "format": "date-time",
+                        "description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+                      },
+                      "url": {
+                        "type": "string",
+                        "format": "uri",
+                        "description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
+                      }
+                    },
+                    "required": [
+                      "id",
+                      "name",
+                      "language",
+                      "uploader",
+                      "content_type",
+                      "size",
+                      "created_at",
+                      "updated_at",
+                      "url"
+                    ]
+                  }
+                },
+                "examples": {
+                  "default": {
+                    "value": [
+                      {
+                        "id": 1,
+                        "name": "database.zip",
+                        "language": "java",
+                        "uploader": {
+                          "login": "octocat",
+                          "id": 1,
+                          "node_id": "MDQ6VXNlcjE=",
+                          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+                          "gravatar_id": "",
+                          "url": "https://api.github.com/users/octocat",
+                          "html_url": "https://github.com/octocat",
+                          "followers_url": "https://api.github.com/users/octocat/followers",
+                          "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+                          "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+                          "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+                          "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+                          "organizations_url": "https://api.github.com/users/octocat/orgs",
+                          "repos_url": "https://api.github.com/users/octocat/repos",
+                          "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+                          "received_events_url": "https://api.github.com/users/octocat/received_events",
+                          "type": "User",
+                          "site_admin": false
+                        },
+                        "content_type": "application/zip",
+                        "size": 1024,
+                        "created_at": "2022-09-12T12:14:32Z",
+                        "updated_at": "2022-09-12T12:14:32Z",
+                        "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
+                      },
+                      {
+                        "id": 2,
+                        "name": "database.zip",
+                        "language": "ruby",
+                        "uploader": {
+                          "login": "octocat",
+                          "id": 1,
+                          "node_id": "MDQ6VXNlcjE=",
+                          "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+                          "gravatar_id": "",
+                          "url": "https://api.github.com/users/octocat",
+                          "html_url": "https://github.com/octocat",
+                          "followers_url": "https://api.github.com/users/octocat/followers",
+                          "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+                          "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+                          "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+                          "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+                          "organizations_url": "https://api.github.com/users/octocat/orgs",
+                          "repos_url": "https://api.github.com/users/octocat/repos",
+                          "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+                          "received_events_url": "https://api.github.com/users/octocat/received_events",
+                          "type": "User",
+                          "site_admin": false
+                        },
+                        "content_type": "application/zip",
+                        "size": 1024,
+                        "created_at": "2022-09-12T12:14:32Z",
+                        "updated_at": "2022-09-12T12:14:32Z",
+                        "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby"
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Response if GitHub Advanced Security is not enabled for this repository",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Basic Error",
+                  "description": "Basic Error",
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    },
+                    "documentation_url": {
+                      "type": "string"
+                    },
+                    "url": {
+                      "type": "string"
+                    },
+                    "status": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Resource not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Basic Error",
+                  "description": "Basic Error",
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    },
+                    "documentation_url": {
+                      "type": "string"
+                    },
+                    "url": {
+                      "type": "string"
+                    },
+                    "status": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "503": {
+            "description": "Service unavailable",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "code": {
+                      "type": "string"
+                    },
+                    "message": {
+                      "type": "string"
+                    },
+                    "documentation_url": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": true,
+          "enabledForGitHubApps": true,
+          "previews": [],
+          "category": "code-scanning",
+          "subcategory": null
+        },
+        "x-octokit": {}
+      }
+    },
+    "/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": {
+      "get": {
+        "summary": "Get a CodeQL database for a repository",
+        "description": "Gets a CodeQL database for a language in a repository.\n\nBy default this endpoint returns JSON metadata about the CodeQL database. To\ndownload the CodeQL database binary content, set the `Accept` header of the request\nto [`application/zip`](https://docs.github.com/rest/overview/media-types), and make sure\nyour HTTP client is configured to follow redirects or use the `Location` header\nto make a second request to get the redirect URL.\n\nFor private repositories, you must use an access token with the `security_events` scope.\nFor public repositories, you can use tokens with the `security_events` or `public_repo` scope.\nGitHub Apps must have the `contents` read permission to use this endpoint.",
+        "tags": [
+          "code-scanning"
+        ],
+        "operationId": "code-scanning/get-codeql-database",
+        "externalDocs": {
+          "description": "API method documentation",
+          "url": "https://docs.github.com/rest/reference/code-scanning#get-codeql-database"
+        },
+        "parameters": [
+          {
+            "name": "owner",
+            "description": "The account owner of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "repo",
+            "description": "The name of the repository. The name is not case sensitive.",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "name": "language",
+            "in": "path",
+            "description": "The language of the CodeQL database.",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "CodeQL Database",
+                  "description": "A CodeQL database.",
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "integer",
+                      "description": "The ID of the CodeQL database."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "The name of the CodeQL database."
+                    },
+                    "language": {
+                      "type": "string",
+                      "description": "The language of the CodeQL database."
+                    },
+                    "uploader": {
+                      "title": "Simple User",
+                      "description": "Simple User",
+                      "type": "object",
+                      "properties": {
+                        "name": {
+                          "nullable": true,
+                          "type": "string"
+                        },
+                        "email": {
+                          "nullable": true,
+                          "type": "string"
+                        },
+                        "login": {
+                          "type": "string",
+                          "example": "octocat"
+                        },
+                        "id": {
+                          "type": "integer",
+                          "example": 1
+                        },
+                        "node_id": {
+                          "type": "string",
+                          "example": "MDQ6VXNlcjE="
+                        },
+                        "avatar_url": {
+                          "type": "string",
+                          "format": "uri",
+                          "example": "https://github.com/images/error/octocat_happy.gif"
+                        },
+                        "gravatar_id": {
+                          "type": "string",
+                          "example": "41d064eb2195891e12d0413f63227ea7",
+                          "nullable": true
+                        },
+                        "url": {
+                          "type": "string",
+                          "format": "uri",
+                          "example": "https://api.github.com/users/octocat"
+                        },
+                        "html_url": {
+                          "type": "string",
+                          "format": "uri",
+                          "example": "https://github.com/octocat"
+                        },
+                        "followers_url": {
+                          "type": "string",
+                          "format": "uri",
+                          "example": "https://api.github.com/users/octocat/followers"
+                        },
+                        "following_url": {
+                          "type": "string",
+                          "example": "https://api.github.com/users/octocat/following{/other_user}"
+                        },
+                        "gists_url": {
+                          "type": "string",
+                          "example": "https://api.github.com/users/octocat/gists{/gist_id}"
+                        },
+                        "starred_url": {
+                          "type": "string",
+                          "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
+                        },
+                        "subscriptions_url": {
+                          "type": "string",
+                          "format": "uri",
+                          "example": "https://api.github.com/users/octocat/subscriptions"
+                        },
+                        "organizations_url": {
+                          "type": "string",
+                          "format": "uri",
+                          "example": "https://api.github.com/users/octocat/orgs"
+                        },
+                        "repos_url": {
+                          "type": "string",
+                          "format": "uri",
+                          "example": "https://api.github.com/users/octocat/repos"
+                        },
+                        "events_url": {
+                          "type": "string",
+                          "example": "https://api.github.com/users/octocat/events{/privacy}"
+                        },
+                        "received_events_url": {
+                          "type": "string",
+                          "format": "uri",
+                          "example": "https://api.github.com/users/octocat/received_events"
+                        },
+                        "type": {
+                          "type": "string",
+                          "example": "User"
+                        },
+                        "site_admin": {
+                          "type": "boolean"
+                        },
+                        "starred_at": {
+                          "type": "string",
+                          "example": "\"2020-07-09T00:17:55Z\""
+                        }
+                      },
+                      "required": [
+                        "avatar_url",
+                        "events_url",
+                        "followers_url",
+                        "following_url",
+                        "gists_url",
+                        "gravatar_id",
+                        "html_url",
+                        "id",
+                        "node_id",
+                        "login",
+                        "organizations_url",
+                        "received_events_url",
+                        "repos_url",
+                        "site_admin",
+                        "starred_url",
+                        "subscriptions_url",
+                        "type",
+                        "url"
+                      ]
+                    },
+                    "content_type": {
+                      "type": "string",
+                      "description": "The MIME type of the CodeQL database file."
+                    },
+                    "size": {
+                      "type": "integer",
+                      "description": "The size of the CodeQL database file in bytes."
+                    },
+                    "created_at": {
+                      "type": "string",
+                      "format": "date-time",
+                      "description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+                    },
+                    "updated_at": {
+                      "type": "string",
+                      "format": "date-time",
+                      "description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
+                    },
+                    "url": {
+                      "type": "string",
+                      "format": "uri",
+                      "description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
+                    }
+                  },
+                  "required": [
+                    "id",
+                    "name",
+                    "language",
+                    "uploader",
+                    "content_type",
+                    "size",
+                    "created_at",
+                    "updated_at",
+                    "url"
+                  ]
+                },
+                "examples": {
+                  "default": {
+                    "value": {
+                      "id": 1,
+                      "name": "database.zip",
+                      "language": "java",
+                      "uploader": {
+                        "login": "octocat",
+                        "id": 1,
+                        "node_id": "MDQ6VXNlcjE=",
+                        "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+                        "gravatar_id": "",
+                        "url": "https://api.github.com/users/octocat",
+                        "html_url": "https://github.com/octocat",
+                        "followers_url": "https://api.github.com/users/octocat/followers",
+                        "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+                        "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+                        "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+                        "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+                        "organizations_url": "https://api.github.com/users/octocat/orgs",
+                        "repos_url": "https://api.github.com/users/octocat/repos",
+                        "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+                        "received_events_url": "https://api.github.com/users/octocat/received_events",
+                        "type": "User",
+                        "site_admin": false
+                      },
+                      "content_type": "application/zip",
+                      "size": 1024,
+                      "created_at": "2022-09-12T12:14:32Z",
+                      "updated_at": "2022-09-12T12:14:32Z",
+                      "url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "302": {
+            "description": "Found"
+          },
+          "403": {
+            "description": "Response if GitHub Advanced Security is not enabled for this repository",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Basic Error",
+                  "description": "Basic Error",
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    },
+                    "documentation_url": {
+                      "type": "string"
+                    },
+                    "url": {
+                      "type": "string"
+                    },
+                    "status": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Resource not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "title": "Basic Error",
+                  "description": "Basic Error",
+                  "type": "object",
+                  "properties": {
+                    "message": {
+                      "type": "string"
+                    },
+                    "documentation_url": {
+                      "type": "string"
+                    },
+                    "url": {
+                      "type": "string"
+                    },
+                    "status": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "503": {
+            "description": "Service unavailable",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "code": {
+                      "type": "string"
+                    },
+                    "message": {
+                      "type": "string"
+                    },
+                    "documentation_url": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "x-github": {
+          "githubCloudOnly": true,
+          "enabledForGitHubApps": true,
+          "previews": [],
+          "category": "code-scanning",
+          "subcategory": null
+        },
+        "x-octokit": {}
+      }
+    },
     "/repos/{owner}/{repo}/code-scanning/sarifs": {
       "post": {
         "summary": "Upload an analysis as SARIF data",
@@ -209109,7 +209816,7 @@
             "description": "Bad Request if the sarif field is invalid"
           },
           "403": {
-            "description": "Response if the repository is archived or if github advanced security is not enabled for this repository",
+            "description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
             "content": {
               "application/json": {
                 "schema": {
@@ -240516,7 +241223,7 @@
       },
       "put": {
         "summary": "Create or update file contents",
-        "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.",
+        "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.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
         "tags": [
           "repos"
         ],
@@ -241221,7 +241928,7 @@
       },
       "delete": {
         "summary": "Delete a file",
-        "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
+        "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
         "tags": [
           "repos"
         ],