Skip to content

Commit 2ddb5f6

Browse files
authored
Merge pull request #4115 from github/openapi-update-441ed640fecbfa54c49c80f3a0aebf5a677f779d9ad143bb5d70a737aadf8303
Update OpenAPI 3.0 Descriptions
2 parents c8e5a99 + 21c2e2d commit 2ddb5f6

16 files changed

+1028
-32
lines changed

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

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33168,7 +33168,7 @@
3316833168
"/repos/{owner}/{repo}/code-scanning/codeql/databases": {
3316933169
"get": {
3317033170
"summary": "List CodeQL databases for a repository",
33171-
"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.",
33171+
"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.",
3317233172
"tags": [
3317333173
"code-scanning"
3317433174
],
@@ -33228,7 +33228,7 @@
3322833228
"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": {
3322933229
"get": {
3323033230
"summary": "Get a CodeQL database for a repository",
33231-
"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.",
33231+
"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.",
3323233232
"tags": [
3323333233
"code-scanning"
3323433234
],
@@ -33288,6 +33288,58 @@
3328833288
"enabledForGitHubApps": true,
3328933289
"previews": [
3329033290

33291+
],
33292+
"category": "code-scanning",
33293+
"subcategory": "code-scanning"
33294+
}
33295+
},
33296+
"delete": {
33297+
"summary": "Delete a CodeQL database",
33298+
"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.",
33299+
"tags": [
33300+
"code-scanning"
33301+
],
33302+
"operationId": "code-scanning/delete-codeql-database",
33303+
"externalDocs": {
33304+
"description": "API method documentation",
33305+
"url": "https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database"
33306+
},
33307+
"parameters": [
33308+
{
33309+
"$ref": "#/components/parameters/owner"
33310+
},
33311+
{
33312+
"$ref": "#/components/parameters/repo"
33313+
},
33314+
{
33315+
"name": "language",
33316+
"in": "path",
33317+
"description": "The language of the CodeQL database.",
33318+
"schema": {
33319+
"type": "string"
33320+
},
33321+
"required": true
33322+
}
33323+
],
33324+
"responses": {
33325+
"204": {
33326+
"description": "Response"
33327+
},
33328+
"403": {
33329+
"$ref": "#/components/responses/code_scanning_forbidden_write"
33330+
},
33331+
"404": {
33332+
"$ref": "#/components/responses/not_found"
33333+
},
33334+
"503": {
33335+
"$ref": "#/components/responses/service_unavailable"
33336+
}
33337+
},
33338+
"x-github": {
33339+
"githubCloudOnly": false,
33340+
"enabledForGitHubApps": true,
33341+
"previews": [
33342+
3329133343
],
3329233344
"category": "code-scanning",
3329333345
"subcategory": "code-scanning"

0 commit comments

Comments
 (0)