Skip to content

Commit 8ef79ec

Browse files
timrogerstimrogers
authored
Merge pull request #1588 from github/openapi-update-7e1da4a3258d8ac63be35c5892a87fd05390691d2c05df1661105f54716f53ac
Update OpenAPI 3.1 Descriptions
2 parents b8d6727 + 13391ef commit 8ef79ec

File tree

8 files changed

+2131
-615
lines changed

8 files changed

+2131
-615
lines changed

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

Lines changed: 281 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27449,6 +27449,135 @@
2744927449
}
2745027450
}
2745127451
},
27452+
"/repos/{owner}/{repo}/code-scanning/codeql/databases": {
27453+
"get": {
27454+
"summary": "List CodeQL databases for a repository",
27455+
"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.",
27456+
"tags": [
27457+
"code-scanning"
27458+
],
27459+
"operationId": "code-scanning/list-codeql-databases",
27460+
"externalDocs": {
27461+
"description": "API method documentation",
27462+
"url": "https://docs.github.com/rest/reference/code-scanning#list-codeql-databases"
27463+
},
27464+
"parameters": [
27465+
{
27466+
"$ref": "#/components/parameters/owner"
27467+
},
27468+
{
27469+
"$ref": "#/components/parameters/repo"
27470+
}
27471+
],
27472+
"responses": {
27473+
"200": {
27474+
"description": "Response",
27475+
"content": {
27476+
"application/json": {
27477+
"schema": {
27478+
"type": "array",
27479+
"items": {
27480+
"$ref": "#/components/schemas/code-scanning-codeql-database"
27481+
}
27482+
},
27483+
"examples": {
27484+
"default": {
27485+
"$ref": "#/components/examples/code-scanning-codeql-databases"
27486+
}
27487+
}
27488+
}
27489+
}
27490+
},
27491+
"403": {
27492+
"$ref": "#/components/responses/code_scanning_forbidden_read"
27493+
},
27494+
"404": {
27495+
"$ref": "#/components/responses/not_found"
27496+
},
27497+
"503": {
27498+
"$ref": "#/components/responses/service_unavailable"
27499+
}
27500+
},
27501+
"x-github": {
27502+
"githubCloudOnly": false,
27503+
"enabledForGitHubApps": true,
27504+
"previews": [
27505+
27506+
],
27507+
"category": "code-scanning",
27508+
"subcategory": null
27509+
}
27510+
}
27511+
},
27512+
"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": {
27513+
"get": {
27514+
"summary": "Get a CodeQL database for a repository",
27515+
"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.",
27516+
"tags": [
27517+
"code-scanning"
27518+
],
27519+
"operationId": "code-scanning/get-codeql-database",
27520+
"externalDocs": {
27521+
"description": "API method documentation",
27522+
"url": "https://docs.github.com/rest/reference/code-scanning#get-codeql-database"
27523+
},
27524+
"parameters": [
27525+
{
27526+
"$ref": "#/components/parameters/owner"
27527+
},
27528+
{
27529+
"$ref": "#/components/parameters/repo"
27530+
},
27531+
{
27532+
"name": "language",
27533+
"in": "path",
27534+
"description": "The language of the CodeQL database.",
27535+
"schema": {
27536+
"type": "string"
27537+
},
27538+
"required": true
27539+
}
27540+
],
27541+
"responses": {
27542+
"200": {
27543+
"description": "Response",
27544+
"content": {
27545+
"application/json": {
27546+
"schema": {
27547+
"$ref": "#/components/schemas/code-scanning-codeql-database"
27548+
},
27549+
"examples": {
27550+
"default": {
27551+
"$ref": "#/components/examples/code-scanning-codeql-database"
27552+
}
27553+
}
27554+
}
27555+
}
27556+
},
27557+
"302": {
27558+
"$ref": "#/components/responses/found"
27559+
},
27560+
"403": {
27561+
"$ref": "#/components/responses/code_scanning_forbidden_read"
27562+
},
27563+
"404": {
27564+
"$ref": "#/components/responses/not_found"
27565+
},
27566+
"503": {
27567+
"$ref": "#/components/responses/service_unavailable"
27568+
}
27569+
},
27570+
"x-github": {
27571+
"githubCloudOnly": false,
27572+
"enabledForGitHubApps": true,
27573+
"previews": [
27574+
27575+
],
27576+
"category": "code-scanning",
27577+
"subcategory": null
27578+
}
27579+
}
27580+
},
2745227581
"/repos/{owner}/{repo}/code-scanning/sarifs": {
2745327582
"post": {
2745427583
"summary": "Upload an analysis as SARIF data",
@@ -73023,6 +73152,62 @@
7302373152
"confirm_delete_url"
7302473153
]
7302573154
},
73155+
"code-scanning-codeql-database": {
73156+
"title": "CodeQL Database",
73157+
"description": "A CodeQL database.",
73158+
"type": "object",
73159+
"properties": {
73160+
"id": {
73161+
"type": "integer",
73162+
"description": "The ID of the CodeQL database."
73163+
},
73164+
"name": {
73165+
"type": "string",
73166+
"description": "The name of the CodeQL database."
73167+
},
73168+
"language": {
73169+
"type": "string",
73170+
"description": "The language of the CodeQL database."
73171+
},
73172+
"uploader": {
73173+
"$ref": "#/components/schemas/simple-user"
73174+
},
73175+
"content_type": {
73176+
"type": "string",
73177+
"description": "The MIME type of the CodeQL database file."
73178+
},
73179+
"size": {
73180+
"type": "integer",
73181+
"description": "The size of the CodeQL database file in bytes."
73182+
},
73183+
"created_at": {
73184+
"type": "string",
73185+
"format": "date-time",
73186+
"description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
73187+
},
73188+
"updated_at": {
73189+
"type": "string",
73190+
"format": "date-time",
73191+
"description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
73192+
},
73193+
"url": {
73194+
"type": "string",
73195+
"format": "uri",
73196+
"description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
73197+
}
73198+
},
73199+
"required": [
73200+
"id",
73201+
"name",
73202+
"language",
73203+
"uploader",
73204+
"content_type",
73205+
"size",
73206+
"created_at",
73207+
"updated_at",
73208+
"url"
73209+
]
73210+
},
7302673211
"code-scanning-analysis-sarif-file": {
7302773212
"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).\"",
7302873213
"type": "string"
@@ -98392,6 +98577,102 @@
9839298577
"confirm_delete_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete"
9839398578
}
9839498579
},
98580+
"code-scanning-codeql-databases": {
98581+
"value": [
98582+
{
98583+
"id": 1,
98584+
"name": "database.zip",
98585+
"language": "java",
98586+
"uploader": {
98587+
"login": "octocat",
98588+
"id": 1,
98589+
"node_id": "MDQ6VXNlcjE=",
98590+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
98591+
"gravatar_id": "",
98592+
"url": "https://api.github.com/users/octocat",
98593+
"html_url": "https://github.com/octocat",
98594+
"followers_url": "https://api.github.com/users/octocat/followers",
98595+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
98596+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
98597+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
98598+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
98599+
"organizations_url": "https://api.github.com/users/octocat/orgs",
98600+
"repos_url": "https://api.github.com/users/octocat/repos",
98601+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
98602+
"received_events_url": "https://api.github.com/users/octocat/received_events",
98603+
"type": "User",
98604+
"site_admin": false
98605+
},
98606+
"content_type": "application/zip",
98607+
"size": 1024,
98608+
"created_at": "2022-09-12T12:14:32Z",
98609+
"updated_at": "2022-09-12T12:14:32Z",
98610+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
98611+
},
98612+
{
98613+
"id": 2,
98614+
"name": "database.zip",
98615+
"language": "ruby",
98616+
"uploader": {
98617+
"login": "octocat",
98618+
"id": 1,
98619+
"node_id": "MDQ6VXNlcjE=",
98620+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
98621+
"gravatar_id": "",
98622+
"url": "https://api.github.com/users/octocat",
98623+
"html_url": "https://github.com/octocat",
98624+
"followers_url": "https://api.github.com/users/octocat/followers",
98625+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
98626+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
98627+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
98628+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
98629+
"organizations_url": "https://api.github.com/users/octocat/orgs",
98630+
"repos_url": "https://api.github.com/users/octocat/repos",
98631+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
98632+
"received_events_url": "https://api.github.com/users/octocat/received_events",
98633+
"type": "User",
98634+
"site_admin": false
98635+
},
98636+
"content_type": "application/zip",
98637+
"size": 1024,
98638+
"created_at": "2022-09-12T12:14:32Z",
98639+
"updated_at": "2022-09-12T12:14:32Z",
98640+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby"
98641+
}
98642+
]
98643+
},
98644+
"code-scanning-codeql-database": {
98645+
"value": {
98646+
"id": 1,
98647+
"name": "database.zip",
98648+
"language": "java",
98649+
"uploader": {
98650+
"login": "octocat",
98651+
"id": 1,
98652+
"node_id": "MDQ6VXNlcjE=",
98653+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
98654+
"gravatar_id": "",
98655+
"url": "https://api.github.com/users/octocat",
98656+
"html_url": "https://github.com/octocat",
98657+
"followers_url": "https://api.github.com/users/octocat/followers",
98658+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
98659+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
98660+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
98661+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
98662+
"organizations_url": "https://api.github.com/users/octocat/orgs",
98663+
"repos_url": "https://api.github.com/users/octocat/repos",
98664+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
98665+
"received_events_url": "https://api.github.com/users/octocat/received_events",
98666+
"type": "User",
98667+
"site_admin": false
98668+
},
98669+
"content_type": "application/zip",
98670+
"size": 1024,
98671+
"created_at": "2022-09-12T12:14:32Z",
98672+
"updated_at": "2022-09-12T12:14:32Z",
98673+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
98674+
}
98675+
},
9839598676
"code-scanning-sarif-upload": {
9839698677
"summary": "Default response",
9839798678
"value": {

0 commit comments

Comments
 (0)