@octokit/openapi 11.0.0 → 11.1.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 +7446 -606
- package/generated/api.github.com.json +1135 -104
- package/generated/ghec-diff-to-api.github.com.deref.json +4944 -11
- package/generated/ghec-diff-to-api.github.com.json +92 -1
- package/generated/ghec.deref.json +7446 -606
- package/generated/ghec.json +1135 -104
- package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +2 -2
- package/generated/ghes-3.5-diff-to-ghes-3.6.json +2 -2
- package/generated/ghes-3.5.deref.json +2 -2
- package/generated/ghes-3.5.json +2 -2
- package/generated/ghes-3.6-diff-to-ghes-3.7.deref.json +2 -2
- package/generated/ghes-3.6-diff-to-ghes-3.7.json +2 -2
- package/generated/ghes-3.6.deref.json +2 -2
- package/generated/ghes-3.6.json +2 -2
- package/generated/ghes-3.7-diff-to-ghes-3.8.deref.json +252 -11
- package/generated/ghes-3.7-diff-to-ghes-3.8.json +1 -1
- package/generated/ghes-3.7.deref.json +253 -12
- package/generated/ghes-3.7.json +115 -12
- package/generated/ghes-3.8-anicca-diff-to-api.github.com.deref.json +17 -0
- package/generated/ghes-3.8-diff-to-api.github.com.deref.json +252 -11
- package/generated/ghes-3.8-diff-to-api.github.com.json +1 -1
- package/generated/ghes-3.8.deref.json +403 -12
- package/generated/ghes-3.8.json +265 -12
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +17 -0
- package/generated/github.ae-diff-to-api.github.com.deref.json +4996 -146
- package/generated/github.ae-diff-to-api.github.com.json +96 -5
- package/generated/github.ae.deref.json +5146 -146
- package/generated/github.ae.json +405 -15
- package/package.json +1 -1
package/generated/ghes-3.8.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "11.
|
|
4
|
+
"version": "11.1.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": {
|
|
@@ -37082,7 +37082,7 @@
|
|
|
37082
37082
|
"/repos/{owner}/{repo}/events": {
|
|
37083
37083
|
"get": {
|
|
37084
37084
|
"summary": "List repository events",
|
|
37085
|
-
"description": "",
|
|
37085
|
+
"description": "**Note**: This API is not built to serve real-time use cases. Depending on the time of day, event latency can be anywhere from 30s to 6h.\n",
|
|
37086
37086
|
"tags": [
|
|
37087
37087
|
"activity"
|
|
37088
37088
|
],
|
|
@@ -62006,6 +62006,28 @@
|
|
|
62006
62006
|
}
|
|
62007
62007
|
}
|
|
62008
62008
|
},
|
|
62009
|
+
"/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": {
|
|
62010
|
+
"post": {
|
|
62011
|
+
"summary": "Review custom deployment protection rules for a workflow run",
|
|
62012
|
+
"description": "This endpoint does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
|
|
62013
|
+
"tags": [
|
|
62014
|
+
"actions"
|
|
62015
|
+
],
|
|
62016
|
+
"operationId": "actions/review-custom-gates-for-run",
|
|
62017
|
+
"externalDocs": {
|
|
62018
|
+
"description": "API method documentation",
|
|
62019
|
+
"url": "https://docs.github.com/rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run"
|
|
62020
|
+
},
|
|
62021
|
+
"x-octokit": {
|
|
62022
|
+
"api.github.com": "removed"
|
|
62023
|
+
},
|
|
62024
|
+
"responses": {
|
|
62025
|
+
"501": {
|
|
62026
|
+
"description": "Not Implemented"
|
|
62027
|
+
}
|
|
62028
|
+
}
|
|
62029
|
+
}
|
|
62030
|
+
},
|
|
62009
62031
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/timing": {
|
|
62010
62032
|
"get": {
|
|
62011
62033
|
"summary": "Get workflow run usage",
|
|
@@ -62436,6 +62458,112 @@
|
|
|
62436
62458
|
}
|
|
62437
62459
|
}
|
|
62438
62460
|
},
|
|
62461
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": {
|
|
62462
|
+
"get": {
|
|
62463
|
+
"summary": "Get all deployment protection rules for an environment",
|
|
62464
|
+
"description": "This endpoint does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
|
|
62465
|
+
"tags": [
|
|
62466
|
+
"repos"
|
|
62467
|
+
],
|
|
62468
|
+
"operationId": "repos/get-all-deployment-protection-rules",
|
|
62469
|
+
"externalDocs": {
|
|
62470
|
+
"description": "API method documentation",
|
|
62471
|
+
"url": "https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules"
|
|
62472
|
+
},
|
|
62473
|
+
"x-octokit": {
|
|
62474
|
+
"api.github.com": "removed"
|
|
62475
|
+
},
|
|
62476
|
+
"responses": {
|
|
62477
|
+
"501": {
|
|
62478
|
+
"description": "Not Implemented"
|
|
62479
|
+
}
|
|
62480
|
+
}
|
|
62481
|
+
},
|
|
62482
|
+
"post": {
|
|
62483
|
+
"summary": "Create a custom deployment protection rule on an environment",
|
|
62484
|
+
"description": "This endpoint does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
|
|
62485
|
+
"tags": [
|
|
62486
|
+
"repos"
|
|
62487
|
+
],
|
|
62488
|
+
"operationId": "repos/create-deployment-protection-rule",
|
|
62489
|
+
"externalDocs": {
|
|
62490
|
+
"description": "API method documentation",
|
|
62491
|
+
"url": "https://docs.github.com/rest/deployments/deployment-protection-rules#create-a-deployment-protection-rule"
|
|
62492
|
+
},
|
|
62493
|
+
"x-octokit": {
|
|
62494
|
+
"api.github.com": "removed"
|
|
62495
|
+
},
|
|
62496
|
+
"responses": {
|
|
62497
|
+
"501": {
|
|
62498
|
+
"description": "Not Implemented"
|
|
62499
|
+
}
|
|
62500
|
+
}
|
|
62501
|
+
}
|
|
62502
|
+
},
|
|
62503
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": {
|
|
62504
|
+
"get": {
|
|
62505
|
+
"summary": "List custom deployment rule integrations available for an environment",
|
|
62506
|
+
"description": "This endpoint does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
|
|
62507
|
+
"tags": [
|
|
62508
|
+
"repos"
|
|
62509
|
+
],
|
|
62510
|
+
"operationId": "repos/list-custom-deployment-rule-integrations",
|
|
62511
|
+
"externalDocs": {
|
|
62512
|
+
"description": "API method documentation",
|
|
62513
|
+
"url": "https://docs.github.com/rest/deployments/protection-rules#list-custom-deployment-rule-integrations"
|
|
62514
|
+
},
|
|
62515
|
+
"x-octokit": {
|
|
62516
|
+
"api.github.com": "removed"
|
|
62517
|
+
},
|
|
62518
|
+
"responses": {
|
|
62519
|
+
"501": {
|
|
62520
|
+
"description": "Not Implemented"
|
|
62521
|
+
}
|
|
62522
|
+
}
|
|
62523
|
+
}
|
|
62524
|
+
},
|
|
62525
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": {
|
|
62526
|
+
"get": {
|
|
62527
|
+
"summary": "Get a custom deployment protection rule",
|
|
62528
|
+
"description": "This endpoint does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
|
|
62529
|
+
"tags": [
|
|
62530
|
+
"repos"
|
|
62531
|
+
],
|
|
62532
|
+
"operationId": "repos/get-custom-deployment-protection-rule",
|
|
62533
|
+
"externalDocs": {
|
|
62534
|
+
"description": "API method documentation",
|
|
62535
|
+
"url": "https://docs.github.com/rest/deployments/protection-rules#get-a-deployment-protection-rule"
|
|
62536
|
+
},
|
|
62537
|
+
"x-octokit": {
|
|
62538
|
+
"api.github.com": "removed"
|
|
62539
|
+
},
|
|
62540
|
+
"responses": {
|
|
62541
|
+
"501": {
|
|
62542
|
+
"description": "Not Implemented"
|
|
62543
|
+
}
|
|
62544
|
+
}
|
|
62545
|
+
},
|
|
62546
|
+
"delete": {
|
|
62547
|
+
"summary": "Disable a custom protection rule for an environment",
|
|
62548
|
+
"description": "This endpoint does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
|
|
62549
|
+
"tags": [
|
|
62550
|
+
"repos"
|
|
62551
|
+
],
|
|
62552
|
+
"operationId": "repos/disable-deployment-protection-rule",
|
|
62553
|
+
"externalDocs": {
|
|
62554
|
+
"description": "API method documentation",
|
|
62555
|
+
"url": "https://docs.github.com/rest/deployments/protection-rules#disable-deployment-protection-rule"
|
|
62556
|
+
},
|
|
62557
|
+
"x-octokit": {
|
|
62558
|
+
"api.github.com": "removed"
|
|
62559
|
+
},
|
|
62560
|
+
"responses": {
|
|
62561
|
+
"501": {
|
|
62562
|
+
"description": "Not Implemented"
|
|
62563
|
+
}
|
|
62564
|
+
}
|
|
62565
|
+
}
|
|
62566
|
+
},
|
|
62439
62567
|
"/repos/{owner}/{repo}/import": {
|
|
62440
62568
|
"get": {
|
|
62441
62569
|
"summary": "Get an import status",
|
|
@@ -62880,6 +63008,28 @@
|
|
|
62880
63008
|
}
|
|
62881
63009
|
}
|
|
62882
63010
|
},
|
|
63011
|
+
"/repos/{owner}/{repo}/security-advisories/reports": {
|
|
63012
|
+
"post": {
|
|
63013
|
+
"summary": "Privately report a security vulnerability",
|
|
63014
|
+
"description": "This endpoint does not exist in GitHub Enterprise Server 3.8. It was added in api.github.com",
|
|
63015
|
+
"tags": [
|
|
63016
|
+
"security-advisories"
|
|
63017
|
+
],
|
|
63018
|
+
"operationId": "security-advisories/create-private-vulnerability-report",
|
|
63019
|
+
"externalDocs": {
|
|
63020
|
+
"description": "API method documentation",
|
|
63021
|
+
"url": "https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability"
|
|
63022
|
+
},
|
|
63023
|
+
"x-octokit": {
|
|
63024
|
+
"api.github.com": "removed"
|
|
63025
|
+
},
|
|
63026
|
+
"responses": {
|
|
63027
|
+
"501": {
|
|
63028
|
+
"description": "Not Implemented"
|
|
63029
|
+
}
|
|
63030
|
+
}
|
|
63031
|
+
}
|
|
63032
|
+
},
|
|
62883
63033
|
"/repos/{owner}/{repo}/security-advisories/{ghsa_id}": {
|
|
62884
63034
|
"get": {
|
|
62885
63035
|
"summary": "Get a repository security advisory",
|
|
@@ -163281,6 +163431,56 @@
|
|
|
163281
163431
|
"sender"
|
|
163282
163432
|
]
|
|
163283
163433
|
},
|
|
163434
|
+
"webhook-rubygems-metadata": {
|
|
163435
|
+
"title": "Ruby Gems metadata",
|
|
163436
|
+
"type": "object",
|
|
163437
|
+
"properties": {
|
|
163438
|
+
"name": {
|
|
163439
|
+
"type": "string"
|
|
163440
|
+
},
|
|
163441
|
+
"description": {
|
|
163442
|
+
"type": "string"
|
|
163443
|
+
},
|
|
163444
|
+
"readme": {
|
|
163445
|
+
"type": "string"
|
|
163446
|
+
},
|
|
163447
|
+
"homepage": {
|
|
163448
|
+
"type": "string"
|
|
163449
|
+
},
|
|
163450
|
+
"version_info": {
|
|
163451
|
+
"type": "object",
|
|
163452
|
+
"properties": {
|
|
163453
|
+
"version": {
|
|
163454
|
+
"type": "string"
|
|
163455
|
+
}
|
|
163456
|
+
}
|
|
163457
|
+
},
|
|
163458
|
+
"platform": {
|
|
163459
|
+
"type": "string"
|
|
163460
|
+
},
|
|
163461
|
+
"metadata": {
|
|
163462
|
+
"type": "object",
|
|
163463
|
+
"additionalProperties": {
|
|
163464
|
+
"type": "string"
|
|
163465
|
+
}
|
|
163466
|
+
},
|
|
163467
|
+
"repo": {
|
|
163468
|
+
"type": "string"
|
|
163469
|
+
},
|
|
163470
|
+
"dependencies": {
|
|
163471
|
+
"type": "array",
|
|
163472
|
+
"items": {
|
|
163473
|
+
"type": "object",
|
|
163474
|
+
"additionalProperties": {
|
|
163475
|
+
"type": "string"
|
|
163476
|
+
}
|
|
163477
|
+
}
|
|
163478
|
+
},
|
|
163479
|
+
"commit_oid": {
|
|
163480
|
+
"type": "string"
|
|
163481
|
+
}
|
|
163482
|
+
}
|
|
163483
|
+
},
|
|
163284
163484
|
"webhook-package-published": {
|
|
163285
163485
|
"title": "package published event",
|
|
163286
163486
|
"type": "object",
|
|
@@ -163565,7 +163765,17 @@
|
|
|
163565
163765
|
},
|
|
163566
163766
|
"docker_metadata": {
|
|
163567
163767
|
"type": "array",
|
|
163568
|
-
"items": {
|
|
163768
|
+
"items": {
|
|
163769
|
+
"type": "object",
|
|
163770
|
+
"properties": {
|
|
163771
|
+
"tags": {
|
|
163772
|
+
"type": "array",
|
|
163773
|
+
"items": {
|
|
163774
|
+
"type": "string"
|
|
163775
|
+
}
|
|
163776
|
+
}
|
|
163777
|
+
}
|
|
163778
|
+
}
|
|
163569
163779
|
},
|
|
163570
163780
|
"draft": {
|
|
163571
163781
|
"type": "boolean"
|
|
@@ -163995,7 +164205,9 @@
|
|
|
163995
164205
|
},
|
|
163996
164206
|
"rubygems_metadata": {
|
|
163997
164207
|
"type": "array",
|
|
163998
|
-
"items": {
|
|
164208
|
+
"items": {
|
|
164209
|
+
"$ref": "#/components/schemas/webhook-rubygems-metadata"
|
|
164210
|
+
}
|
|
163999
164211
|
},
|
|
164000
164212
|
"source_url": {
|
|
164001
164213
|
"type": "string"
|
|
@@ -164344,7 +164556,17 @@
|
|
|
164344
164556
|
},
|
|
164345
164557
|
"docker_metadata": {
|
|
164346
164558
|
"type": "array",
|
|
164347
|
-
"items": {
|
|
164559
|
+
"items": {
|
|
164560
|
+
"type": "object",
|
|
164561
|
+
"properties": {
|
|
164562
|
+
"tags": {
|
|
164563
|
+
"type": "array",
|
|
164564
|
+
"items": {
|
|
164565
|
+
"type": "string"
|
|
164566
|
+
}
|
|
164567
|
+
}
|
|
164568
|
+
}
|
|
164569
|
+
}
|
|
164348
164570
|
},
|
|
164349
164571
|
"draft": {
|
|
164350
164572
|
"type": "boolean"
|
|
@@ -164364,7 +164586,10 @@
|
|
|
164364
164586
|
},
|
|
164365
164587
|
"metadata": {
|
|
164366
164588
|
"type": "array",
|
|
164367
|
-
"items": {
|
|
164589
|
+
"items": {
|
|
164590
|
+
"type": "object",
|
|
164591
|
+
"additionalProperties": true
|
|
164592
|
+
}
|
|
164368
164593
|
},
|
|
164369
164594
|
"name": {
|
|
164370
164595
|
"type": "string"
|
|
@@ -164576,7 +164801,9 @@
|
|
|
164576
164801
|
},
|
|
164577
164802
|
"rubygems_metadata": {
|
|
164578
164803
|
"type": "array",
|
|
164579
|
-
"items": {
|
|
164804
|
+
"items": {
|
|
164805
|
+
"$ref": "#/components/schemas/webhook-rubygems-metadata"
|
|
164806
|
+
}
|
|
164580
164807
|
},
|
|
164581
164808
|
"source_url": {
|
|
164582
164809
|
"type": "string",
|
|
@@ -239282,7 +239509,17 @@
|
|
|
239282
239509
|
},
|
|
239283
239510
|
"docker_metadata": {
|
|
239284
239511
|
"type": "array",
|
|
239285
|
-
"items": {
|
|
239512
|
+
"items": {
|
|
239513
|
+
"type": "object",
|
|
239514
|
+
"properties": {
|
|
239515
|
+
"tags": {
|
|
239516
|
+
"type": "array",
|
|
239517
|
+
"items": {
|
|
239518
|
+
"type": "string"
|
|
239519
|
+
}
|
|
239520
|
+
}
|
|
239521
|
+
}
|
|
239522
|
+
}
|
|
239286
239523
|
},
|
|
239287
239524
|
"draft": {
|
|
239288
239525
|
"type": "boolean"
|
|
@@ -239701,7 +239938,9 @@
|
|
|
239701
239938
|
},
|
|
239702
239939
|
"rubygems_metadata": {
|
|
239703
239940
|
"type": "array",
|
|
239704
|
-
"items": {
|
|
239941
|
+
"items": {
|
|
239942
|
+
"$ref": "#/components/schemas/webhook-rubygems-metadata"
|
|
239943
|
+
}
|
|
239705
239944
|
},
|
|
239706
239945
|
"summary": {
|
|
239707
239946
|
"type": "string"
|
|
@@ -240007,7 +240246,16 @@
|
|
|
240007
240246
|
"docker_metadata": {
|
|
240008
240247
|
"type": "array",
|
|
240009
240248
|
"items": {
|
|
240010
|
-
"
|
|
240249
|
+
"type": "object",
|
|
240250
|
+
"nullable": true,
|
|
240251
|
+
"properties": {
|
|
240252
|
+
"tags": {
|
|
240253
|
+
"type": "array",
|
|
240254
|
+
"items": {
|
|
240255
|
+
"type": "string"
|
|
240256
|
+
}
|
|
240257
|
+
}
|
|
240258
|
+
}
|
|
240011
240259
|
}
|
|
240012
240260
|
},
|
|
240013
240261
|
"draft": {
|
|
@@ -240027,7 +240275,10 @@
|
|
|
240027
240275
|
},
|
|
240028
240276
|
"metadata": {
|
|
240029
240277
|
"type": "array",
|
|
240030
|
-
"items": {
|
|
240278
|
+
"items": {
|
|
240279
|
+
"type": "object",
|
|
240280
|
+
"additionalProperties": true
|
|
240281
|
+
}
|
|
240031
240282
|
},
|
|
240032
240283
|
"name": {
|
|
240033
240284
|
"type": "string"
|
|
@@ -240210,7 +240461,9 @@
|
|
|
240210
240461
|
},
|
|
240211
240462
|
"rubygems_metadata": {
|
|
240212
240463
|
"type": "array",
|
|
240213
|
-
"items": {
|
|
240464
|
+
"items": {
|
|
240465
|
+
"$ref": "#/components/schemas/webhook-rubygems-metadata"
|
|
240466
|
+
}
|
|
240214
240467
|
},
|
|
240215
240468
|
"summary": {
|
|
240216
240469
|
"type": "string"
|
|
@@ -18445,6 +18445,9 @@
|
|
|
18445
18445
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/approve": [
|
|
18446
18446
|
"post"
|
|
18447
18447
|
],
|
|
18448
|
+
"/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": [
|
|
18449
|
+
"post"
|
|
18450
|
+
],
|
|
18448
18451
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": [
|
|
18449
18452
|
"get",
|
|
18450
18453
|
"post"
|
|
@@ -18532,6 +18535,17 @@
|
|
|
18532
18535
|
"/repos/{owner}/{repo}/dependency-graph/snapshots": [
|
|
18533
18536
|
"post"
|
|
18534
18537
|
],
|
|
18538
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": [
|
|
18539
|
+
"get",
|
|
18540
|
+
"post"
|
|
18541
|
+
],
|
|
18542
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": [
|
|
18543
|
+
"get"
|
|
18544
|
+
],
|
|
18545
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": [
|
|
18546
|
+
"get",
|
|
18547
|
+
"delete"
|
|
18548
|
+
],
|
|
18535
18549
|
"/repos/{owner}/{repo}/import": [
|
|
18536
18550
|
"get",
|
|
18537
18551
|
"put",
|
|
@@ -18583,6 +18597,9 @@
|
|
|
18583
18597
|
"get",
|
|
18584
18598
|
"post"
|
|
18585
18599
|
],
|
|
18600
|
+
"/repos/{owner}/{repo}/security-advisories/reports": [
|
|
18601
|
+
"post"
|
|
18602
|
+
],
|
|
18586
18603
|
"/repos/{owner}/{repo}/security-advisories/{ghsa_id}": [
|
|
18587
18604
|
"get",
|
|
18588
18605
|
"patch"
|