Skip to content

Commit b8d6727

Browse files
timrogerstimrogers
authored
Merge pull request #1587 from github/openapi-update-7fddd91ce9ce8f11bd4d83158b41ff9d76285c9b4f29f3a086dae194ad089891
Update OpenAPI 3.0 Descriptions
2 parents ee8353d + 33d37cd commit b8d6727

File tree

8 files changed

+2071
-639
lines changed

8 files changed

+2071
-639
lines changed

‎descriptions/api.github.com/api.github.com.json

Lines changed: 281 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27313,6 +27313,135 @@
2731327313
}
2731427314
}
2731527315
},
27316+
"/repos/{owner}/{repo}/code-scanning/codeql/databases": {
27317+
"get": {
27318+
"summary": "List CodeQL databases for a repository",
27319+
"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.",
27320+
"tags": [
27321+
"code-scanning"
27322+
],
27323+
"operationId": "code-scanning/list-codeql-databases",
27324+
"externalDocs": {
27325+
"description": "API method documentation",
27326+
"url": "https://docs.github.com/rest/reference/code-scanning#list-codeql-databases"
27327+
},
27328+
"parameters": [
27329+
{
27330+
"$ref": "#/components/parameters/owner"
27331+
},
27332+
{
27333+
"$ref": "#/components/parameters/repo"
27334+
}
27335+
],
27336+
"responses": {
27337+
"200": {
27338+
"description": "Response",
27339+
"content": {
27340+
"application/json": {
27341+
"schema": {
27342+
"type": "array",
27343+
"items": {
27344+
"$ref": "#/components/schemas/code-scanning-codeql-database"
27345+
}
27346+
},
27347+
"examples": {
27348+
"default": {
27349+
"$ref": "#/components/examples/code-scanning-codeql-databases"
27350+
}
27351+
}
27352+
}
27353+
}
27354+
},
27355+
"403": {
27356+
"$ref": "#/components/responses/code_scanning_forbidden_read"
27357+
},
27358+
"404": {
27359+
"$ref": "#/components/responses/not_found"
27360+
},
27361+
"503": {
27362+
"$ref": "#/components/responses/service_unavailable"
27363+
}
27364+
},
27365+
"x-github": {
27366+
"githubCloudOnly": false,
27367+
"enabledForGitHubApps": true,
27368+
"previews": [
27369+
27370+
],
27371+
"category": "code-scanning",
27372+
"subcategory": null
27373+
}
27374+
}
27375+
},
27376+
"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": {
27377+
"get": {
27378+
"summary": "Get a CodeQL database for a repository",
27379+
"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.",
27380+
"tags": [
27381+
"code-scanning"
27382+
],
27383+
"operationId": "code-scanning/get-codeql-database",
27384+
"externalDocs": {
27385+
"description": "API method documentation",
27386+
"url": "https://docs.github.com/rest/reference/code-scanning#get-codeql-database"
27387+
},
27388+
"parameters": [
27389+
{
27390+
"$ref": "#/components/parameters/owner"
27391+
},
27392+
{
27393+
"$ref": "#/components/parameters/repo"
27394+
},
27395+
{
27396+
"name": "language",
27397+
"in": "path",
27398+
"description": "The language of the CodeQL database.",
27399+
"schema": {
27400+
"type": "string"
27401+
},
27402+
"required": true
27403+
}
27404+
],
27405+
"responses": {
27406+
"200": {
27407+
"description": "Response",
27408+
"content": {
27409+
"application/json": {
27410+
"schema": {
27411+
"$ref": "#/components/schemas/code-scanning-codeql-database"
27412+
},
27413+
"examples": {
27414+
"default": {
27415+
"$ref": "#/components/examples/code-scanning-codeql-database"
27416+
}
27417+
}
27418+
}
27419+
}
27420+
},
27421+
"302": {
27422+
"$ref": "#/components/responses/found"
27423+
},
27424+
"403": {
27425+
"$ref": "#/components/responses/code_scanning_forbidden_read"
27426+
},
27427+
"404": {
27428+
"$ref": "#/components/responses/not_found"
27429+
},
27430+
"503": {
27431+
"$ref": "#/components/responses/service_unavailable"
27432+
}
27433+
},
27434+
"x-github": {
27435+
"githubCloudOnly": false,
27436+
"enabledForGitHubApps": true,
27437+
"previews": [
27438+
27439+
],
27440+
"category": "code-scanning",
27441+
"subcategory": null
27442+
}
27443+
}
27444+
},
2731627445
"/repos/{owner}/{repo}/code-scanning/sarifs": {
2731727446
"post": {
2731827447
"summary": "Upload an analysis as SARIF data",
@@ -71556,6 +71685,62 @@
7155671685
"confirm_delete_url"
7155771686
]
7155871687
},
71688+
"code-scanning-codeql-database": {
71689+
"title": "CodeQL Database",
71690+
"description": "A CodeQL database.",
71691+
"type": "object",
71692+
"properties": {
71693+
"id": {
71694+
"type": "integer",
71695+
"description": "The ID of the CodeQL database."
71696+
},
71697+
"name": {
71698+
"type": "string",
71699+
"description": "The name of the CodeQL database."
71700+
},
71701+
"language": {
71702+
"type": "string",
71703+
"description": "The language of the CodeQL database."
71704+
},
71705+
"uploader": {
71706+
"$ref": "#/components/schemas/simple-user"
71707+
},
71708+
"content_type": {
71709+
"type": "string",
71710+
"description": "The MIME type of the CodeQL database file."
71711+
},
71712+
"size": {
71713+
"type": "integer",
71714+
"description": "The size of the CodeQL database file in bytes."
71715+
},
71716+
"created_at": {
71717+
"type": "string",
71718+
"format": "date-time",
71719+
"description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
71720+
},
71721+
"updated_at": {
71722+
"type": "string",
71723+
"format": "date-time",
71724+
"description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
71725+
},
71726+
"url": {
71727+
"type": "string",
71728+
"format": "uri",
71729+
"description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
71730+
}
71731+
},
71732+
"required": [
71733+
"id",
71734+
"name",
71735+
"language",
71736+
"uploader",
71737+
"content_type",
71738+
"size",
71739+
"created_at",
71740+
"updated_at",
71741+
"url"
71742+
]
71743+
},
7155971744
"code-scanning-analysis-sarif-file": {
7156071745
"description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/code-security/secure-coding/sarif-support-for-code-scanning).\"",
7156171746
"type": "string"
@@ -95632,6 +95817,102 @@
9563295817
"confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete"
9563395818
}
9563495819
},
95820+
"code-scanning-codeql-databases": {
95821+
"value": [
95822+
{
95823+
"id": 1,
95824+
"name": "database.zip",
95825+
"language": "java",
95826+
"uploader": {
95827+
"login": "octocat",
95828+
"id": 1,
95829+
"node_id": "MDQ6VXNlcjE=",
95830+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
95831+
"gravatar_id": "",
95832+
"url": "https://api.github.com/users/octocat",
95833+
"html_url": "https://github.com/octocat",
95834+
"followers_url": "https://api.github.com/users/octocat/followers",
95835+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
95836+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
95837+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
95838+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
95839+
"organizations_url": "https://api.github.com/users/octocat/orgs",
95840+
"repos_url": "https://api.github.com/users/octocat/repos",
95841+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
95842+
"received_events_url": "https://api.github.com/users/octocat/received_events",
95843+
"type": "User",
95844+
"site_admin": false
95845+
},
95846+
"content_type": "application/zip",
95847+
"size": 1024,
95848+
"created_at": "2022-09-12T12:14:32Z",
95849+
"updated_at": "2022-09-12T12:14:32Z",
95850+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
95851+
},
95852+
{
95853+
"id": 2,
95854+
"name": "database.zip",
95855+
"language": "ruby",
95856+
"uploader": {
95857+
"login": "octocat",
95858+
"id": 1,
95859+
"node_id": "MDQ6VXNlcjE=",
95860+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
95861+
"gravatar_id": "",
95862+
"url": "https://api.github.com/users/octocat",
95863+
"html_url": "https://github.com/octocat",
95864+
"followers_url": "https://api.github.com/users/octocat/followers",
95865+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
95866+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
95867+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
95868+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
95869+
"organizations_url": "https://api.github.com/users/octocat/orgs",
95870+
"repos_url": "https://api.github.com/users/octocat/repos",
95871+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
95872+
"received_events_url": "https://api.github.com/users/octocat/received_events",
95873+
"type": "User",
95874+
"site_admin": false
95875+
},
95876+
"content_type": "application/zip",
95877+
"size": 1024,
95878+
"created_at": "2022-09-12T12:14:32Z",
95879+
"updated_at": "2022-09-12T12:14:32Z",
95880+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby"
95881+
}
95882+
]
95883+
},
95884+
"code-scanning-codeql-database": {
95885+
"value": {
95886+
"id": 1,
95887+
"name": "database.zip",
95888+
"language": "java",
95889+
"uploader": {
95890+
"login": "octocat",
95891+
"id": 1,
95892+
"node_id": "MDQ6VXNlcjE=",
95893+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
95894+
"gravatar_id": "",
95895+
"url": "https://api.github.com/users/octocat",
95896+
"html_url": "https://github.com/octocat",
95897+
"followers_url": "https://api.github.com/users/octocat/followers",
95898+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
95899+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
95900+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
95901+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
95902+
"organizations_url": "https://api.github.com/users/octocat/orgs",
95903+
"repos_url": "https://api.github.com/users/octocat/repos",
95904+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
95905+
"received_events_url": "https://api.github.com/users/octocat/received_events",
95906+
"type": "User",
95907+
"site_admin": false
95908+
},
95909+
"content_type": "application/zip",
95910+
"size": 1024,
95911+
"created_at": "2022-09-12T12:14:32Z",
95912+
"updated_at": "2022-09-12T12:14:32Z",
95913+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
95914+
}
95915+
},
9563595916
"code-scanning-sarif-upload": {
9563695917
"summary": "Default response",
9563795918
"value": {

0 commit comments

Comments
 (0)