Skip to content

Update OpenAPI 3.1 Descriptions #4114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Update OpenAPI 3.1 Descriptions #4114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 54 additions & 2 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33314,7 +33314,7 @@
"/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\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.",
"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.",
"tags": [
"code-scanning"
],
Expand Down Expand Up @@ -33374,7 +33374,7 @@
"/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/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.",
"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.",
"tags": [
"code-scanning"
],
Expand Down Expand Up @@ -33434,6 +33434,58 @@
"enabledForGitHubApps": true,
"previews": [

],
"category": "code-scanning",
"subcategory": "code-scanning"
}
},
"delete": {
"summary": "Delete a CodeQL database",
"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.",
"tags": [
"code-scanning"
],
"operationId": "code-scanning/delete-codeql-database",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database"
},
"parameters": [
{
"$ref": "#/components/parameters/owner"
},
{
"$ref": "#/components/parameters/repo"
},
{
"name": "language",
"in": "path",
"description": "The language of the CodeQL database.",
"schema": {
"type": "string"
},
"required": true
}
],
"responses": {
"204": {
"description": "Response"
},
"403": {
"$ref": "#/components/responses/code_scanning_forbidden_write"
},
"404": {
"$ref": "#/components/responses/not_found"
},
"503": {
"$ref": "#/components/responses/service_unavailable"
}
},
"x-github": {
"githubCloudOnly": false,
"enabledForGitHubApps": true,
"previews": [

],
"category": "code-scanning",
"subcategory": "code-scanning"
Expand Down
40 changes: 38 additions & 2 deletions descriptions-next/api.github.com/api.github.com.2022-11-28.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24208,7 +24208,7 @@ paths:
description: |-
Lists the CodeQL databases that are available in a repository.

OAuth 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.
OAuth 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.
tags:
- code-scanning
operationId: code-scanning/list-codeql-databases
Expand Down Expand Up @@ -24254,7 +24254,7 @@ paths:
your HTTP client is configured to follow redirects or use the `Location` header
to make a second request to get the redirect URL.

OAuth 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.
OAuth 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.
tags:
- code-scanning
operationId: code-scanning/get-codeql-database
Expand Down Expand Up @@ -24294,6 +24294,42 @@ paths:
previews: []
category: code-scanning
subcategory: code-scanning
delete:
summary: Delete a CodeQL database
description: |-
Deletes a CodeQL database for a language in a repository.

OAuth 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.
tags:
- code-scanning
operationId: code-scanning/delete-codeql-database
externalDocs:
description: API method documentation
url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database
parameters:
- "$ref": "#/components/parameters/owner"
- "$ref": "#/components/parameters/repo"
- name: language
in: path
description: The language of the CodeQL database.
schema:
type: string
required: true
responses:
'204':
description: Response
'403':
"$ref": "#/components/responses/code_scanning_forbidden_write"
'404':
"$ref": "#/components/responses/not_found"
'503':
"$ref": "#/components/responses/service_unavailable"
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
previews: []
category: code-scanning
subcategory: code-scanning
"/repos/{owner}/{repo}/code-scanning/codeql/variant-analyses":
post:
summary: Create a CodeQL variant analysis
Expand Down
Loading
Loading