Skip to content

Commit e3b1d8b

Browse files
authored
Merge pull request #4116 from github/openapi-update-f438324f42488075e2a15524c39d44bbd5937356f1f26464288dc846f972d238
Update OpenAPI 3.1 Descriptions
2 parents 2ddb5f6 + 25aadee commit e3b1d8b

16 files changed

+1028
-32
lines changed

descriptions-next/api.github.com/api.github.com.2022-11-28.json

+54-2
Original file line numberDiff line numberDiff line change
@@ -33314,7 +33314,7 @@
3331433314
"/repos/{owner}/{repo}/code-scanning/codeql/databases": {
3331533315
"get": {
3331633316
"summary": "List CodeQL databases for a repository",
33317-
"description": "Lists the CodeQL databases that are available in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
33317+
"description": "Lists the CodeQL databases that are available in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
3331833318
"tags": [
3331933319
"code-scanning"
3332033320
],
@@ -33374,7 +33374,7 @@
3337433374
"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": {
3337533375
"get": {
3337633376
"summary": "Get a CodeQL database for a repository",
33377-
"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/using-the-rest-api/getting-started-with-the-rest-api#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\nOAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
33377+
"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/using-the-rest-api/getting-started-with-the-rest-api#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\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
3337833378
"tags": [
3337933379
"code-scanning"
3338033380
],
@@ -33434,6 +33434,58 @@
3343433434
"enabledForGitHubApps": true,
3343533435
"previews": [
3343633436

33437+
],
33438+
"category": "code-scanning",
33439+
"subcategory": "code-scanning"
33440+
}
33441+
},
33442+
"delete": {
33443+
"summary": "Delete a CodeQL database",
33444+
"description": "Deletes a CodeQL database for a language in a repository.\n\nOAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.",
33445+
"tags": [
33446+
"code-scanning"
33447+
],
33448+
"operationId": "code-scanning/delete-codeql-database",
33449+
"externalDocs": {
33450+
"description": "API method documentation",
33451+
"url": "https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database"
33452+
},
33453+
"parameters": [
33454+
{
33455+
"$ref": "#/components/parameters/owner"
33456+
},
33457+
{
33458+
"$ref": "#/components/parameters/repo"
33459+
},
33460+
{
33461+
"name": "language",
33462+
"in": "path",
33463+
"description": "The language of the CodeQL database.",
33464+
"schema": {
33465+
"type": "string"
33466+
},
33467+
"required": true
33468+
}
33469+
],
33470+
"responses": {
33471+
"204": {
33472+
"description": "Response"
33473+
},
33474+
"403": {
33475+
"$ref": "#/components/responses/code_scanning_forbidden_write"
33476+
},
33477+
"404": {
33478+
"$ref": "#/components/responses/not_found"
33479+
},
33480+
"503": {
33481+
"$ref": "#/components/responses/service_unavailable"
33482+
}
33483+
},
33484+
"x-github": {
33485+
"githubCloudOnly": false,
33486+
"enabledForGitHubApps": true,
33487+
"previews": [
33488+
3343733489
],
3343833490
"category": "code-scanning",
3343933491
"subcategory": "code-scanning"

0 commit comments

Comments
 (0)