Skip to content

Commit cf6bb8b

Browse files
github-openapi-botgithub-openapi-bot
committed
Update OpenAPI 3.0 Descriptions
1 parent 4823fcf commit cf6bb8b

28 files changed

+2161
-729
lines changed

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

Lines changed: 282 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28013,6 +28013,135 @@
2801328013
}
2801428014
}
2801528015
},
28016+
"/repos/{owner}/{repo}/code-scanning/codeql/databases": {
28017+
"get": {
28018+
"summary": "List CodeQL databases for a repository",
28019+
"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.",
28020+
"tags": [
28021+
"code-scanning"
28022+
],
28023+
"operationId": "code-scanning/list-codeql-databases",
28024+
"externalDocs": {
28025+
"description": "API method documentation",
28026+
"url": "https://docs.github.com/rest/reference/code-scanning#list-codeql-databases"
28027+
},
28028+
"parameters": [
28029+
{
28030+
"$ref": "#/components/parameters/owner"
28031+
},
28032+
{
28033+
"$ref": "#/components/parameters/repo"
28034+
}
28035+
],
28036+
"responses": {
28037+
"200": {
28038+
"description": "Response",
28039+
"content": {
28040+
"application/json": {
28041+
"schema": {
28042+
"type": "array",
28043+
"items": {
28044+
"$ref": "#/components/schemas/code-scanning-codeql-database"
28045+
}
28046+
},
28047+
"examples": {
28048+
"default": {
28049+
"$ref": "#/components/examples/code-scanning-codeql-databases"
28050+
}
28051+
}
28052+
}
28053+
}
28054+
},
28055+
"403": {
28056+
"$ref": "#/components/responses/code_scanning_forbidden_read"
28057+
},
28058+
"404": {
28059+
"$ref": "#/components/responses/not_found"
28060+
},
28061+
"503": {
28062+
"$ref": "#/components/responses/service_unavailable"
28063+
}
28064+
},
28065+
"x-github": {
28066+
"githubCloudOnly": true,
28067+
"enabledForGitHubApps": true,
28068+
"previews": [
28069+
28070+
],
28071+
"category": "code-scanning",
28072+
"subcategory": null
28073+
}
28074+
}
28075+
},
28076+
"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": {
28077+
"get": {
28078+
"summary": "Get a CodeQL database for a repository",
28079+
"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.",
28080+
"tags": [
28081+
"code-scanning"
28082+
],
28083+
"operationId": "code-scanning/get-codeql-database",
28084+
"externalDocs": {
28085+
"description": "API method documentation",
28086+
"url": "https://docs.github.com/rest/reference/code-scanning#get-codeql-database"
28087+
},
28088+
"parameters": [
28089+
{
28090+
"$ref": "#/components/parameters/owner"
28091+
},
28092+
{
28093+
"$ref": "#/components/parameters/repo"
28094+
},
28095+
{
28096+
"name": "language",
28097+
"in": "path",
28098+
"description": "The language of the CodeQL database.",
28099+
"schema": {
28100+
"type": "string"
28101+
},
28102+
"required": true
28103+
}
28104+
],
28105+
"responses": {
28106+
"200": {
28107+
"description": "Response",
28108+
"content": {
28109+
"application/json": {
28110+
"schema": {
28111+
"$ref": "#/components/schemas/code-scanning-codeql-database"
28112+
},
28113+
"examples": {
28114+
"default": {
28115+
"$ref": "#/components/examples/code-scanning-codeql-database"
28116+
}
28117+
}
28118+
}
28119+
}
28120+
},
28121+
"302": {
28122+
"$ref": "#/components/responses/found"
28123+
},
28124+
"403": {
28125+
"$ref": "#/components/responses/code_scanning_forbidden_read"
28126+
},
28127+
"404": {
28128+
"$ref": "#/components/responses/not_found"
28129+
},
28130+
"503": {
28131+
"$ref": "#/components/responses/service_unavailable"
28132+
}
28133+
},
28134+
"x-github": {
28135+
"githubCloudOnly": true,
28136+
"enabledForGitHubApps": true,
28137+
"previews": [
28138+
28139+
],
28140+
"category": "code-scanning",
28141+
"subcategory": null
28142+
}
28143+
}
28144+
},
2801628145
"/repos/{owner}/{repo}/code-scanning/sarifs": {
2801728146
"post": {
2801828147
"summary": "Upload an analysis as SARIF data",
@@ -74607,6 +74736,62 @@
7460774736
"confirm_delete_url"
7460874737
]
7460974738
},
74739+
"code-scanning-codeql-database": {
74740+
"title": "CodeQL Database",
74741+
"description": "A CodeQL database.",
74742+
"type": "object",
74743+
"properties": {
74744+
"id": {
74745+
"type": "integer",
74746+
"description": "The ID of the CodeQL database."
74747+
},
74748+
"name": {
74749+
"type": "string",
74750+
"description": "The name of the CodeQL database."
74751+
},
74752+
"language": {
74753+
"type": "string",
74754+
"description": "The language of the CodeQL database."
74755+
},
74756+
"uploader": {
74757+
"$ref": "#/components/schemas/simple-user"
74758+
},
74759+
"content_type": {
74760+
"type": "string",
74761+
"description": "The MIME type of the CodeQL database file."
74762+
},
74763+
"size": {
74764+
"type": "integer",
74765+
"description": "The size of the CodeQL database file in bytes."
74766+
},
74767+
"created_at": {
74768+
"type": "string",
74769+
"format": "date-time",
74770+
"description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
74771+
},
74772+
"updated_at": {
74773+
"type": "string",
74774+
"format": "date-time",
74775+
"description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
74776+
},
74777+
"url": {
74778+
"type": "string",
74779+
"format": "uri",
74780+
"description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
74781+
}
74782+
},
74783+
"required": [
74784+
"id",
74785+
"name",
74786+
"language",
74787+
"uploader",
74788+
"content_type",
74789+
"size",
74790+
"created_at",
74791+
"updated_at",
74792+
"url"
74793+
]
74794+
},
7461074795
"code-scanning-analysis-sarif-file": {
7461174796
"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).\"",
7461274797
"type": "string"
@@ -99499,6 +99684,102 @@
9949999684
"confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete"
9950099685
}
9950199686
},
99687+
"code-scanning-codeql-databases": {
99688+
"value": [
99689+
{
99690+
"id": 1,
99691+
"name": "database.zip",
99692+
"language": "java",
99693+
"uploader": {
99694+
"login": "octocat",
99695+
"id": 1,
99696+
"node_id": "MDQ6VXNlcjE=",
99697+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
99698+
"gravatar_id": "",
99699+
"url": "https://api.github.com/users/octocat",
99700+
"html_url": "https://github.com/octocat",
99701+
"followers_url": "https://api.github.com/users/octocat/followers",
99702+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
99703+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
99704+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
99705+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
99706+
"organizations_url": "https://api.github.com/users/octocat/orgs",
99707+
"repos_url": "https://api.github.com/users/octocat/repos",
99708+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
99709+
"received_events_url": "https://api.github.com/users/octocat/received_events",
99710+
"type": "User",
99711+
"site_admin": false
99712+
},
99713+
"content_type": "application/zip",
99714+
"size": 1024,
99715+
"created_at": "2022-09-12T12:14:32Z",
99716+
"updated_at": "2022-09-12T12:14:32Z",
99717+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
99718+
},
99719+
{
99720+
"id": 2,
99721+
"name": "database.zip",
99722+
"language": "ruby",
99723+
"uploader": {
99724+
"login": "octocat",
99725+
"id": 1,
99726+
"node_id": "MDQ6VXNlcjE=",
99727+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
99728+
"gravatar_id": "",
99729+
"url": "https://api.github.com/users/octocat",
99730+
"html_url": "https://github.com/octocat",
99731+
"followers_url": "https://api.github.com/users/octocat/followers",
99732+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
99733+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
99734+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
99735+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
99736+
"organizations_url": "https://api.github.com/users/octocat/orgs",
99737+
"repos_url": "https://api.github.com/users/octocat/repos",
99738+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
99739+
"received_events_url": "https://api.github.com/users/octocat/received_events",
99740+
"type": "User",
99741+
"site_admin": false
99742+
},
99743+
"content_type": "application/zip",
99744+
"size": 1024,
99745+
"created_at": "2022-09-12T12:14:32Z",
99746+
"updated_at": "2022-09-12T12:14:32Z",
99747+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby"
99748+
}
99749+
]
99750+
},
99751+
"code-scanning-codeql-database": {
99752+
"value": {
99753+
"id": 1,
99754+
"name": "database.zip",
99755+
"language": "java",
99756+
"uploader": {
99757+
"login": "octocat",
99758+
"id": 1,
99759+
"node_id": "MDQ6VXNlcjE=",
99760+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
99761+
"gravatar_id": "",
99762+
"url": "https://api.github.com/users/octocat",
99763+
"html_url": "https://github.com/octocat",
99764+
"followers_url": "https://api.github.com/users/octocat/followers",
99765+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
99766+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
99767+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
99768+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
99769+
"organizations_url": "https://api.github.com/users/octocat/orgs",
99770+
"repos_url": "https://api.github.com/users/octocat/repos",
99771+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
99772+
"received_events_url": "https://api.github.com/users/octocat/received_events",
99773+
"type": "User",
99774+
"site_admin": false
99775+
},
99776+
"content_type": "application/zip",
99777+
"size": 1024,
99778+
"created_at": "2022-09-12T12:14:32Z",
99779+
"updated_at": "2022-09-12T12:14:32Z",
99780+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
99781+
}
99782+
},
9950299783
"code-scanning-sarif-upload": {
9950399784
"summary": "Default response",
9950499785
"value": {
@@ -111938,7 +112219,7 @@
111938112219
}
111939112220
},
111940112221
"code_scanning_forbidden_write": {
111941-
"description": "Response if the repository is archived or if github advanced security is not enabled for this repository",
112222+
"description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
111942112223
"content": {
111943112224
"application/json": {
111944112225
"schema": {

0 commit comments

Comments
 (0)