@octokit/openapi 6.3.1 → 6.6.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 +79 -8
- package/generated/api.github.com.json +75 -9
- 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 +50 -3
- package/generated/ghes-3.2-diff-to-ghes-3.3.json +53 -3
- package/generated/ghes-3.2.deref.json +61 -5
- package/generated/ghes-3.2.json +64 -5
- package/generated/ghes-3.3-anicca-diff-to-ghes-3.4.deref.json +8 -4
- package/generated/ghes-3.3-diff-to-ghes-3.4.deref.json +1 -1
- package/generated/ghes-3.3-diff-to-ghes-3.4.json +1 -1
- package/generated/ghes-3.3.deref.json +61 -5
- package/generated/ghes-3.3.json +64 -5
- package/generated/ghes-3.4-diff-to-ghes-3.5.deref.json +1 -1
- package/generated/ghes-3.4-diff-to-ghes-3.5.json +1 -1
- package/generated/ghes-3.4.deref.json +73 -9
- package/generated/ghes-3.4.json +68 -9
- package/generated/ghes-3.5-anicca-diff-to-api.github.com.deref.json +11008 -112568
- package/generated/ghes-3.5-diff-to-api.github.com.deref.json +220 -574
- package/generated/ghes-3.5-diff-to-api.github.com.json +147 -263
- package/generated/ghes-3.5.deref.json +2645 -297
- package/generated/ghes-3.5.json +3178 -609
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +41 -3
- package/generated/github.ae-diff-to-api.github.com.deref.json +220 -1
- package/generated/github.ae-diff-to-api.github.com.json +147 -1
- package/generated/github.ae.deref.json +3814 -315
- package/generated/github.ae.json +4253 -557
- package/package.json +7 -4
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "6.
|
|
4
|
+
"version": "6.6.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": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
|
|
@@ -47707,6 +47707,225 @@
|
|
|
47707
47707
|
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
47708
47708
|
}
|
|
47709
47709
|
},
|
|
47710
|
+
"/rate_limit": {
|
|
47711
|
+
"get": {
|
|
47712
|
+
"summary": "Get rate limit status for the authenticated user",
|
|
47713
|
+
"description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.",
|
|
47714
|
+
"tags": ["rate-limit"],
|
|
47715
|
+
"operationId": "rate-limit/get",
|
|
47716
|
+
"externalDocs": {
|
|
47717
|
+
"description": "API method documentation",
|
|
47718
|
+
"url": "https://docs.github.com/enterprise-server@3.5/rest/reference/rate-limit#get-rate-limit-status-for-the-authenticated-user"
|
|
47719
|
+
},
|
|
47720
|
+
"parameters": [],
|
|
47721
|
+
"responses": {
|
|
47722
|
+
"200": {
|
|
47723
|
+
"description": "Response",
|
|
47724
|
+
"content": {
|
|
47725
|
+
"application/json": {
|
|
47726
|
+
"schema": {
|
|
47727
|
+
"title": "Rate Limit Overview",
|
|
47728
|
+
"description": "Rate Limit Overview",
|
|
47729
|
+
"type": "object",
|
|
47730
|
+
"properties": {
|
|
47731
|
+
"resources": {
|
|
47732
|
+
"type": "object",
|
|
47733
|
+
"properties": {
|
|
47734
|
+
"core": {
|
|
47735
|
+
"title": "Rate Limit",
|
|
47736
|
+
"type": "object",
|
|
47737
|
+
"properties": {
|
|
47738
|
+
"limit": { "type": "integer" },
|
|
47739
|
+
"remaining": { "type": "integer" },
|
|
47740
|
+
"reset": { "type": "integer" },
|
|
47741
|
+
"used": { "type": "integer" }
|
|
47742
|
+
},
|
|
47743
|
+
"required": ["limit", "remaining", "reset", "used"]
|
|
47744
|
+
},
|
|
47745
|
+
"graphql": {
|
|
47746
|
+
"title": "Rate Limit",
|
|
47747
|
+
"type": "object",
|
|
47748
|
+
"properties": {
|
|
47749
|
+
"limit": { "type": "integer" },
|
|
47750
|
+
"remaining": { "type": "integer" },
|
|
47751
|
+
"reset": { "type": "integer" },
|
|
47752
|
+
"used": { "type": "integer" }
|
|
47753
|
+
},
|
|
47754
|
+
"required": ["limit", "remaining", "reset", "used"]
|
|
47755
|
+
},
|
|
47756
|
+
"search": {
|
|
47757
|
+
"title": "Rate Limit",
|
|
47758
|
+
"type": "object",
|
|
47759
|
+
"properties": {
|
|
47760
|
+
"limit": { "type": "integer" },
|
|
47761
|
+
"remaining": { "type": "integer" },
|
|
47762
|
+
"reset": { "type": "integer" },
|
|
47763
|
+
"used": { "type": "integer" }
|
|
47764
|
+
},
|
|
47765
|
+
"required": ["limit", "remaining", "reset", "used"]
|
|
47766
|
+
},
|
|
47767
|
+
"source_import": {
|
|
47768
|
+
"title": "Rate Limit",
|
|
47769
|
+
"type": "object",
|
|
47770
|
+
"properties": {
|
|
47771
|
+
"limit": { "type": "integer" },
|
|
47772
|
+
"remaining": { "type": "integer" },
|
|
47773
|
+
"reset": { "type": "integer" },
|
|
47774
|
+
"used": { "type": "integer" }
|
|
47775
|
+
},
|
|
47776
|
+
"required": ["limit", "remaining", "reset", "used"]
|
|
47777
|
+
},
|
|
47778
|
+
"integration_manifest": {
|
|
47779
|
+
"title": "Rate Limit",
|
|
47780
|
+
"type": "object",
|
|
47781
|
+
"properties": {
|
|
47782
|
+
"limit": { "type": "integer" },
|
|
47783
|
+
"remaining": { "type": "integer" },
|
|
47784
|
+
"reset": { "type": "integer" },
|
|
47785
|
+
"used": { "type": "integer" }
|
|
47786
|
+
},
|
|
47787
|
+
"required": ["limit", "remaining", "reset", "used"]
|
|
47788
|
+
},
|
|
47789
|
+
"code_scanning_upload": {
|
|
47790
|
+
"title": "Rate Limit",
|
|
47791
|
+
"type": "object",
|
|
47792
|
+
"properties": {
|
|
47793
|
+
"limit": { "type": "integer" },
|
|
47794
|
+
"remaining": { "type": "integer" },
|
|
47795
|
+
"reset": { "type": "integer" },
|
|
47796
|
+
"used": { "type": "integer" }
|
|
47797
|
+
},
|
|
47798
|
+
"required": ["limit", "remaining", "reset", "used"]
|
|
47799
|
+
},
|
|
47800
|
+
"actions_runner_registration": {
|
|
47801
|
+
"title": "Rate Limit",
|
|
47802
|
+
"type": "object",
|
|
47803
|
+
"properties": {
|
|
47804
|
+
"limit": { "type": "integer" },
|
|
47805
|
+
"remaining": { "type": "integer" },
|
|
47806
|
+
"reset": { "type": "integer" },
|
|
47807
|
+
"used": { "type": "integer" }
|
|
47808
|
+
},
|
|
47809
|
+
"required": ["limit", "remaining", "reset", "used"]
|
|
47810
|
+
},
|
|
47811
|
+
"scim": {
|
|
47812
|
+
"title": "Rate Limit",
|
|
47813
|
+
"type": "object",
|
|
47814
|
+
"properties": {
|
|
47815
|
+
"limit": { "type": "integer" },
|
|
47816
|
+
"remaining": { "type": "integer" },
|
|
47817
|
+
"reset": { "type": "integer" },
|
|
47818
|
+
"used": { "type": "integer" }
|
|
47819
|
+
},
|
|
47820
|
+
"required": ["limit", "remaining", "reset", "used"]
|
|
47821
|
+
}
|
|
47822
|
+
},
|
|
47823
|
+
"required": ["core", "search"]
|
|
47824
|
+
},
|
|
47825
|
+
"rate": {
|
|
47826
|
+
"title": "Rate Limit",
|
|
47827
|
+
"type": "object",
|
|
47828
|
+
"properties": {
|
|
47829
|
+
"limit": { "type": "integer" },
|
|
47830
|
+
"remaining": { "type": "integer" },
|
|
47831
|
+
"reset": { "type": "integer" },
|
|
47832
|
+
"used": { "type": "integer" }
|
|
47833
|
+
},
|
|
47834
|
+
"required": ["limit", "remaining", "reset", "used"]
|
|
47835
|
+
}
|
|
47836
|
+
},
|
|
47837
|
+
"required": ["rate", "resources"]
|
|
47838
|
+
},
|
|
47839
|
+
"examples": {
|
|
47840
|
+
"default": {
|
|
47841
|
+
"value": {
|
|
47842
|
+
"resources": {
|
|
47843
|
+
"core": {
|
|
47844
|
+
"limit": 5000,
|
|
47845
|
+
"remaining": 4999,
|
|
47846
|
+
"reset": 1372700873,
|
|
47847
|
+
"used": 1
|
|
47848
|
+
},
|
|
47849
|
+
"search": {
|
|
47850
|
+
"limit": 30,
|
|
47851
|
+
"remaining": 18,
|
|
47852
|
+
"reset": 1372697452,
|
|
47853
|
+
"used": 12
|
|
47854
|
+
},
|
|
47855
|
+
"graphql": {
|
|
47856
|
+
"limit": 5000,
|
|
47857
|
+
"remaining": 4993,
|
|
47858
|
+
"reset": 1372700389,
|
|
47859
|
+
"used": 7
|
|
47860
|
+
},
|
|
47861
|
+
"integration_manifest": {
|
|
47862
|
+
"limit": 5000,
|
|
47863
|
+
"remaining": 4999,
|
|
47864
|
+
"reset": 1551806725,
|
|
47865
|
+
"used": 1
|
|
47866
|
+
},
|
|
47867
|
+
"code_scanning_upload": {
|
|
47868
|
+
"limit": 500,
|
|
47869
|
+
"remaining": 499,
|
|
47870
|
+
"reset": 1551806725,
|
|
47871
|
+
"used": 1
|
|
47872
|
+
}
|
|
47873
|
+
},
|
|
47874
|
+
"rate": {
|
|
47875
|
+
"limit": 5000,
|
|
47876
|
+
"remaining": 4999,
|
|
47877
|
+
"reset": 1372700873,
|
|
47878
|
+
"used": 1
|
|
47879
|
+
}
|
|
47880
|
+
}
|
|
47881
|
+
}
|
|
47882
|
+
}
|
|
47883
|
+
}
|
|
47884
|
+
},
|
|
47885
|
+
"headers": {
|
|
47886
|
+
"X-RateLimit-Limit": {
|
|
47887
|
+
"example": 5000,
|
|
47888
|
+
"schema": { "type": "integer" }
|
|
47889
|
+
},
|
|
47890
|
+
"X-RateLimit-Remaining": {
|
|
47891
|
+
"example": 4999,
|
|
47892
|
+
"schema": { "type": "integer" }
|
|
47893
|
+
},
|
|
47894
|
+
"X-RateLimit-Reset": {
|
|
47895
|
+
"example": 1590701888,
|
|
47896
|
+
"schema": { "type": "integer", "format": "timestamp" }
|
|
47897
|
+
}
|
|
47898
|
+
}
|
|
47899
|
+
},
|
|
47900
|
+
"304": { "description": "Not modified" },
|
|
47901
|
+
"404": {
|
|
47902
|
+
"description": "Resource not found",
|
|
47903
|
+
"content": {
|
|
47904
|
+
"application/json": {
|
|
47905
|
+
"schema": {
|
|
47906
|
+
"title": "Basic Error",
|
|
47907
|
+
"description": "Basic Error",
|
|
47908
|
+
"type": "object",
|
|
47909
|
+
"properties": {
|
|
47910
|
+
"message": { "type": "string" },
|
|
47911
|
+
"documentation_url": { "type": "string" },
|
|
47912
|
+
"url": { "type": "string" },
|
|
47913
|
+
"status": { "type": "string" }
|
|
47914
|
+
}
|
|
47915
|
+
}
|
|
47916
|
+
}
|
|
47917
|
+
}
|
|
47918
|
+
}
|
|
47919
|
+
},
|
|
47920
|
+
"x-github": {
|
|
47921
|
+
"githubCloudOnly": false,
|
|
47922
|
+
"enabledForGitHubApps": true,
|
|
47923
|
+
"category": "rate-limit",
|
|
47924
|
+
"subcategory": null
|
|
47925
|
+
},
|
|
47926
|
+
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
47927
|
+
}
|
|
47928
|
+
},
|
|
47710
47929
|
"/repos/{owner}/{repo}": {
|
|
47711
47930
|
"get": {
|
|
47712
47931
|
"summary": "Get a repository",
|
|
@@ -79184,579 +79403,6 @@
|
|
|
79184
79403
|
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
79185
79404
|
}
|
|
79186
79405
|
},
|
|
79187
|
-
"/repos/{owner}/{repo}/code-scanning/alerts": {
|
|
79188
|
-
"get": {
|
|
79189
|
-
"summary": "List code scanning alerts for a repository",
|
|
79190
|
-
"description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint with private repos, the `public_repo` scope also grants permission to read\nsecurity events on public repos only. GitHub Apps must have the `security_events` read\npermission to use this endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the default branch or for the specified Git reference\n(if you used `ref` in the request).",
|
|
79191
|
-
"tags": ["code-scanning"],
|
|
79192
|
-
"operationId": "code-scanning/list-alerts-for-repo",
|
|
79193
|
-
"externalDocs": {
|
|
79194
|
-
"description": "API method documentation",
|
|
79195
|
-
"url": "https://docs.github.com/enterprise-server@3.5/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository"
|
|
79196
|
-
},
|
|
79197
|
-
"parameters": [
|
|
79198
|
-
{
|
|
79199
|
-
"name": "owner",
|
|
79200
|
-
"description": "The account owner of the repository. The name is not case sensitive.",
|
|
79201
|
-
"in": "path",
|
|
79202
|
-
"required": true,
|
|
79203
|
-
"schema": { "type": "string" }
|
|
79204
|
-
},
|
|
79205
|
-
{
|
|
79206
|
-
"name": "repo",
|
|
79207
|
-
"description": "The name of the repository. The name is not case sensitive.",
|
|
79208
|
-
"in": "path",
|
|
79209
|
-
"required": true,
|
|
79210
|
-
"schema": { "type": "string" }
|
|
79211
|
-
},
|
|
79212
|
-
{
|
|
79213
|
-
"name": "tool_name",
|
|
79214
|
-
"description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.",
|
|
79215
|
-
"in": "query",
|
|
79216
|
-
"required": false,
|
|
79217
|
-
"schema": {
|
|
79218
|
-
"type": "string",
|
|
79219
|
-
"description": "The name of the tool used to generate the code scanning analysis."
|
|
79220
|
-
}
|
|
79221
|
-
},
|
|
79222
|
-
{
|
|
79223
|
-
"name": "tool_guid",
|
|
79224
|
-
"description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.",
|
|
79225
|
-
"in": "query",
|
|
79226
|
-
"required": false,
|
|
79227
|
-
"schema": {
|
|
79228
|
-
"nullable": true,
|
|
79229
|
-
"type": "string",
|
|
79230
|
-
"description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
|
|
79231
|
-
}
|
|
79232
|
-
},
|
|
79233
|
-
{
|
|
79234
|
-
"name": "page",
|
|
79235
|
-
"description": "Page number of the results to fetch.",
|
|
79236
|
-
"in": "query",
|
|
79237
|
-
"schema": { "type": "integer", "default": 1 }
|
|
79238
|
-
},
|
|
79239
|
-
{
|
|
79240
|
-
"name": "per_page",
|
|
79241
|
-
"description": "The number of results per page (max 100).",
|
|
79242
|
-
"in": "query",
|
|
79243
|
-
"schema": { "type": "integer", "default": 30 }
|
|
79244
|
-
},
|
|
79245
|
-
{
|
|
79246
|
-
"name": "ref",
|
|
79247
|
-
"description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`.",
|
|
79248
|
-
"in": "query",
|
|
79249
|
-
"required": false,
|
|
79250
|
-
"schema": {
|
|
79251
|
-
"type": "string",
|
|
79252
|
-
"description": "The full Git reference, formatted as `refs/heads/<branch name>`,\n`refs/pull/<number>/merge`, or `refs/pull/<number>/head`."
|
|
79253
|
-
}
|
|
79254
|
-
},
|
|
79255
|
-
{
|
|
79256
|
-
"name": "direction",
|
|
79257
|
-
"description": "The direction to sort the results by.",
|
|
79258
|
-
"in": "query",
|
|
79259
|
-
"required": false,
|
|
79260
|
-
"schema": {
|
|
79261
|
-
"type": "string",
|
|
79262
|
-
"enum": ["asc", "desc"],
|
|
79263
|
-
"default": "desc"
|
|
79264
|
-
}
|
|
79265
|
-
},
|
|
79266
|
-
{
|
|
79267
|
-
"name": "sort",
|
|
79268
|
-
"description": "The property by which to sort the results.",
|
|
79269
|
-
"in": "query",
|
|
79270
|
-
"required": false,
|
|
79271
|
-
"schema": {
|
|
79272
|
-
"type": "string",
|
|
79273
|
-
"enum": ["created", "updated", "number"],
|
|
79274
|
-
"default": "number"
|
|
79275
|
-
}
|
|
79276
|
-
},
|
|
79277
|
-
{
|
|
79278
|
-
"name": "state",
|
|
79279
|
-
"description": "Set to `open`, `closed, `fixed`, or `dismissed` to list code scanning alerts in a specific state.",
|
|
79280
|
-
"in": "query",
|
|
79281
|
-
"required": false,
|
|
79282
|
-
"schema": {
|
|
79283
|
-
"type": "string",
|
|
79284
|
-
"description": "State of a code scanning alert.",
|
|
79285
|
-
"enum": ["open", "closed", "dismissed", "fixed"]
|
|
79286
|
-
}
|
|
79287
|
-
}
|
|
79288
|
-
],
|
|
79289
|
-
"responses": {
|
|
79290
|
-
"200": {
|
|
79291
|
-
"description": "Response",
|
|
79292
|
-
"content": {
|
|
79293
|
-
"application/json": {
|
|
79294
|
-
"schema": {
|
|
79295
|
-
"type": "array",
|
|
79296
|
-
"items": {
|
|
79297
|
-
"type": "object",
|
|
79298
|
-
"properties": {
|
|
79299
|
-
"number": {
|
|
79300
|
-
"type": "integer",
|
|
79301
|
-
"description": "The security alert number.",
|
|
79302
|
-
"readOnly": true
|
|
79303
|
-
},
|
|
79304
|
-
"created_at": {
|
|
79305
|
-
"type": "string",
|
|
79306
|
-
"description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
|
|
79307
|
-
"format": "date-time",
|
|
79308
|
-
"readOnly": true
|
|
79309
|
-
},
|
|
79310
|
-
"updated_at": {
|
|
79311
|
-
"type": "string",
|
|
79312
|
-
"description": "The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
|
|
79313
|
-
"format": "date-time",
|
|
79314
|
-
"readOnly": true
|
|
79315
|
-
},
|
|
79316
|
-
"url": {
|
|
79317
|
-
"type": "string",
|
|
79318
|
-
"description": "The REST API URL of the alert resource.",
|
|
79319
|
-
"format": "uri",
|
|
79320
|
-
"readOnly": true
|
|
79321
|
-
},
|
|
79322
|
-
"html_url": {
|
|
79323
|
-
"type": "string",
|
|
79324
|
-
"description": "The GitHub URL of the alert resource.",
|
|
79325
|
-
"format": "uri",
|
|
79326
|
-
"readOnly": true
|
|
79327
|
-
},
|
|
79328
|
-
"instances_url": {
|
|
79329
|
-
"type": "string",
|
|
79330
|
-
"description": "The REST API URL for fetching the list of instances for an alert.",
|
|
79331
|
-
"format": "uri",
|
|
79332
|
-
"readOnly": true
|
|
79333
|
-
},
|
|
79334
|
-
"state": {
|
|
79335
|
-
"type": "string",
|
|
79336
|
-
"description": "State of a code scanning alert.",
|
|
79337
|
-
"enum": ["open", "closed", "dismissed", "fixed"]
|
|
79338
|
-
},
|
|
79339
|
-
"fixed_at": {
|
|
79340
|
-
"type": "string",
|
|
79341
|
-
"description": "The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
|
|
79342
|
-
"format": "date-time",
|
|
79343
|
-
"readOnly": true,
|
|
79344
|
-
"nullable": true
|
|
79345
|
-
},
|
|
79346
|
-
"dismissed_by": {
|
|
79347
|
-
"title": "Simple User",
|
|
79348
|
-
"description": "Simple User",
|
|
79349
|
-
"type": "object",
|
|
79350
|
-
"properties": {
|
|
79351
|
-
"name": { "nullable": true, "type": "string" },
|
|
79352
|
-
"email": { "nullable": true, "type": "string" },
|
|
79353
|
-
"login": { "type": "string", "example": "octocat" },
|
|
79354
|
-
"id": { "type": "integer", "example": 1 },
|
|
79355
|
-
"node_id": {
|
|
79356
|
-
"type": "string",
|
|
79357
|
-
"example": "MDQ6VXNlcjE="
|
|
79358
|
-
},
|
|
79359
|
-
"avatar_url": {
|
|
79360
|
-
"type": "string",
|
|
79361
|
-
"format": "uri",
|
|
79362
|
-
"example": "https://github.com/images/error/octocat_happy.gif"
|
|
79363
|
-
},
|
|
79364
|
-
"gravatar_id": {
|
|
79365
|
-
"type": "string",
|
|
79366
|
-
"example": "41d064eb2195891e12d0413f63227ea7",
|
|
79367
|
-
"nullable": true
|
|
79368
|
-
},
|
|
79369
|
-
"url": {
|
|
79370
|
-
"type": "string",
|
|
79371
|
-
"format": "uri",
|
|
79372
|
-
"example": "https://api.github.com/users/octocat"
|
|
79373
|
-
},
|
|
79374
|
-
"html_url": {
|
|
79375
|
-
"type": "string",
|
|
79376
|
-
"format": "uri",
|
|
79377
|
-
"example": "https://github.com/octocat"
|
|
79378
|
-
},
|
|
79379
|
-
"followers_url": {
|
|
79380
|
-
"type": "string",
|
|
79381
|
-
"format": "uri",
|
|
79382
|
-
"example": "https://api.github.com/users/octocat/followers"
|
|
79383
|
-
},
|
|
79384
|
-
"following_url": {
|
|
79385
|
-
"type": "string",
|
|
79386
|
-
"example": "https://api.github.com/users/octocat/following{/other_user}"
|
|
79387
|
-
},
|
|
79388
|
-
"gists_url": {
|
|
79389
|
-
"type": "string",
|
|
79390
|
-
"example": "https://api.github.com/users/octocat/gists{/gist_id}"
|
|
79391
|
-
},
|
|
79392
|
-
"starred_url": {
|
|
79393
|
-
"type": "string",
|
|
79394
|
-
"example": "https://api.github.com/users/octocat/starred{/owner}{/repo}"
|
|
79395
|
-
},
|
|
79396
|
-
"subscriptions_url": {
|
|
79397
|
-
"type": "string",
|
|
79398
|
-
"format": "uri",
|
|
79399
|
-
"example": "https://api.github.com/users/octocat/subscriptions"
|
|
79400
|
-
},
|
|
79401
|
-
"organizations_url": {
|
|
79402
|
-
"type": "string",
|
|
79403
|
-
"format": "uri",
|
|
79404
|
-
"example": "https://api.github.com/users/octocat/orgs"
|
|
79405
|
-
},
|
|
79406
|
-
"repos_url": {
|
|
79407
|
-
"type": "string",
|
|
79408
|
-
"format": "uri",
|
|
79409
|
-
"example": "https://api.github.com/users/octocat/repos"
|
|
79410
|
-
},
|
|
79411
|
-
"events_url": {
|
|
79412
|
-
"type": "string",
|
|
79413
|
-
"example": "https://api.github.com/users/octocat/events{/privacy}"
|
|
79414
|
-
},
|
|
79415
|
-
"received_events_url": {
|
|
79416
|
-
"type": "string",
|
|
79417
|
-
"format": "uri",
|
|
79418
|
-
"example": "https://api.github.com/users/octocat/received_events"
|
|
79419
|
-
},
|
|
79420
|
-
"type": { "type": "string", "example": "User" },
|
|
79421
|
-
"site_admin": { "type": "boolean" },
|
|
79422
|
-
"starred_at": {
|
|
79423
|
-
"type": "string",
|
|
79424
|
-
"example": "\"2020-07-09T00:17:55Z\""
|
|
79425
|
-
}
|
|
79426
|
-
},
|
|
79427
|
-
"required": [
|
|
79428
|
-
"avatar_url",
|
|
79429
|
-
"events_url",
|
|
79430
|
-
"followers_url",
|
|
79431
|
-
"following_url",
|
|
79432
|
-
"gists_url",
|
|
79433
|
-
"gravatar_id",
|
|
79434
|
-
"html_url",
|
|
79435
|
-
"id",
|
|
79436
|
-
"node_id",
|
|
79437
|
-
"login",
|
|
79438
|
-
"organizations_url",
|
|
79439
|
-
"received_events_url",
|
|
79440
|
-
"repos_url",
|
|
79441
|
-
"site_admin",
|
|
79442
|
-
"starred_url",
|
|
79443
|
-
"subscriptions_url",
|
|
79444
|
-
"type",
|
|
79445
|
-
"url"
|
|
79446
|
-
],
|
|
79447
|
-
"nullable": true
|
|
79448
|
-
},
|
|
79449
|
-
"dismissed_at": {
|
|
79450
|
-
"type": "string",
|
|
79451
|
-
"description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.",
|
|
79452
|
-
"format": "date-time",
|
|
79453
|
-
"readOnly": true,
|
|
79454
|
-
"nullable": true
|
|
79455
|
-
},
|
|
79456
|
-
"dismissed_reason": {
|
|
79457
|
-
"type": "string",
|
|
79458
|
-
"description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert.",
|
|
79459
|
-
"nullable": true,
|
|
79460
|
-
"enum": [
|
|
79461
|
-
null,
|
|
79462
|
-
"false positive",
|
|
79463
|
-
"won't fix",
|
|
79464
|
-
"used in tests"
|
|
79465
|
-
]
|
|
79466
|
-
},
|
|
79467
|
-
"rule": {
|
|
79468
|
-
"type": "object",
|
|
79469
|
-
"properties": {
|
|
79470
|
-
"id": {
|
|
79471
|
-
"nullable": true,
|
|
79472
|
-
"type": "string",
|
|
79473
|
-
"description": "A unique identifier for the rule used to detect the alert."
|
|
79474
|
-
},
|
|
79475
|
-
"name": {
|
|
79476
|
-
"type": "string",
|
|
79477
|
-
"description": "The name of the rule used to detect the alert."
|
|
79478
|
-
},
|
|
79479
|
-
"tags": {
|
|
79480
|
-
"nullable": true,
|
|
79481
|
-
"type": "array",
|
|
79482
|
-
"description": "A set of tags applicable for the rule.",
|
|
79483
|
-
"items": { "type": "string" }
|
|
79484
|
-
},
|
|
79485
|
-
"severity": {
|
|
79486
|
-
"nullable": true,
|
|
79487
|
-
"type": "string",
|
|
79488
|
-
"description": "The severity of the alert.",
|
|
79489
|
-
"enum": ["none", "note", "warning", "error"]
|
|
79490
|
-
},
|
|
79491
|
-
"description": {
|
|
79492
|
-
"type": "string",
|
|
79493
|
-
"description": "A short description of the rule used to detect the alert."
|
|
79494
|
-
}
|
|
79495
|
-
}
|
|
79496
|
-
},
|
|
79497
|
-
"tool": {
|
|
79498
|
-
"type": "object",
|
|
79499
|
-
"properties": {
|
|
79500
|
-
"name": {
|
|
79501
|
-
"type": "string",
|
|
79502
|
-
"description": "The name of the tool used to generate the code scanning analysis."
|
|
79503
|
-
},
|
|
79504
|
-
"version": {
|
|
79505
|
-
"nullable": true,
|
|
79506
|
-
"type": "string",
|
|
79507
|
-
"description": "The version of the tool used to generate the code scanning analysis."
|
|
79508
|
-
},
|
|
79509
|
-
"guid": {
|
|
79510
|
-
"nullable": true,
|
|
79511
|
-
"type": "string",
|
|
79512
|
-
"description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data."
|
|
79513
|
-
}
|
|
79514
|
-
}
|
|
79515
|
-
},
|
|
79516
|
-
"most_recent_instance": {
|
|
79517
|
-
"type": "object",
|
|
79518
|
-
"properties": {
|
|
79519
|
-
"ref": {
|
|
79520
|
-
"type": "string",
|
|
79521
|
-
"description": "The full Git reference, formatted as `refs/heads/<branch name>`,\n`refs/pull/<number>/merge`, or `refs/pull/<number>/head`."
|
|
79522
|
-
},
|
|
79523
|
-
"analysis_key": {
|
|
79524
|
-
"type": "string",
|
|
79525
|
-
"description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name."
|
|
79526
|
-
},
|
|
79527
|
-
"environment": {
|
|
79528
|
-
"type": "string",
|
|
79529
|
-
"description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed."
|
|
79530
|
-
},
|
|
79531
|
-
"category": {
|
|
79532
|
-
"type": "string",
|
|
79533
|
-
"description": "Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code."
|
|
79534
|
-
},
|
|
79535
|
-
"state": {
|
|
79536
|
-
"type": "string",
|
|
79537
|
-
"description": "State of a code scanning alert.",
|
|
79538
|
-
"enum": ["open", "closed", "dismissed", "fixed"]
|
|
79539
|
-
},
|
|
79540
|
-
"commit_sha": { "type": "string" },
|
|
79541
|
-
"message": {
|
|
79542
|
-
"type": "object",
|
|
79543
|
-
"properties": { "text": { "type": "string" } }
|
|
79544
|
-
},
|
|
79545
|
-
"location": {
|
|
79546
|
-
"type": "object",
|
|
79547
|
-
"description": "Describe a region within a file for the alert.",
|
|
79548
|
-
"properties": {
|
|
79549
|
-
"path": { "type": "string" },
|
|
79550
|
-
"start_line": { "type": "integer" },
|
|
79551
|
-
"end_line": { "type": "integer" },
|
|
79552
|
-
"start_column": { "type": "integer" },
|
|
79553
|
-
"end_column": { "type": "integer" }
|
|
79554
|
-
}
|
|
79555
|
-
},
|
|
79556
|
-
"html_url": { "type": "string" },
|
|
79557
|
-
"classifications": {
|
|
79558
|
-
"type": "array",
|
|
79559
|
-
"description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.",
|
|
79560
|
-
"items": {
|
|
79561
|
-
"type": "string",
|
|
79562
|
-
"description": "A classification of the file. For example to identify it as generated.",
|
|
79563
|
-
"nullable": true,
|
|
79564
|
-
"enum": ["source", "generated", "test", "library"]
|
|
79565
|
-
}
|
|
79566
|
-
}
|
|
79567
|
-
}
|
|
79568
|
-
}
|
|
79569
|
-
},
|
|
79570
|
-
"required": [
|
|
79571
|
-
"number",
|
|
79572
|
-
"created_at",
|
|
79573
|
-
"url",
|
|
79574
|
-
"html_url",
|
|
79575
|
-
"instances_url",
|
|
79576
|
-
"state",
|
|
79577
|
-
"dismissed_by",
|
|
79578
|
-
"dismissed_at",
|
|
79579
|
-
"dismissed_reason",
|
|
79580
|
-
"rule",
|
|
79581
|
-
"tool",
|
|
79582
|
-
"most_recent_instance"
|
|
79583
|
-
]
|
|
79584
|
-
}
|
|
79585
|
-
},
|
|
79586
|
-
"examples": {
|
|
79587
|
-
"default": {
|
|
79588
|
-
"value": [
|
|
79589
|
-
{
|
|
79590
|
-
"number": 4,
|
|
79591
|
-
"created_at": "2020-02-13T12:29:18Z",
|
|
79592
|
-
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4",
|
|
79593
|
-
"html_url": "https://github.com/octocat/hello-world/code-scanning/4",
|
|
79594
|
-
"state": "open",
|
|
79595
|
-
"fixed_at": null,
|
|
79596
|
-
"dismissed_by": null,
|
|
79597
|
-
"dismissed_at": null,
|
|
79598
|
-
"dismissed_reason": null,
|
|
79599
|
-
"rule": {
|
|
79600
|
-
"id": "js/zipslip",
|
|
79601
|
-
"severity": "error",
|
|
79602
|
-
"tags": ["security", "external/cwe/cwe-022"],
|
|
79603
|
-
"description": "Arbitrary file write during zip extraction",
|
|
79604
|
-
"name": "js/zipslip"
|
|
79605
|
-
},
|
|
79606
|
-
"tool": {
|
|
79607
|
-
"name": "CodeQL",
|
|
79608
|
-
"guid": null,
|
|
79609
|
-
"version": "2.4.0"
|
|
79610
|
-
},
|
|
79611
|
-
"most_recent_instance": {
|
|
79612
|
-
"ref": "refs/heads/main",
|
|
79613
|
-
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
|
|
79614
|
-
"environment": "{}",
|
|
79615
|
-
"state": "open",
|
|
79616
|
-
"commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
|
|
79617
|
-
"message": {
|
|
79618
|
-
"text": "This path depends on a user-provided value."
|
|
79619
|
-
},
|
|
79620
|
-
"location": {
|
|
79621
|
-
"path": "spec-main/api-session-spec.ts",
|
|
79622
|
-
"start_line": 917,
|
|
79623
|
-
"end_line": 917,
|
|
79624
|
-
"start_column": 7,
|
|
79625
|
-
"end_column": 18
|
|
79626
|
-
},
|
|
79627
|
-
"classifications": ["test"]
|
|
79628
|
-
},
|
|
79629
|
-
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances"
|
|
79630
|
-
},
|
|
79631
|
-
{
|
|
79632
|
-
"number": 3,
|
|
79633
|
-
"created_at": "2020-02-13T12:29:18Z",
|
|
79634
|
-
"url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3",
|
|
79635
|
-
"html_url": "https://github.com/octocat/hello-world/code-scanning/3",
|
|
79636
|
-
"state": "dismissed",
|
|
79637
|
-
"fixed_at": null,
|
|
79638
|
-
"dismissed_by": {
|
|
79639
|
-
"login": "octocat",
|
|
79640
|
-
"id": 1,
|
|
79641
|
-
"node_id": "MDQ6VXNlcjE=",
|
|
79642
|
-
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
79643
|
-
"gravatar_id": "",
|
|
79644
|
-
"url": "https://api.github.com/users/octocat",
|
|
79645
|
-
"html_url": "https://github.com/octocat",
|
|
79646
|
-
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
79647
|
-
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
79648
|
-
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
79649
|
-
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
79650
|
-
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
79651
|
-
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
79652
|
-
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
79653
|
-
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
79654
|
-
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
79655
|
-
"type": "User",
|
|
79656
|
-
"site_admin": false
|
|
79657
|
-
},
|
|
79658
|
-
"dismissed_at": "2020-02-14T12:29:18Z",
|
|
79659
|
-
"dismissed_reason": "false positive",
|
|
79660
|
-
"rule": {
|
|
79661
|
-
"id": "js/zipslip",
|
|
79662
|
-
"severity": "error",
|
|
79663
|
-
"tags": ["security", "external/cwe/cwe-022"],
|
|
79664
|
-
"description": "Arbitrary file write during zip extraction",
|
|
79665
|
-
"name": "js/zipslip"
|
|
79666
|
-
},
|
|
79667
|
-
"tool": {
|
|
79668
|
-
"name": "CodeQL",
|
|
79669
|
-
"guid": null,
|
|
79670
|
-
"version": "2.4.0"
|
|
79671
|
-
},
|
|
79672
|
-
"most_recent_instance": {
|
|
79673
|
-
"ref": "refs/heads/main",
|
|
79674
|
-
"analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build",
|
|
79675
|
-
"environment": "{}",
|
|
79676
|
-
"state": "open",
|
|
79677
|
-
"commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930",
|
|
79678
|
-
"message": {
|
|
79679
|
-
"text": "This path depends on a user-provided value."
|
|
79680
|
-
},
|
|
79681
|
-
"location": {
|
|
79682
|
-
"path": "lib/ab12-gen.js",
|
|
79683
|
-
"start_line": 917,
|
|
79684
|
-
"end_line": 917,
|
|
79685
|
-
"start_column": 7,
|
|
79686
|
-
"end_column": 18
|
|
79687
|
-
},
|
|
79688
|
-
"classifications": []
|
|
79689
|
-
},
|
|
79690
|
-
"instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances"
|
|
79691
|
-
}
|
|
79692
|
-
]
|
|
79693
|
-
}
|
|
79694
|
-
}
|
|
79695
|
-
}
|
|
79696
|
-
}
|
|
79697
|
-
},
|
|
79698
|
-
"304": { "description": "Not modified" },
|
|
79699
|
-
"403": {
|
|
79700
|
-
"description": "Response if GitHub Advanced Security is not enabled for this repository",
|
|
79701
|
-
"content": {
|
|
79702
|
-
"application/json": {
|
|
79703
|
-
"schema": {
|
|
79704
|
-
"title": "Basic Error",
|
|
79705
|
-
"description": "Basic Error",
|
|
79706
|
-
"type": "object",
|
|
79707
|
-
"properties": {
|
|
79708
|
-
"message": { "type": "string" },
|
|
79709
|
-
"documentation_url": { "type": "string" },
|
|
79710
|
-
"url": { "type": "string" },
|
|
79711
|
-
"status": { "type": "string" }
|
|
79712
|
-
}
|
|
79713
|
-
}
|
|
79714
|
-
}
|
|
79715
|
-
}
|
|
79716
|
-
},
|
|
79717
|
-
"404": {
|
|
79718
|
-
"description": "Resource not found",
|
|
79719
|
-
"content": {
|
|
79720
|
-
"application/json": {
|
|
79721
|
-
"schema": {
|
|
79722
|
-
"title": "Basic Error",
|
|
79723
|
-
"description": "Basic Error",
|
|
79724
|
-
"type": "object",
|
|
79725
|
-
"properties": {
|
|
79726
|
-
"message": { "type": "string" },
|
|
79727
|
-
"documentation_url": { "type": "string" },
|
|
79728
|
-
"url": { "type": "string" },
|
|
79729
|
-
"status": { "type": "string" }
|
|
79730
|
-
}
|
|
79731
|
-
}
|
|
79732
|
-
}
|
|
79733
|
-
}
|
|
79734
|
-
},
|
|
79735
|
-
"503": {
|
|
79736
|
-
"description": "Service unavailable",
|
|
79737
|
-
"content": {
|
|
79738
|
-
"application/json": {
|
|
79739
|
-
"schema": {
|
|
79740
|
-
"type": "object",
|
|
79741
|
-
"properties": {
|
|
79742
|
-
"code": { "type": "string" },
|
|
79743
|
-
"message": { "type": "string" },
|
|
79744
|
-
"documentation_url": { "type": "string" }
|
|
79745
|
-
}
|
|
79746
|
-
}
|
|
79747
|
-
}
|
|
79748
|
-
}
|
|
79749
|
-
}
|
|
79750
|
-
},
|
|
79751
|
-
"x-github": {
|
|
79752
|
-
"githubCloudOnly": false,
|
|
79753
|
-
"enabledForGitHubApps": true,
|
|
79754
|
-
"category": "code-scanning",
|
|
79755
|
-
"subcategory": null
|
|
79756
|
-
},
|
|
79757
|
-
"x-octokit": { "diff": { "api.github.com": { "type": "changed" } } }
|
|
79758
|
-
}
|
|
79759
|
-
},
|
|
79760
79406
|
"/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": {
|
|
79761
79407
|
"get": {
|
|
79762
79408
|
"summary": "Get a code scanning alert",
|