@octokit/openapi 7.12.1 → 7.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated/api.github.com.deref.json +739 -6
- package/generated/api.github.com.json +290 -4
- package/generated/ghes-3.2-diff-to-api.github.com.deref.json +1 -1
- package/generated/ghes-3.2-diff-to-api.github.com.json +1 -1
- package/generated/ghes-3.2-diff-to-ghes-3.3.deref.json +5 -2
- package/generated/ghes-3.2-diff-to-ghes-3.3.json +3 -2
- package/generated/ghes-3.2.deref.json +9 -6
- package/generated/ghes-3.2.json +5 -4
- package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +2 -2
- package/generated/ghes-3.3-diff-to-ghes-3.4.json +2 -2
- package/generated/ghes-3.3.deref.json +9 -6
- package/generated/ghes-3.3.json +5 -4
- package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +4 -1
- package/generated/ghes-3.4-diff-to-ghes-3.5.json +2 -1
- package/generated/ghes-3.4.deref.json +9 -6
- package/generated/ghes-3.4.json +5 -4
- package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +11 -0
- package/generated/ghes-3.5-diff-to-api.github.com.deref.json +1 -1
- package/generated/ghes-3.5-diff-to-api.github.com.json +1 -1
- package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +6 -2
- package/generated/ghes-3.5-diff-to-ghes-3.6.json +3 -2
- package/generated/ghes-3.5.deref.json +116 -6
- package/generated/ghes-3.5.json +111 -4
- package/generated/ghes-3.6-anicca-diff-to-api.github.com.deref.json +106 -11
- package/generated/ghes-3.6-diff-to-api.github.com.deref.json +8888 -1
- package/generated/ghes-3.6-diff-to-api.github.com.json +376 -1
- package/generated/ghes-3.6.deref.json +779 -116
- package/generated/ghes-3.6.json +542 -113
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +6 -0
- package/generated/github.ae-diff-to-api.github.com.deref.json +28 -2
- package/generated/github.ae-diff-to-api.github.com.json +9 -2
- package/generated/github.ae.deref.json +76 -6
- package/generated/github.ae.json +55 -4
- package/package.json +1 -1
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "7.
|
|
4
|
+
"version": "7.14.0",
|
|
5
5
|
"title": "GitHub's official OpenAPI spec + Octokit extension",
|
|
6
6
|
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
|
|
7
7
|
"license": {
|
|
@@ -151738,6 +151738,11 @@
|
|
|
151738
151738
|
"head_repository_id": {
|
|
151739
151739
|
"type": "integer",
|
|
151740
151740
|
"example": 5
|
|
151741
|
+
},
|
|
151742
|
+
"display_title": {
|
|
151743
|
+
"type": "string",
|
|
151744
|
+
"example": "Simple Workflow",
|
|
151745
|
+
"description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow."
|
|
151741
151746
|
}
|
|
151742
151747
|
},
|
|
151743
151748
|
"required": [
|
|
@@ -151745,6 +151750,7 @@
|
|
|
151745
151750
|
"node_id",
|
|
151746
151751
|
"head_branch",
|
|
151747
151752
|
"run_number",
|
|
151753
|
+
"display_title",
|
|
151748
151754
|
"event",
|
|
151749
151755
|
"status",
|
|
151750
151756
|
"conclusion",
|
|
@@ -156168,6 +156174,11 @@
|
|
|
156168
156174
|
"head_repository_id": {
|
|
156169
156175
|
"type": "integer",
|
|
156170
156176
|
"example": 5
|
|
156177
|
+
},
|
|
156178
|
+
"display_title": {
|
|
156179
|
+
"type": "string",
|
|
156180
|
+
"example": "Simple Workflow",
|
|
156181
|
+
"description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow."
|
|
156171
156182
|
}
|
|
156172
156183
|
},
|
|
156173
156184
|
"required": [
|
|
@@ -156175,6 +156186,7 @@
|
|
|
156175
156186
|
"node_id",
|
|
156176
156187
|
"head_branch",
|
|
156177
156188
|
"run_number",
|
|
156189
|
+
"display_title",
|
|
156178
156190
|
"event",
|
|
156179
156191
|
"status",
|
|
156180
156192
|
"conclusion",
|
|
@@ -156211,6 +156223,7 @@
|
|
|
156211
156223
|
"path": ".github/workflows/build.yml@main",
|
|
156212
156224
|
"run_number": 562,
|
|
156213
156225
|
"event": "push",
|
|
156226
|
+
"display_title": "Update README.md",
|
|
156214
156227
|
"status": "queued",
|
|
156215
156228
|
"conclusion": null,
|
|
156216
156229
|
"workflow_id": 159038,
|
|
@@ -161314,6 +161327,11 @@
|
|
|
161314
161327
|
"head_repository_id": {
|
|
161315
161328
|
"type": "integer",
|
|
161316
161329
|
"example": 5
|
|
161330
|
+
},
|
|
161331
|
+
"display_title": {
|
|
161332
|
+
"type": "string",
|
|
161333
|
+
"example": "Simple Workflow",
|
|
161334
|
+
"description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow."
|
|
161317
161335
|
}
|
|
161318
161336
|
},
|
|
161319
161337
|
"required": [
|
|
@@ -161321,6 +161339,7 @@
|
|
|
161321
161339
|
"node_id",
|
|
161322
161340
|
"head_branch",
|
|
161323
161341
|
"run_number",
|
|
161342
|
+
"display_title",
|
|
161324
161343
|
"event",
|
|
161325
161344
|
"status",
|
|
161326
161345
|
"conclusion",
|
|
@@ -161357,6 +161376,7 @@
|
|
|
161357
161376
|
"path": ".github/workflows/build.yml@main",
|
|
161358
161377
|
"run_number": 562,
|
|
161359
161378
|
"event": "push",
|
|
161379
|
+
"display_title": "Update README.md",
|
|
161360
161380
|
"status": "queued",
|
|
161361
161381
|
"conclusion": null,
|
|
161362
161382
|
"workflow_id": 159038,
|
|
@@ -169666,6 +169686,11 @@
|
|
|
169666
169686
|
"head_repository_id": {
|
|
169667
169687
|
"type": "integer",
|
|
169668
169688
|
"example": 5
|
|
169689
|
+
},
|
|
169690
|
+
"display_title": {
|
|
169691
|
+
"type": "string",
|
|
169692
|
+
"example": "Simple Workflow",
|
|
169693
|
+
"description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow."
|
|
169669
169694
|
}
|
|
169670
169695
|
},
|
|
169671
169696
|
"required": [
|
|
@@ -169673,6 +169698,7 @@
|
|
|
169673
169698
|
"node_id",
|
|
169674
169699
|
"head_branch",
|
|
169675
169700
|
"run_number",
|
|
169701
|
+
"display_title",
|
|
169676
169702
|
"event",
|
|
169677
169703
|
"status",
|
|
169678
169704
|
"conclusion",
|
|
@@ -207680,7 +207706,7 @@
|
|
|
207680
207706
|
}
|
|
207681
207707
|
},
|
|
207682
207708
|
"403": {
|
|
207683
|
-
"description": "Response if the repository is archived or if
|
|
207709
|
+
"description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
|
|
207684
207710
|
"content": {
|
|
207685
207711
|
"application/json": {
|
|
207686
207712
|
"schema": {
|
|
@@ -208903,7 +208929,7 @@
|
|
|
208903
208929
|
}
|
|
208904
208930
|
},
|
|
208905
208931
|
"403": {
|
|
208906
|
-
"description": "Response if the repository is archived or if
|
|
208932
|
+
"description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
|
|
208907
208933
|
"content": {
|
|
208908
208934
|
"application/json": {
|
|
208909
208935
|
"schema": {
|
|
@@ -208984,6 +209010,713 @@
|
|
|
208984
209010
|
"x-octokit": {}
|
|
208985
209011
|
}
|
|
208986
209012
|
},
|
|
209013
|
+
"/repos/{owner}/{repo}/code-scanning/codeql/databases": {
|
|
209014
|
+
"get": {
|
|
209015
|
+
"summary": "List CodeQL databases for a repository",
|
|
209016
|
+
"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.",
|
|
209017
|
+
"tags": [
|
|
209018
|
+
"code-scanning"
|
|
209019
|
+
],
|
|
209020
|
+
"operationId": "code-scanning/list-codeql-databases",
|
|
209021
|
+
"externalDocs": {
|
|
209022
|
+
"description": "API method documentation",
|
|
209023
|
+
"url": "https://docs.github.com/rest/reference/code-scanning#list-codeql-databases"
|
|
209024
|
+
},
|
|
209025
|
+
"parameters": [
|
|
209026
|
+
{
|
|
209027
|
+
"name": "owner",
|
|
209028
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
209029
|
+
"in": "path",
|
|
209030
|
+
"required": true,
|
|
209031
|
+
"schema": {
|
|
209032
|
+
"type": "string"
|
|
209033
|
+
}
|
|
209034
|
+
},
|
|
209035
|
+
{
|
|
209036
|
+
"name": "repo",
|
|
209037
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
209038
|
+
"in": "path",
|
|
209039
|
+
"required": true,
|
|
209040
|
+
"schema": {
|
|
209041
|
+
"type": "string"
|
|
209042
|
+
}
|
|
209043
|
+
}
|
|
209044
|
+
],
|
|
209045
|
+
"responses": {
|
|
209046
|
+
"200": {
|
|
209047
|
+
"description": "Response",
|
|
209048
|
+
"content": {
|
|
209049
|
+
"application/json": {
|
|
209050
|
+
"schema": {
|
|
209051
|
+
"type": "array",
|
|
209052
|
+
"items": {
|
|
209053
|
+
"title": "CodeQL Database",
|
|
209054
|
+
"description": "A CodeQL database.",
|
|
209055
|
+
"type": "object",
|
|
209056
|
+
"properties": {
|
|
209057
|
+
"id": {
|
|
209058
|
+
"type": "integer",
|
|
209059
|
+
"description": "The ID of the CodeQL database."
|
|
209060
|
+
},
|
|
209061
|
+
"name": {
|
|
209062
|
+
"type": "string",
|
|
209063
|
+
"description": "The name of the CodeQL database."
|
|
209064
|
+
},
|
|
209065
|
+
"language": {
|
|
209066
|
+
"type": "string",
|
|
209067
|
+
"description": "The language of the CodeQL database."
|
|
209068
|
+
},
|
|
209069
|
+
"uploader": {
|
|
209070
|
+
"title": "Simple User",
|
|
209071
|
+
"description": "Simple User",
|
|
209072
|
+
"type": "object",
|
|
209073
|
+
"properties": {
|
|
209074
|
+
"name": {
|
|
209075
|
+
"nullable": true,
|
|
209076
|
+
"type": "string"
|
|
209077
|
+
},
|
|
209078
|
+
"email": {
|
|
209079
|
+
"nullable": true,
|
|
209080
|
+
"type": "string"
|
|
209081
|
+
},
|
|
209082
|
+
"login": {
|
|
209083
|
+
"type": "string",
|
|
209084
|
+
"example": "octocat"
|
|
209085
|
+
},
|
|
209086
|
+
"id": {
|
|
209087
|
+
"type": "integer",
|
|
209088
|
+
"example": 1
|
|
209089
|
+
},
|
|
209090
|
+
"node_id": {
|
|
209091
|
+
"type": "string",
|
|
209092
|
+
"example": "MDQ6VXNlcjE="
|
|
209093
|
+
},
|
|
209094
|
+
"avatar_url": {
|
|
209095
|
+
"type": "string",
|
|
209096
|
+
"format": "uri",
|
|
209097
|
+
"example": "https://github.com/images/error/octocat_happy.gif"
|
|
209098
|
+
},
|
|
209099
|
+
"gravatar_id": {
|
|
209100
|
+
"type": "string",
|
|
209101
|
+
"example": "41d064eb2195891e12d0413f63227ea7",
|
|
209102
|
+
"nullable": true
|
|
209103
|
+
},
|
|
209104
|
+
"url": {
|
|
209105
|
+
"type": "string",
|
|
209106
|
+
"format": "uri",
|
|
209107
|
+
"example": "https://api.github.com/users/octocat"
|
|
209108
|
+
},
|
|
209109
|
+
"html_url": {
|
|
209110
|
+
"type": "string",
|
|
209111
|
+
"format": "uri",
|
|
209112
|
+
"example": "https://github.com/octocat"
|
|
209113
|
+
},
|
|
209114
|
+
"followers_url": {
|
|
209115
|
+
"type": "string",
|
|
209116
|
+
"format": "uri",
|
|
209117
|
+
"example": "https://api.github.com/users/octocat/followers"
|
|
209118
|
+
},
|
|
209119
|
+
"following_url": {
|
|
209120
|
+
"type": "string",
|
|
209121
|
+
"example": "https://api.github.com/users/octocat/following{/other_user}"
|
|
209122
|
+
},
|
|
209123
|
+
"gists_url": {
|
|
209124
|
+
"type": "string",
|
|
209125
|
+
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
|
|
209126
|
+
},
|
|
209127
|
+
"starred_url": {
|
|
209128
|
+
"type": "string",
|
|
209129
|
+
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
|
|
209130
|
+
},
|
|
209131
|
+
"subscriptions_url": {
|
|
209132
|
+
"type": "string",
|
|
209133
|
+
"format": "uri",
|
|
209134
|
+
"example": "https://api.github.com/users/octocat/subscriptions"
|
|
209135
|
+
},
|
|
209136
|
+
"organizations_url": {
|
|
209137
|
+
"type": "string",
|
|
209138
|
+
"format": "uri",
|
|
209139
|
+
"example": "https://api.github.com/users/octocat/orgs"
|
|
209140
|
+
},
|
|
209141
|
+
"repos_url": {
|
|
209142
|
+
"type": "string",
|
|
209143
|
+
"format": "uri",
|
|
209144
|
+
"example": "https://api.github.com/users/octocat/repos"
|
|
209145
|
+
},
|
|
209146
|
+
"events_url": {
|
|
209147
|
+
"type": "string",
|
|
209148
|
+
"example": "https://api.github.com/users/octocat/events{/privacy}"
|
|
209149
|
+
},
|
|
209150
|
+
"received_events_url": {
|
|
209151
|
+
"type": "string",
|
|
209152
|
+
"format": "uri",
|
|
209153
|
+
"example": "https://api.github.com/users/octocat/received_events"
|
|
209154
|
+
},
|
|
209155
|
+
"type": {
|
|
209156
|
+
"type": "string",
|
|
209157
|
+
"example": "User"
|
|
209158
|
+
},
|
|
209159
|
+
"site_admin": {
|
|
209160
|
+
"type": "boolean"
|
|
209161
|
+
},
|
|
209162
|
+
"starred_at": {
|
|
209163
|
+
"type": "string",
|
|
209164
|
+
"example": "\"2020-07-09T00:17:55Z\""
|
|
209165
|
+
}
|
|
209166
|
+
},
|
|
209167
|
+
"required": [
|
|
209168
|
+
"avatar_url",
|
|
209169
|
+
"events_url",
|
|
209170
|
+
"followers_url",
|
|
209171
|
+
"following_url",
|
|
209172
|
+
"gists_url",
|
|
209173
|
+
"gravatar_id",
|
|
209174
|
+
"html_url",
|
|
209175
|
+
"id",
|
|
209176
|
+
"node_id",
|
|
209177
|
+
"login",
|
|
209178
|
+
"organizations_url",
|
|
209179
|
+
"received_events_url",
|
|
209180
|
+
"repos_url",
|
|
209181
|
+
"site_admin",
|
|
209182
|
+
"starred_url",
|
|
209183
|
+
"subscriptions_url",
|
|
209184
|
+
"type",
|
|
209185
|
+
"url"
|
|
209186
|
+
]
|
|
209187
|
+
},
|
|
209188
|
+
"content_type": {
|
|
209189
|
+
"type": "string",
|
|
209190
|
+
"description": "The MIME type of the CodeQL database file."
|
|
209191
|
+
},
|
|
209192
|
+
"size": {
|
|
209193
|
+
"type": "integer",
|
|
209194
|
+
"description": "The size of the CodeQL database file in bytes."
|
|
209195
|
+
},
|
|
209196
|
+
"created_at": {
|
|
209197
|
+
"type": "string",
|
|
209198
|
+
"format": "date-time",
|
|
209199
|
+
"description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
|
|
209200
|
+
},
|
|
209201
|
+
"updated_at": {
|
|
209202
|
+
"type": "string",
|
|
209203
|
+
"format": "date-time",
|
|
209204
|
+
"description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
|
|
209205
|
+
},
|
|
209206
|
+
"url": {
|
|
209207
|
+
"type": "string",
|
|
209208
|
+
"format": "uri",
|
|
209209
|
+
"description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
|
|
209210
|
+
}
|
|
209211
|
+
},
|
|
209212
|
+
"required": [
|
|
209213
|
+
"id",
|
|
209214
|
+
"name",
|
|
209215
|
+
"language",
|
|
209216
|
+
"uploader",
|
|
209217
|
+
"content_type",
|
|
209218
|
+
"size",
|
|
209219
|
+
"created_at",
|
|
209220
|
+
"updated_at",
|
|
209221
|
+
"url"
|
|
209222
|
+
]
|
|
209223
|
+
}
|
|
209224
|
+
},
|
|
209225
|
+
"examples": {
|
|
209226
|
+
"default": {
|
|
209227
|
+
"value": [
|
|
209228
|
+
{
|
|
209229
|
+
"id": 1,
|
|
209230
|
+
"name": "database.zip",
|
|
209231
|
+
"language": "java",
|
|
209232
|
+
"uploader": {
|
|
209233
|
+
"login": "octocat",
|
|
209234
|
+
"id": 1,
|
|
209235
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
209236
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
209237
|
+
"gravatar_id": "",
|
|
209238
|
+
"url": "https://api.github.com/users/octocat",
|
|
209239
|
+
"html_url": "https://github.com/octocat",
|
|
209240
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
209241
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
209242
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
209243
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
209244
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
209245
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
209246
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
209247
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
209248
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
209249
|
+
"type": "User",
|
|
209250
|
+
"site_admin": false
|
|
209251
|
+
},
|
|
209252
|
+
"content_type": "application/zip",
|
|
209253
|
+
"size": 1024,
|
|
209254
|
+
"created_at": "2022-09-12T12:14:32Z",
|
|
209255
|
+
"updated_at": "2022-09-12T12:14:32Z",
|
|
209256
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
|
|
209257
|
+
},
|
|
209258
|
+
{
|
|
209259
|
+
"id": 2,
|
|
209260
|
+
"name": "database.zip",
|
|
209261
|
+
"language": "ruby",
|
|
209262
|
+
"uploader": {
|
|
209263
|
+
"login": "octocat",
|
|
209264
|
+
"id": 1,
|
|
209265
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
209266
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
209267
|
+
"gravatar_id": "",
|
|
209268
|
+
"url": "https://api.github.com/users/octocat",
|
|
209269
|
+
"html_url": "https://github.com/octocat",
|
|
209270
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
209271
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
209272
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
209273
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
209274
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
209275
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
209276
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
209277
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
209278
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
209279
|
+
"type": "User",
|
|
209280
|
+
"site_admin": false
|
|
209281
|
+
},
|
|
209282
|
+
"content_type": "application/zip",
|
|
209283
|
+
"size": 1024,
|
|
209284
|
+
"created_at": "2022-09-12T12:14:32Z",
|
|
209285
|
+
"updated_at": "2022-09-12T12:14:32Z",
|
|
209286
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/ruby"
|
|
209287
|
+
}
|
|
209288
|
+
]
|
|
209289
|
+
}
|
|
209290
|
+
}
|
|
209291
|
+
}
|
|
209292
|
+
}
|
|
209293
|
+
},
|
|
209294
|
+
"403": {
|
|
209295
|
+
"description": "Response if GitHub Advanced Security is not enabled for this repository",
|
|
209296
|
+
"content": {
|
|
209297
|
+
"application/json": {
|
|
209298
|
+
"schema": {
|
|
209299
|
+
"title": "Basic Error",
|
|
209300
|
+
"description": "Basic Error",
|
|
209301
|
+
"type": "object",
|
|
209302
|
+
"properties": {
|
|
209303
|
+
"message": {
|
|
209304
|
+
"type": "string"
|
|
209305
|
+
},
|
|
209306
|
+
"documentation_url": {
|
|
209307
|
+
"type": "string"
|
|
209308
|
+
},
|
|
209309
|
+
"url": {
|
|
209310
|
+
"type": "string"
|
|
209311
|
+
},
|
|
209312
|
+
"status": {
|
|
209313
|
+
"type": "string"
|
|
209314
|
+
}
|
|
209315
|
+
}
|
|
209316
|
+
}
|
|
209317
|
+
}
|
|
209318
|
+
}
|
|
209319
|
+
},
|
|
209320
|
+
"404": {
|
|
209321
|
+
"description": "Resource not found",
|
|
209322
|
+
"content": {
|
|
209323
|
+
"application/json": {
|
|
209324
|
+
"schema": {
|
|
209325
|
+
"title": "Basic Error",
|
|
209326
|
+
"description": "Basic Error",
|
|
209327
|
+
"type": "object",
|
|
209328
|
+
"properties": {
|
|
209329
|
+
"message": {
|
|
209330
|
+
"type": "string"
|
|
209331
|
+
},
|
|
209332
|
+
"documentation_url": {
|
|
209333
|
+
"type": "string"
|
|
209334
|
+
},
|
|
209335
|
+
"url": {
|
|
209336
|
+
"type": "string"
|
|
209337
|
+
},
|
|
209338
|
+
"status": {
|
|
209339
|
+
"type": "string"
|
|
209340
|
+
}
|
|
209341
|
+
}
|
|
209342
|
+
}
|
|
209343
|
+
}
|
|
209344
|
+
}
|
|
209345
|
+
},
|
|
209346
|
+
"503": {
|
|
209347
|
+
"description": "Service unavailable",
|
|
209348
|
+
"content": {
|
|
209349
|
+
"application/json": {
|
|
209350
|
+
"schema": {
|
|
209351
|
+
"type": "object",
|
|
209352
|
+
"properties": {
|
|
209353
|
+
"code": {
|
|
209354
|
+
"type": "string"
|
|
209355
|
+
},
|
|
209356
|
+
"message": {
|
|
209357
|
+
"type": "string"
|
|
209358
|
+
},
|
|
209359
|
+
"documentation_url": {
|
|
209360
|
+
"type": "string"
|
|
209361
|
+
}
|
|
209362
|
+
}
|
|
209363
|
+
}
|
|
209364
|
+
}
|
|
209365
|
+
}
|
|
209366
|
+
}
|
|
209367
|
+
},
|
|
209368
|
+
"x-github": {
|
|
209369
|
+
"githubCloudOnly": true,
|
|
209370
|
+
"enabledForGitHubApps": true,
|
|
209371
|
+
"previews": [],
|
|
209372
|
+
"category": "code-scanning",
|
|
209373
|
+
"subcategory": null
|
|
209374
|
+
},
|
|
209375
|
+
"x-octokit": {}
|
|
209376
|
+
}
|
|
209377
|
+
},
|
|
209378
|
+
"/repos/{owner}/{repo}/code-scanning/codeql/databases/{language}": {
|
|
209379
|
+
"get": {
|
|
209380
|
+
"summary": "Get a CodeQL database for a repository",
|
|
209381
|
+
"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.",
|
|
209382
|
+
"tags": [
|
|
209383
|
+
"code-scanning"
|
|
209384
|
+
],
|
|
209385
|
+
"operationId": "code-scanning/get-codeql-database",
|
|
209386
|
+
"externalDocs": {
|
|
209387
|
+
"description": "API method documentation",
|
|
209388
|
+
"url": "https://docs.github.com/rest/reference/code-scanning#get-codeql-database"
|
|
209389
|
+
},
|
|
209390
|
+
"parameters": [
|
|
209391
|
+
{
|
|
209392
|
+
"name": "owner",
|
|
209393
|
+
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
209394
|
+
"in": "path",
|
|
209395
|
+
"required": true,
|
|
209396
|
+
"schema": {
|
|
209397
|
+
"type": "string"
|
|
209398
|
+
}
|
|
209399
|
+
},
|
|
209400
|
+
{
|
|
209401
|
+
"name": "repo",
|
|
209402
|
+
"description": "The name of the repository. The name is not case sensitive.",
|
|
209403
|
+
"in": "path",
|
|
209404
|
+
"required": true,
|
|
209405
|
+
"schema": {
|
|
209406
|
+
"type": "string"
|
|
209407
|
+
}
|
|
209408
|
+
},
|
|
209409
|
+
{
|
|
209410
|
+
"name": "language",
|
|
209411
|
+
"in": "path",
|
|
209412
|
+
"description": "The language of the CodeQL database.",
|
|
209413
|
+
"schema": {
|
|
209414
|
+
"type": "string"
|
|
209415
|
+
},
|
|
209416
|
+
"required": true
|
|
209417
|
+
}
|
|
209418
|
+
],
|
|
209419
|
+
"responses": {
|
|
209420
|
+
"200": {
|
|
209421
|
+
"description": "Response",
|
|
209422
|
+
"content": {
|
|
209423
|
+
"application/json": {
|
|
209424
|
+
"schema": {
|
|
209425
|
+
"title": "CodeQL Database",
|
|
209426
|
+
"description": "A CodeQL database.",
|
|
209427
|
+
"type": "object",
|
|
209428
|
+
"properties": {
|
|
209429
|
+
"id": {
|
|
209430
|
+
"type": "integer",
|
|
209431
|
+
"description": "The ID of the CodeQL database."
|
|
209432
|
+
},
|
|
209433
|
+
"name": {
|
|
209434
|
+
"type": "string",
|
|
209435
|
+
"description": "The name of the CodeQL database."
|
|
209436
|
+
},
|
|
209437
|
+
"language": {
|
|
209438
|
+
"type": "string",
|
|
209439
|
+
"description": "The language of the CodeQL database."
|
|
209440
|
+
},
|
|
209441
|
+
"uploader": {
|
|
209442
|
+
"title": "Simple User",
|
|
209443
|
+
"description": "Simple User",
|
|
209444
|
+
"type": "object",
|
|
209445
|
+
"properties": {
|
|
209446
|
+
"name": {
|
|
209447
|
+
"nullable": true,
|
|
209448
|
+
"type": "string"
|
|
209449
|
+
},
|
|
209450
|
+
"email": {
|
|
209451
|
+
"nullable": true,
|
|
209452
|
+
"type": "string"
|
|
209453
|
+
},
|
|
209454
|
+
"login": {
|
|
209455
|
+
"type": "string",
|
|
209456
|
+
"example": "octocat"
|
|
209457
|
+
},
|
|
209458
|
+
"id": {
|
|
209459
|
+
"type": "integer",
|
|
209460
|
+
"example": 1
|
|
209461
|
+
},
|
|
209462
|
+
"node_id": {
|
|
209463
|
+
"type": "string",
|
|
209464
|
+
"example": "MDQ6VXNlcjE="
|
|
209465
|
+
},
|
|
209466
|
+
"avatar_url": {
|
|
209467
|
+
"type": "string",
|
|
209468
|
+
"format": "uri",
|
|
209469
|
+
"example": "https://github.com/images/error/octocat_happy.gif"
|
|
209470
|
+
},
|
|
209471
|
+
"gravatar_id": {
|
|
209472
|
+
"type": "string",
|
|
209473
|
+
"example": "41d064eb2195891e12d0413f63227ea7",
|
|
209474
|
+
"nullable": true
|
|
209475
|
+
},
|
|
209476
|
+
"url": {
|
|
209477
|
+
"type": "string",
|
|
209478
|
+
"format": "uri",
|
|
209479
|
+
"example": "https://api.github.com/users/octocat"
|
|
209480
|
+
},
|
|
209481
|
+
"html_url": {
|
|
209482
|
+
"type": "string",
|
|
209483
|
+
"format": "uri",
|
|
209484
|
+
"example": "https://github.com/octocat"
|
|
209485
|
+
},
|
|
209486
|
+
"followers_url": {
|
|
209487
|
+
"type": "string",
|
|
209488
|
+
"format": "uri",
|
|
209489
|
+
"example": "https://api.github.com/users/octocat/followers"
|
|
209490
|
+
},
|
|
209491
|
+
"following_url": {
|
|
209492
|
+
"type": "string",
|
|
209493
|
+
"example": "https://api.github.com/users/octocat/following{/other_user}"
|
|
209494
|
+
},
|
|
209495
|
+
"gists_url": {
|
|
209496
|
+
"type": "string",
|
|
209497
|
+
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
|
|
209498
|
+
},
|
|
209499
|
+
"starred_url": {
|
|
209500
|
+
"type": "string",
|
|
209501
|
+
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
|
|
209502
|
+
},
|
|
209503
|
+
"subscriptions_url": {
|
|
209504
|
+
"type": "string",
|
|
209505
|
+
"format": "uri",
|
|
209506
|
+
"example": "https://api.github.com/users/octocat/subscriptions"
|
|
209507
|
+
},
|
|
209508
|
+
"organizations_url": {
|
|
209509
|
+
"type": "string",
|
|
209510
|
+
"format": "uri",
|
|
209511
|
+
"example": "https://api.github.com/users/octocat/orgs"
|
|
209512
|
+
},
|
|
209513
|
+
"repos_url": {
|
|
209514
|
+
"type": "string",
|
|
209515
|
+
"format": "uri",
|
|
209516
|
+
"example": "https://api.github.com/users/octocat/repos"
|
|
209517
|
+
},
|
|
209518
|
+
"events_url": {
|
|
209519
|
+
"type": "string",
|
|
209520
|
+
"example": "https://api.github.com/users/octocat/events{/privacy}"
|
|
209521
|
+
},
|
|
209522
|
+
"received_events_url": {
|
|
209523
|
+
"type": "string",
|
|
209524
|
+
"format": "uri",
|
|
209525
|
+
"example": "https://api.github.com/users/octocat/received_events"
|
|
209526
|
+
},
|
|
209527
|
+
"type": {
|
|
209528
|
+
"type": "string",
|
|
209529
|
+
"example": "User"
|
|
209530
|
+
},
|
|
209531
|
+
"site_admin": {
|
|
209532
|
+
"type": "boolean"
|
|
209533
|
+
},
|
|
209534
|
+
"starred_at": {
|
|
209535
|
+
"type": "string",
|
|
209536
|
+
"example": "\"2020-07-09T00:17:55Z\""
|
|
209537
|
+
}
|
|
209538
|
+
},
|
|
209539
|
+
"required": [
|
|
209540
|
+
"avatar_url",
|
|
209541
|
+
"events_url",
|
|
209542
|
+
"followers_url",
|
|
209543
|
+
"following_url",
|
|
209544
|
+
"gists_url",
|
|
209545
|
+
"gravatar_id",
|
|
209546
|
+
"html_url",
|
|
209547
|
+
"id",
|
|
209548
|
+
"node_id",
|
|
209549
|
+
"login",
|
|
209550
|
+
"organizations_url",
|
|
209551
|
+
"received_events_url",
|
|
209552
|
+
"repos_url",
|
|
209553
|
+
"site_admin",
|
|
209554
|
+
"starred_url",
|
|
209555
|
+
"subscriptions_url",
|
|
209556
|
+
"type",
|
|
209557
|
+
"url"
|
|
209558
|
+
]
|
|
209559
|
+
},
|
|
209560
|
+
"content_type": {
|
|
209561
|
+
"type": "string",
|
|
209562
|
+
"description": "The MIME type of the CodeQL database file."
|
|
209563
|
+
},
|
|
209564
|
+
"size": {
|
|
209565
|
+
"type": "integer",
|
|
209566
|
+
"description": "The size of the CodeQL database file in bytes."
|
|
209567
|
+
},
|
|
209568
|
+
"created_at": {
|
|
209569
|
+
"type": "string",
|
|
209570
|
+
"format": "date-time",
|
|
209571
|
+
"description": "The date and time at which the CodeQL database was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
|
|
209572
|
+
},
|
|
209573
|
+
"updated_at": {
|
|
209574
|
+
"type": "string",
|
|
209575
|
+
"format": "date-time",
|
|
209576
|
+
"description": "The date and time at which the CodeQL database was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ."
|
|
209577
|
+
},
|
|
209578
|
+
"url": {
|
|
209579
|
+
"type": "string",
|
|
209580
|
+
"format": "uri",
|
|
209581
|
+
"description": "The URL at which to download the CodeQL database. The `Accept` header must be set to the value of the `content_type` property."
|
|
209582
|
+
}
|
|
209583
|
+
},
|
|
209584
|
+
"required": [
|
|
209585
|
+
"id",
|
|
209586
|
+
"name",
|
|
209587
|
+
"language",
|
|
209588
|
+
"uploader",
|
|
209589
|
+
"content_type",
|
|
209590
|
+
"size",
|
|
209591
|
+
"created_at",
|
|
209592
|
+
"updated_at",
|
|
209593
|
+
"url"
|
|
209594
|
+
]
|
|
209595
|
+
},
|
|
209596
|
+
"examples": {
|
|
209597
|
+
"default": {
|
|
209598
|
+
"value": {
|
|
209599
|
+
"id": 1,
|
|
209600
|
+
"name": "database.zip",
|
|
209601
|
+
"language": "java",
|
|
209602
|
+
"uploader": {
|
|
209603
|
+
"login": "octocat",
|
|
209604
|
+
"id": 1,
|
|
209605
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
209606
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
209607
|
+
"gravatar_id": "",
|
|
209608
|
+
"url": "https://api.github.com/users/octocat",
|
|
209609
|
+
"html_url": "https://github.com/octocat",
|
|
209610
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
209611
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
209612
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
209613
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
209614
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
209615
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
209616
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
209617
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
209618
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
209619
|
+
"type": "User",
|
|
209620
|
+
"site_admin": false
|
|
209621
|
+
},
|
|
209622
|
+
"content_type": "application/zip",
|
|
209623
|
+
"size": 1024,
|
|
209624
|
+
"created_at": "2022-09-12T12:14:32Z",
|
|
209625
|
+
"updated_at": "2022-09-12T12:14:32Z",
|
|
209626
|
+
"url": "https://api.github.com/repos/octocat/Hello-World/code-scanning/codeql/databases/java"
|
|
209627
|
+
}
|
|
209628
|
+
}
|
|
209629
|
+
}
|
|
209630
|
+
}
|
|
209631
|
+
}
|
|
209632
|
+
},
|
|
209633
|
+
"302": {
|
|
209634
|
+
"description": "Found"
|
|
209635
|
+
},
|
|
209636
|
+
"403": {
|
|
209637
|
+
"description": "Response if GitHub Advanced Security is not enabled for this repository",
|
|
209638
|
+
"content": {
|
|
209639
|
+
"application/json": {
|
|
209640
|
+
"schema": {
|
|
209641
|
+
"title": "Basic Error",
|
|
209642
|
+
"description": "Basic Error",
|
|
209643
|
+
"type": "object",
|
|
209644
|
+
"properties": {
|
|
209645
|
+
"message": {
|
|
209646
|
+
"type": "string"
|
|
209647
|
+
},
|
|
209648
|
+
"documentation_url": {
|
|
209649
|
+
"type": "string"
|
|
209650
|
+
},
|
|
209651
|
+
"url": {
|
|
209652
|
+
"type": "string"
|
|
209653
|
+
},
|
|
209654
|
+
"status": {
|
|
209655
|
+
"type": "string"
|
|
209656
|
+
}
|
|
209657
|
+
}
|
|
209658
|
+
}
|
|
209659
|
+
}
|
|
209660
|
+
}
|
|
209661
|
+
},
|
|
209662
|
+
"404": {
|
|
209663
|
+
"description": "Resource not found",
|
|
209664
|
+
"content": {
|
|
209665
|
+
"application/json": {
|
|
209666
|
+
"schema": {
|
|
209667
|
+
"title": "Basic Error",
|
|
209668
|
+
"description": "Basic Error",
|
|
209669
|
+
"type": "object",
|
|
209670
|
+
"properties": {
|
|
209671
|
+
"message": {
|
|
209672
|
+
"type": "string"
|
|
209673
|
+
},
|
|
209674
|
+
"documentation_url": {
|
|
209675
|
+
"type": "string"
|
|
209676
|
+
},
|
|
209677
|
+
"url": {
|
|
209678
|
+
"type": "string"
|
|
209679
|
+
},
|
|
209680
|
+
"status": {
|
|
209681
|
+
"type": "string"
|
|
209682
|
+
}
|
|
209683
|
+
}
|
|
209684
|
+
}
|
|
209685
|
+
}
|
|
209686
|
+
}
|
|
209687
|
+
},
|
|
209688
|
+
"503": {
|
|
209689
|
+
"description": "Service unavailable",
|
|
209690
|
+
"content": {
|
|
209691
|
+
"application/json": {
|
|
209692
|
+
"schema": {
|
|
209693
|
+
"type": "object",
|
|
209694
|
+
"properties": {
|
|
209695
|
+
"code": {
|
|
209696
|
+
"type": "string"
|
|
209697
|
+
},
|
|
209698
|
+
"message": {
|
|
209699
|
+
"type": "string"
|
|
209700
|
+
},
|
|
209701
|
+
"documentation_url": {
|
|
209702
|
+
"type": "string"
|
|
209703
|
+
}
|
|
209704
|
+
}
|
|
209705
|
+
}
|
|
209706
|
+
}
|
|
209707
|
+
}
|
|
209708
|
+
}
|
|
209709
|
+
},
|
|
209710
|
+
"x-github": {
|
|
209711
|
+
"githubCloudOnly": true,
|
|
209712
|
+
"enabledForGitHubApps": true,
|
|
209713
|
+
"previews": [],
|
|
209714
|
+
"category": "code-scanning",
|
|
209715
|
+
"subcategory": null
|
|
209716
|
+
},
|
|
209717
|
+
"x-octokit": {}
|
|
209718
|
+
}
|
|
209719
|
+
},
|
|
208987
209720
|
"/repos/{owner}/{repo}/code-scanning/sarifs": {
|
|
208988
209721
|
"post": {
|
|
208989
209722
|
"summary": "Upload an analysis as SARIF data",
|
|
@@ -209109,7 +209842,7 @@
|
|
|
209109
209842
|
"description": "Bad Request if the sarif field is invalid"
|
|
209110
209843
|
},
|
|
209111
209844
|
"403": {
|
|
209112
|
-
"description": "Response if the repository is archived or if
|
|
209845
|
+
"description": "Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository",
|
|
209113
209846
|
"content": {
|
|
209114
209847
|
"application/json": {
|
|
209115
209848
|
"schema": {
|
|
@@ -240516,7 +241249,7 @@
|
|
|
240516
241249
|
},
|
|
240517
241250
|
"put": {
|
|
240518
241251
|
"summary": "Create or update file contents",
|
|
240519
|
-
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.",
|
|
241252
|
+
"description": "Creates a new file or replaces an existing file in a repository. You must authenticate using an access token with the `workflow` scope to use this endpoint.\n\n**Note:** If you use this endpoint and the \"[Delete a file](https://docs.github.com/rest/reference/repos/#delete-file)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
|
|
240520
241253
|
"tags": [
|
|
240521
241254
|
"repos"
|
|
240522
241255
|
],
|
|
@@ -241221,7 +241954,7 @@
|
|
|
241221
241954
|
},
|
|
241222
241955
|
"delete": {
|
|
241223
241956
|
"summary": "Delete a file",
|
|
241224
|
-
"description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
|
|
241957
|
+
"description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.\n\n**Note:** If you use this endpoint and the \"[Create or update file contents](https://docs.github.com/rest/reference/repos/#create-or-update-file-contents)\" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.",
|
|
241225
241958
|
"tags": [
|
|
241226
241959
|
"repos"
|
|
241227
241960
|
],
|