Skip to content

Commit 9040770

Browse files
bearcherianbearcherian
authored
Merge pull request #1547 from github/openapi-update-840915c6f8fa1b37c3688ca6f3c5a7322d9f1ebee0746d0b263d39134d5e8257
Update OpenAPI 3.1 Descriptions
2 parents 4823fcf + 478ee36 commit 9040770

28 files changed

+2221
-705
lines changed

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

Lines changed: 282 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28151,6 +28151,135 @@
2815128151
}
2815228152
}
2815328153
},
28154+
"/repos/{owner}/{repo}/code-scanning/codeql/databases": {
28155+
"get": {
28156+
"summary": "List CodeQL databases for a repository",
28157+
"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.",
28158+
"tags": [
28159+
"code-scanning"
28160+
],
28161+
"operationId": "code-scanning/list-codeql-databases",
28162+
"externalDocs": {
28163+
"description": "API method documentation",
28164+
"url": "https://docs.github.com/rest/reference/code-scanning#list-codeql-databases"
28165+
},
28166+
"parameters": [
28167+
{
28168+
"$ref": "#/components/parameters/owner"
28169+
},
28170+
{
28171+
"$ref": "#/components/parameters/repo"
28172+
}
28173+
],
28174+
"responses": {
28175+
"200": {
28176+
"description": "Response",
28177+
"content": {
28178+
"application/json": {
28179+
"schema": {
28180+
"type": "array",
28181+
"items": {
28182+
"$ref": "#/components/schemas/code-scanning-codeql-database"
28183+
}
28184+
},
28185+
"examples": {
28186+
"default": {
28187+
"$ref": "#/components/examples/code-scanning-codeql-databases"
28188+
}
28189+
}
28190+
}
28191+
}
28192+
},
28193+
"403": {
28194+
"$ref": "#/components/responses/code_scanning_forbidden_read"
28195+
},
28196+
"404": {
28197+
"$ref": "#/components/responses/not_found"
28198+
},
28199+
"503": {
28200+
"$ref": "#/components/responses/service_unavailable"
28201+
}
28202+
},
28203+
"x-github": {
28204+
"githubCloudOnly": true,
28205+
"enabledForGitHubApps": true,
28206+
"previews": [
28207+
28208+
],
28209+
"category": "code-scanning",
28210+
"subcategory": null
28211+
}
28212+
}
28213+
},
28214+
"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": {
28215+
"get": {
28216+
"summary": "Get a CodeQL database for a repository",
28217+
"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.",
28218+
"tags": [
28219+
"code-scanning"
28220+
],
28221+
"operationId": "code-scanning/get-codeql-database",
28222+
"externalDocs": {
28223+
"description": "API method documentation",
28224+
"url": "https://docs.github.com/rest/reference/code-scanning#get-codeql-database"
28225+
},
28226+
"parameters": [
28227+
{
28228+
"$ref": "#/components/parameters/owner"
28229+
},
28230+
{
28231+
"$ref": "#/components/parameters/repo"
28232+
},
28233+
{
28234+
"name": "language",
28235+
"in": "path",
28236+
"description": "The language of the CodeQL database.",
28237+
"schema": {
28238+
"type": "string"
28239+
},
28240+
"required": true
28241+
}
28242+
],
28243+
"responses": {
28244+
"200": {
28245+
"description": "Response",
28246+
"content": {
28247+
"application/json": {
28248+
"schema": {
28249+
"$ref": "#/components/schemas/code-scanning-codeql-database"
28250+
},
28251+
"examples": {
28252+
"default": {
28253+
"$ref": "#/components/examples/code-scanning-codeql-database"
28254+
}
28255+
}
28256+
}
28257+
}
28258+
},
28259+
"302": {
28260+
"$ref": "#/components/responses/found"
28261+
},
28262+
"403": {
28263+
"$ref": "#/components/responses/code_scanning_forbidden_read"
28264+
},
28265+
"404": {
28266+
"$ref": "#/components/responses/not_found"
28267+
},
28268+
"503": {
28269+
"$ref": "#/components/responses/service_unavailable"
28270+
}
28271+
},
28272+
"x-github": {
28273+
"githubCloudOnly": true,
28274+
"enabledForGitHubApps": true,
28275+
"previews": [
28276+
28277+
],
28278+
"category": "code-scanning",
28279+
"subcategory": null
28280+
}
28281+
}
28282+
},
2815428283
"/repos/{owner}/{repo}/code-scanning/sarifs": {
2815528284
"post": {
2815628285
"summary": "Upload an analysis as SARIF data",
@@ -76164,6 +76293,62 @@
7616476293
"confirm_delete_url"
7616576294
]
7616676295
},
76296+
"code-scanning-codeql-database": {
76297+
"title": "CodeQL Database",
76298+
"description": "A CodeQL database.",
76299+
"type": "object",
76300+
"properties": {
76301+
"id": {
76302+
"type": "integer",
76303+
"description": "The ID of the CodeQL database."
76304+
},
76305+
"name": {
76306+
"type": "string",
76307+
"description": "The name of the CodeQL database."
76308+
},
76309+
"language": {
76310+
"type": "string",
76311+
"description": "The language of the CodeQL database."
76312+
},
76313+
"uploader": {
76314+
"$ref": "#/components/schemas/simple-user"
76315+
},
76316+
"content_type": {
76317+
"type": "string",
76318+
"description": "The MIME type of the CodeQL database file."
76319+
},
76320+
"size": {
76321+
"type": "integer",
76322+
"description": "The size of the CodeQL database file in bytes."
76323+
},
76324+
"created_at": {
76325+
"type": "string",
76326+
"format": "date-time",
76327+
"description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
76328+
},
76329+
"updated_at": {
76330+
"type": "string",
76331+
"format": "date-time",
76332+
"description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
76333+
},
76334+
"url": {
76335+
"type": "string",
76336+
"format": "uri",
76337+
"description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
76338+
}
76339+
},
76340+
"required": [
76341+
"id",
76342+
"name",
76343+
"language",
76344+
"uploader",
76345+
"content_type",
76346+
"size",
76347+
"created_at",
76348+
"updated_at",
76349+
"url"
76350+
]
76351+
},
7616776352
"code-scanning-analysis-sarif-file": {
7616876353
"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).\"",
7616976354
"type": "string"
@@ -102401,6 +102586,102 @@
102401102586
"confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete"
102402102587
}
102403102588
},
102589+
"code-scanning-codeql-databases": {
102590+
"value": [
102591+
{
102592+
"id": 1,
102593+
"name": "database.zip",
102594+
"language": "java",
102595+
"uploader": {
102596+
"login": "octocat",
102597+
"id": 1,
102598+
"node_id": "MDQ6VXNlcjE=",
102599+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
102600+
"gravatar_id": "",
102601+
"url": "https://api.github.com/users/octocat",
102602+
"html_url": "https://github.com/octocat",
102603+
"followers_url": "https://api.github.com/users/octocat/followers",
102604+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
102605+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
102606+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
102607+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
102608+
"organizations_url": "https://api.github.com/users/octocat/orgs",
102609+
"repos_url": "https://api.github.com/users/octocat/repos",
102610+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
102611+
"received_events_url": "https://api.github.com/users/octocat/received_events",
102612+
"type": "User",
102613+
"site_admin": false
102614+
},
102615+
"content_type": "application/zip",
102616+
"size": 1024,
102617+
"created_at": "2022-09-12T12:14:32Z",
102618+
"updated_at": "2022-09-12T12:14:32Z",
102619+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
102620+
},
102621+
{
102622+
"id": 2,
102623+
"name": "database.zip",
102624+
"language": "ruby",
102625+
"uploader": {
102626+
"login": "octocat",
102627+
"id": 1,
102628+
"node_id": "MDQ6VXNlcjE=",
102629+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
102630+
"gravatar_id": "",
102631+
"url": "https://api.github.com/users/octocat",
102632+
"html_url": "https://github.com/octocat",
102633+
"followers_url": "https://api.github.com/users/octocat/followers",
102634+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
102635+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
102636+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
102637+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
102638+
"organizations_url": "https://api.github.com/users/octocat/orgs",
102639+
"repos_url": "https://api.github.com/users/octocat/repos",
102640+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
102641+
"received_events_url": "https://api.github.com/users/octocat/received_events",
102642+
"type": "User",
102643+
"site_admin": false
102644+
},
102645+
"content_type": "application/zip",
102646+
"size": 1024,
102647+
"created_at": "2022-09-12T12:14:32Z",
102648+
"updated_at": "2022-09-12T12:14:32Z",
102649+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby"
102650+
}
102651+
]
102652+
},
102653+
"code-scanning-codeql-database": {
102654+
"value": {
102655+
"id": 1,
102656+
"name": "database.zip",
102657+
"language": "java",
102658+
"uploader": {
102659+
"login": "octocat",
102660+
"id": 1,
102661+
"node_id": "MDQ6VXNlcjE=",
102662+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
102663+
"gravatar_id": "",
102664+
"url": "https://api.github.com/users/octocat",
102665+
"html_url": "https://github.com/octocat",
102666+
"followers_url": "https://api.github.com/users/octocat/followers",
102667+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
102668+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
102669+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
102670+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
102671+
"organizations_url": "https://api.github.com/users/octocat/orgs",
102672+
"repos_url": "https://api.github.com/users/octocat/repos",
102673+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
102674+
"received_events_url": "https://api.github.com/users/octocat/received_events",
102675+
"type": "User",
102676+
"site_admin": false
102677+
},
102678+
"content_type": "application/zip",
102679+
"size": 1024,
102680+
"created_at": "2022-09-12T12:14:32Z",
102681+
"updated_at": "2022-09-12T12:14:32Z",
102682+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
102683+
}
102684+
},
102404102685
"code-scanning-sarif-upload": {
102405102686
"summary": "Default response",
102406102687
"value": {
@@ -114842,7 +115123,7 @@
114842115123
}
114843115124
},
114844115125
"code_scanning_forbidden_write": {
114845-
"description": "Response if the repository is archived or if github advanced security is not enabled for this repository",
115126+
"description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
114846115127
"content": {
114847115128
"application/json": {
114848115129
"schema": {

0 commit comments

Comments
 (0)