@octokit/openapi 11.0.0 → 11.1.1
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 +7867 -1059
- package/generated/api.github.com.json +1150 -152
- 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 +7870 -1062
- package/generated/ghec.json +1153 -155
- package/generated/ghes-3.5-anicca-diff-to-ghes-3.6.deref.json +0 -84
- package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +292 -4865
- package/generated/ghes-3.5-diff-to-ghes-3.6.json +2 -675
- package/generated/ghes-3.5.deref.json +208 -60
- package/generated/ghes-3.5.json +21 -60
- package/generated/ghes-3.6-anicca-diff-to-ghes-3.7.deref.json +0 -48
- package/generated/ghes-3.6-diff-to-ghes-3.7.deref.json +2 -4739
- package/generated/ghes-3.6-diff-to-ghes-3.7.json +2 -684
- package/generated/ghes-3.6.deref.json +44 -60
- package/generated/ghes-3.6.json +21 -60
- 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 +282 -63
- package/generated/ghes-3.7.json +133 -63
- package/generated/ghes-3.8-anicca-diff-to-api.github.com.deref.json +17 -38
- package/generated/ghes-3.8-diff-to-api.github.com.deref.json +252 -4758
- package/generated/ghes-3.8-diff-to-api.github.com.json +1 -672
- package/generated/ghes-3.8.deref.json +433 -70
- package/generated/ghes-3.8.json +284 -70
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +17 -84
- package/generated/github.ae-diff-to-api.github.com.deref.json +13247 -12990
- package/generated/github.ae-diff-to-api.github.com.json +1351 -1935
- package/generated/github.ae.deref.json +5201 -73
- package/generated/github.ae.json +424 -73
- package/package.json +1 -1
package/generated/ghec.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
|
-
"version": "11.
|
|
4
|
+
"version": "11.1.1",
|
|
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": {
|
|
@@ -5182,7 +5182,7 @@
|
|
|
5182
5182
|
"operationId": "gists/update",
|
|
5183
5183
|
"externalDocs": {
|
|
5184
5184
|
"description": "API method documentation",
|
|
5185
|
-
"url": "https://docs.github.com/
|
|
5185
|
+
"url": "https://docs.github.com/rest/reference/gists/#update-a-gist"
|
|
5186
5186
|
},
|
|
5187
5187
|
"parameters": [
|
|
5188
5188
|
{
|
|
@@ -5194,6 +5194,7 @@
|
|
|
5194
5194
|
"content": {
|
|
5195
5195
|
"application/json": {
|
|
5196
5196
|
"schema": {
|
|
5197
|
+
"type": "object",
|
|
5197
5198
|
"properties": {
|
|
5198
5199
|
"description": {
|
|
5199
5200
|
"description": "The description of the gist.",
|
|
@@ -5210,29 +5211,20 @@
|
|
|
5210
5211
|
},
|
|
5211
5212
|
"type": "object",
|
|
5212
5213
|
"additionalProperties": {
|
|
5213
|
-
"
|
|
5214
|
-
"nullable": true,
|
|
5215
|
-
"properties": {
|
|
5216
|
-
"content": {
|
|
5217
|
-
"description": "The new content of the file.",
|
|
5218
|
-
"type": "string"
|
|
5219
|
-
},
|
|
5220
|
-
"filename": {
|
|
5221
|
-
"description": "The new filename for the file.",
|
|
5222
|
-
"type": "string",
|
|
5223
|
-
"nullable": true
|
|
5224
|
-
}
|
|
5225
|
-
},
|
|
5226
|
-
"anyOf": [
|
|
5227
|
-
{
|
|
5228
|
-
"required": [
|
|
5229
|
-
"content"
|
|
5230
|
-
]
|
|
5231
|
-
},
|
|
5214
|
+
"oneOf": [
|
|
5232
5215
|
{
|
|
5233
|
-
"
|
|
5234
|
-
|
|
5235
|
-
|
|
5216
|
+
"type": "object",
|
|
5217
|
+
"properties": {
|
|
5218
|
+
"content": {
|
|
5219
|
+
"description": "The new content of the file.",
|
|
5220
|
+
"type": "string"
|
|
5221
|
+
},
|
|
5222
|
+
"filename": {
|
|
5223
|
+
"description": "The new filename for the file.",
|
|
5224
|
+
"type": "string",
|
|
5225
|
+
"nullable": true
|
|
5226
|
+
}
|
|
5227
|
+
}
|
|
5236
5228
|
},
|
|
5237
5229
|
{
|
|
5238
5230
|
"type": "object",
|
|
@@ -5242,19 +5234,6 @@
|
|
|
5242
5234
|
}
|
|
5243
5235
|
}
|
|
5244
5236
|
},
|
|
5245
|
-
"anyOf": [
|
|
5246
|
-
{
|
|
5247
|
-
"required": [
|
|
5248
|
-
"description"
|
|
5249
|
-
]
|
|
5250
|
-
},
|
|
5251
|
-
{
|
|
5252
|
-
"required": [
|
|
5253
|
-
"files"
|
|
5254
|
-
]
|
|
5255
|
-
}
|
|
5256
|
-
],
|
|
5257
|
-
"type": "object",
|
|
5258
5237
|
"nullable": true
|
|
5259
5238
|
},
|
|
5260
5239
|
"examples": {
|
|
@@ -19401,10 +19380,9 @@
|
|
|
19401
19380
|
"examples": {
|
|
19402
19381
|
"default": {
|
|
19403
19382
|
"value": {
|
|
19404
|
-
"id": 21,
|
|
19405
19383
|
"name": "super cool ruleset",
|
|
19406
19384
|
"target": "branch",
|
|
19407
|
-
"enforcement": "
|
|
19385
|
+
"enforcement": "active",
|
|
19408
19386
|
"bypass_actors": [
|
|
19409
19387
|
{
|
|
19410
19388
|
"actor_id": 234,
|
|
@@ -19596,10 +19574,9 @@
|
|
|
19596
19574
|
"examples": {
|
|
19597
19575
|
"default": {
|
|
19598
19576
|
"value": {
|
|
19599
|
-
"id": 21,
|
|
19600
19577
|
"name": "super cool ruleset",
|
|
19601
19578
|
"target": "branch",
|
|
19602
|
-
"enforcement": "
|
|
19579
|
+
"enforcement": "active",
|
|
19603
19580
|
"bypass_actors": [
|
|
19604
19581
|
{
|
|
19605
19582
|
"actor_id": 234,
|
|
@@ -27485,6 +27462,70 @@
|
|
|
27485
27462
|
"x-octokit": {}
|
|
27486
27463
|
}
|
|
27487
27464
|
},
|
|
27465
|
+
"/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": {
|
|
27466
|
+
"post": {
|
|
27467
|
+
"summary": "Review custom deployment protection rules for a workflow run",
|
|
27468
|
+
"description": "Approve or reject custom deployment protection rules provided by a GitHub App for a workflow run. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\n**Note:** GitHub Apps can only review their own custom deployment protection rules.\nTo approve or reject pending deployments that are waiting for review from a specific person or team, see [`POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments`](/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run).\n\nGitHub Apps must have read and write permission for **Deployments** to use this endpoint.",
|
|
27469
|
+
"tags": [
|
|
27470
|
+
"actions"
|
|
27471
|
+
],
|
|
27472
|
+
"operationId": "actions/review-custom-gates-for-run",
|
|
27473
|
+
"externalDocs": {
|
|
27474
|
+
"description": "API method documentation",
|
|
27475
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run"
|
|
27476
|
+
},
|
|
27477
|
+
"parameters": [
|
|
27478
|
+
{
|
|
27479
|
+
"$ref": "#/components/parameters/owner"
|
|
27480
|
+
},
|
|
27481
|
+
{
|
|
27482
|
+
"$ref": "#/components/parameters/repo"
|
|
27483
|
+
},
|
|
27484
|
+
{
|
|
27485
|
+
"$ref": "#/components/parameters/run-id"
|
|
27486
|
+
}
|
|
27487
|
+
],
|
|
27488
|
+
"requestBody": {
|
|
27489
|
+
"required": true,
|
|
27490
|
+
"content": {
|
|
27491
|
+
"application/json": {
|
|
27492
|
+
"schema": {
|
|
27493
|
+
"anyOf": [
|
|
27494
|
+
{
|
|
27495
|
+
"$ref": "#/components/schemas/review-custom-gates-comment-required"
|
|
27496
|
+
},
|
|
27497
|
+
{
|
|
27498
|
+
"$ref": "#/components/schemas/review-custom-gates-state-required"
|
|
27499
|
+
}
|
|
27500
|
+
]
|
|
27501
|
+
},
|
|
27502
|
+
"examples": {
|
|
27503
|
+
"default": {
|
|
27504
|
+
"value": {
|
|
27505
|
+
"environment_name": "prod-eus",
|
|
27506
|
+
"state": "approved",
|
|
27507
|
+
"comment": "All health checks passed."
|
|
27508
|
+
}
|
|
27509
|
+
}
|
|
27510
|
+
}
|
|
27511
|
+
}
|
|
27512
|
+
}
|
|
27513
|
+
},
|
|
27514
|
+
"responses": {
|
|
27515
|
+
"204": {
|
|
27516
|
+
"description": "Response"
|
|
27517
|
+
}
|
|
27518
|
+
},
|
|
27519
|
+
"x-github": {
|
|
27520
|
+
"githubCloudOnly": false,
|
|
27521
|
+
"enabledForGitHubApps": true,
|
|
27522
|
+
"previews": [],
|
|
27523
|
+
"category": "actions",
|
|
27524
|
+
"subcategory": "workflow-runs"
|
|
27525
|
+
},
|
|
27526
|
+
"x-octokit": {}
|
|
27527
|
+
}
|
|
27528
|
+
},
|
|
27488
27529
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
|
|
27489
27530
|
"get": {
|
|
27490
27531
|
"summary": "List jobs for a workflow run",
|
|
@@ -34649,7 +34690,7 @@
|
|
|
34649
34690
|
"type": "string"
|
|
34650
34691
|
},
|
|
34651
34692
|
"location": {
|
|
34652
|
-
"description": "
|
|
34693
|
+
"description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
|
|
34653
34694
|
"type": "string"
|
|
34654
34695
|
},
|
|
34655
34696
|
"client_ip": {
|
|
@@ -39541,10 +39582,296 @@
|
|
|
39541
39582
|
"x-octokit": {}
|
|
39542
39583
|
}
|
|
39543
39584
|
},
|
|
39585
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": {
|
|
39586
|
+
"get": {
|
|
39587
|
+
"summary": "Get all deployment protection rules for an environment",
|
|
39588
|
+
"description": "Gets all custom deployment protection rules that are enabled for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app).",
|
|
39589
|
+
"tags": [
|
|
39590
|
+
"repos"
|
|
39591
|
+
],
|
|
39592
|
+
"operationId": "repos/get-all-deployment-protection-rules",
|
|
39593
|
+
"externalDocs": {
|
|
39594
|
+
"description": "API method documentation",
|
|
39595
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules"
|
|
39596
|
+
},
|
|
39597
|
+
"parameters": [
|
|
39598
|
+
{
|
|
39599
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39600
|
+
},
|
|
39601
|
+
{
|
|
39602
|
+
"$ref": "#/components/parameters/repo"
|
|
39603
|
+
},
|
|
39604
|
+
{
|
|
39605
|
+
"$ref": "#/components/parameters/owner"
|
|
39606
|
+
}
|
|
39607
|
+
],
|
|
39608
|
+
"responses": {
|
|
39609
|
+
"200": {
|
|
39610
|
+
"description": "List of deployment protection rules",
|
|
39611
|
+
"content": {
|
|
39612
|
+
"application/json": {
|
|
39613
|
+
"schema": {
|
|
39614
|
+
"type": "object",
|
|
39615
|
+
"properties": {
|
|
39616
|
+
"total_count": {
|
|
39617
|
+
"description": "The number of enabled custom deployment protection rules for this environment",
|
|
39618
|
+
"type": "integer",
|
|
39619
|
+
"example": 10
|
|
39620
|
+
},
|
|
39621
|
+
"custom_deployment_protection_rules": {
|
|
39622
|
+
"type": "array",
|
|
39623
|
+
"items": {
|
|
39624
|
+
"$ref": "#/components/schemas/deployment-protection-rule"
|
|
39625
|
+
}
|
|
39626
|
+
}
|
|
39627
|
+
},
|
|
39628
|
+
"example": "../../components/examples/deployment_protection_rules.yaml"
|
|
39629
|
+
}
|
|
39630
|
+
}
|
|
39631
|
+
}
|
|
39632
|
+
}
|
|
39633
|
+
},
|
|
39634
|
+
"x-github": {
|
|
39635
|
+
"githubCloudOnly": false,
|
|
39636
|
+
"enabledForGitHubApps": true,
|
|
39637
|
+
"category": "deployments",
|
|
39638
|
+
"subcategory": "protection-rules"
|
|
39639
|
+
},
|
|
39640
|
+
"x-octokit": {}
|
|
39641
|
+
},
|
|
39642
|
+
"post": {
|
|
39643
|
+
"summary": "Create a custom deployment protection rule on an environment",
|
|
39644
|
+
"description": "Enable a custom deployment protection rule for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. Enabling a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint.\n\nFor more information about the app that is providing this custom deployment rule, see the [documentation for the `GET /apps/{app_slug}` endpoint](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app).",
|
|
39645
|
+
"tags": [
|
|
39646
|
+
"repos"
|
|
39647
|
+
],
|
|
39648
|
+
"operationId": "repos/create-deployment-protection-rule",
|
|
39649
|
+
"externalDocs": {
|
|
39650
|
+
"description": "API method documentation",
|
|
39651
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployment-protection-rules#create-a-deployment-protection-rule"
|
|
39652
|
+
},
|
|
39653
|
+
"parameters": [
|
|
39654
|
+
{
|
|
39655
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39656
|
+
},
|
|
39657
|
+
{
|
|
39658
|
+
"$ref": "#/components/parameters/repo"
|
|
39659
|
+
},
|
|
39660
|
+
{
|
|
39661
|
+
"$ref": "#/components/parameters/owner"
|
|
39662
|
+
}
|
|
39663
|
+
],
|
|
39664
|
+
"requestBody": {
|
|
39665
|
+
"content": {
|
|
39666
|
+
"application/json": {
|
|
39667
|
+
"schema": {
|
|
39668
|
+
"type": "object",
|
|
39669
|
+
"properties": {
|
|
39670
|
+
"integration_id": {
|
|
39671
|
+
"type": "integer",
|
|
39672
|
+
"description": "The ID of the custom app that will be enabled on the environment."
|
|
39673
|
+
}
|
|
39674
|
+
}
|
|
39675
|
+
},
|
|
39676
|
+
"examples": {
|
|
39677
|
+
"default": {
|
|
39678
|
+
"value": {
|
|
39679
|
+
"integration_id": 5
|
|
39680
|
+
}
|
|
39681
|
+
}
|
|
39682
|
+
}
|
|
39683
|
+
}
|
|
39684
|
+
},
|
|
39685
|
+
"required": true
|
|
39686
|
+
},
|
|
39687
|
+
"responses": {
|
|
39688
|
+
"201": {
|
|
39689
|
+
"description": "The enabled custom deployment protection rule",
|
|
39690
|
+
"content": {
|
|
39691
|
+
"application/json": {
|
|
39692
|
+
"schema": {
|
|
39693
|
+
"$ref": "#/components/schemas/deployment-protection-rule"
|
|
39694
|
+
},
|
|
39695
|
+
"examples": {
|
|
39696
|
+
"default": {
|
|
39697
|
+
"$ref": "#/components/examples/deployment-protection-rule"
|
|
39698
|
+
}
|
|
39699
|
+
}
|
|
39700
|
+
}
|
|
39701
|
+
}
|
|
39702
|
+
}
|
|
39703
|
+
},
|
|
39704
|
+
"x-github": {
|
|
39705
|
+
"githubCloudOnly": false,
|
|
39706
|
+
"enabledForGitHubApps": true,
|
|
39707
|
+
"category": "deployments",
|
|
39708
|
+
"subcategory": "protection-rules"
|
|
39709
|
+
},
|
|
39710
|
+
"x-octokit": {}
|
|
39711
|
+
}
|
|
39712
|
+
},
|
|
39713
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": {
|
|
39714
|
+
"get": {
|
|
39715
|
+
"summary": "List custom deployment rule integrations available for an environment",
|
|
39716
|
+
"description": "Gets all custom deployment protection rule integrations that are available for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint.\n\nFor more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see \"[GET an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app)\".",
|
|
39717
|
+
"tags": [
|
|
39718
|
+
"repos"
|
|
39719
|
+
],
|
|
39720
|
+
"operationId": "repos/list-custom-deployment-rule-integrations",
|
|
39721
|
+
"externalDocs": {
|
|
39722
|
+
"description": "API method documentation",
|
|
39723
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations"
|
|
39724
|
+
},
|
|
39725
|
+
"parameters": [
|
|
39726
|
+
{
|
|
39727
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39728
|
+
},
|
|
39729
|
+
{
|
|
39730
|
+
"$ref": "#/components/parameters/repo"
|
|
39731
|
+
},
|
|
39732
|
+
{
|
|
39733
|
+
"$ref": "#/components/parameters/owner"
|
|
39734
|
+
},
|
|
39735
|
+
{
|
|
39736
|
+
"$ref": "#/components/parameters/page"
|
|
39737
|
+
},
|
|
39738
|
+
{
|
|
39739
|
+
"$ref": "#/components/parameters/per-page"
|
|
39740
|
+
}
|
|
39741
|
+
],
|
|
39742
|
+
"responses": {
|
|
39743
|
+
"200": {
|
|
39744
|
+
"description": "A list of custom deployment rule integrations available for this environment.",
|
|
39745
|
+
"content": {
|
|
39746
|
+
"application/json": {
|
|
39747
|
+
"schema": {
|
|
39748
|
+
"type": "object",
|
|
39749
|
+
"properties": {
|
|
39750
|
+
"total_count": {
|
|
39751
|
+
"description": "The total number of custom deployment protection rule integrations available for this environment.",
|
|
39752
|
+
"type": "integer",
|
|
39753
|
+
"example": 35
|
|
39754
|
+
},
|
|
39755
|
+
"available_custom_deployment_protection_rule_integrations": {
|
|
39756
|
+
"type": "array",
|
|
39757
|
+
"items": {
|
|
39758
|
+
"$ref": "#/components/schemas/custom-deployment-rule-app"
|
|
39759
|
+
}
|
|
39760
|
+
}
|
|
39761
|
+
}
|
|
39762
|
+
},
|
|
39763
|
+
"examples": {
|
|
39764
|
+
"default": {
|
|
39765
|
+
"$ref": "#/components/examples/custom-deployment-protection-rule-apps"
|
|
39766
|
+
}
|
|
39767
|
+
}
|
|
39768
|
+
}
|
|
39769
|
+
}
|
|
39770
|
+
}
|
|
39771
|
+
},
|
|
39772
|
+
"x-github": {
|
|
39773
|
+
"githubCloudOnly": false,
|
|
39774
|
+
"enabledForGitHubApps": true,
|
|
39775
|
+
"category": "deployments",
|
|
39776
|
+
"subcategory": "protection-rules"
|
|
39777
|
+
},
|
|
39778
|
+
"x-octokit": {}
|
|
39779
|
+
}
|
|
39780
|
+
},
|
|
39781
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": {
|
|
39782
|
+
"get": {
|
|
39783
|
+
"summary": "Get a custom deployment protection rule",
|
|
39784
|
+
"description": "Gets an enabled custom deployment protection rule for an environment. Anyone with read access to the repository can use this endpoint. If the repository is private and you want to use a personal access token (classic), you must use an access token with the `repo` scope. GitHub Apps and fine-grained personal access tokens must have the `actions:read` permission to use this endpoint. For more information about environments, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//en/actions/deployment/targeting-different-environments/using-environments-for-deployment).\"\n\nFor more information about the app that is providing this custom deployment rule, see [`GET /apps/{app_slug}`](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app).",
|
|
39785
|
+
"tags": [
|
|
39786
|
+
"repos"
|
|
39787
|
+
],
|
|
39788
|
+
"operationId": "repos/get-custom-deployment-protection-rule",
|
|
39789
|
+
"externalDocs": {
|
|
39790
|
+
"description": "API method documentation",
|
|
39791
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-deployment-protection-rule"
|
|
39792
|
+
},
|
|
39793
|
+
"parameters": [
|
|
39794
|
+
{
|
|
39795
|
+
"$ref": "#/components/parameters/owner"
|
|
39796
|
+
},
|
|
39797
|
+
{
|
|
39798
|
+
"$ref": "#/components/parameters/repo"
|
|
39799
|
+
},
|
|
39800
|
+
{
|
|
39801
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39802
|
+
},
|
|
39803
|
+
{
|
|
39804
|
+
"$ref": "#/components/parameters/protection-rule-id"
|
|
39805
|
+
}
|
|
39806
|
+
],
|
|
39807
|
+
"responses": {
|
|
39808
|
+
"200": {
|
|
39809
|
+
"description": "Response",
|
|
39810
|
+
"content": {
|
|
39811
|
+
"application/json": {
|
|
39812
|
+
"schema": {
|
|
39813
|
+
"$ref": "#/components/schemas/deployment-protection-rule"
|
|
39814
|
+
},
|
|
39815
|
+
"examples": {
|
|
39816
|
+
"default": {
|
|
39817
|
+
"$ref": "#/components/examples/deployment-protection-rule"
|
|
39818
|
+
}
|
|
39819
|
+
}
|
|
39820
|
+
}
|
|
39821
|
+
}
|
|
39822
|
+
}
|
|
39823
|
+
},
|
|
39824
|
+
"x-github": {
|
|
39825
|
+
"githubCloudOnly": false,
|
|
39826
|
+
"enabledForGitHubApps": true,
|
|
39827
|
+
"category": "deployments",
|
|
39828
|
+
"subcategory": "protection-rules"
|
|
39829
|
+
},
|
|
39830
|
+
"x-octokit": {}
|
|
39831
|
+
},
|
|
39832
|
+
"delete": {
|
|
39833
|
+
"summary": "Disable a custom protection rule for an environment",
|
|
39834
|
+
"description": "Disables a custom deployment protection rule for an environment.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. Removing a custom protection rule requires admin or owner permissions to the repository. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Get an app](https://docs.github.com/enterprise-cloud@latest//rest/apps/apps#get-an-app)\".",
|
|
39835
|
+
"tags": [
|
|
39836
|
+
"repos"
|
|
39837
|
+
],
|
|
39838
|
+
"operationId": "repos/disable-deployment-protection-rule",
|
|
39839
|
+
"externalDocs": {
|
|
39840
|
+
"description": "API method documentation",
|
|
39841
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-deployment-protection-rule"
|
|
39842
|
+
},
|
|
39843
|
+
"parameters": [
|
|
39844
|
+
{
|
|
39845
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39846
|
+
},
|
|
39847
|
+
{
|
|
39848
|
+
"$ref": "#/components/parameters/repo"
|
|
39849
|
+
},
|
|
39850
|
+
{
|
|
39851
|
+
"$ref": "#/components/parameters/owner"
|
|
39852
|
+
},
|
|
39853
|
+
{
|
|
39854
|
+
"$ref": "#/components/parameters/protection-rule-id"
|
|
39855
|
+
}
|
|
39856
|
+
],
|
|
39857
|
+
"responses": {
|
|
39858
|
+
"204": {
|
|
39859
|
+
"description": "Response"
|
|
39860
|
+
}
|
|
39861
|
+
},
|
|
39862
|
+
"x-github": {
|
|
39863
|
+
"githubCloudOnly": false,
|
|
39864
|
+
"enabledForGitHubApps": true,
|
|
39865
|
+
"category": "deployments",
|
|
39866
|
+
"subcategory": "protection-rules"
|
|
39867
|
+
},
|
|
39868
|
+
"x-octokit": {}
|
|
39869
|
+
}
|
|
39870
|
+
},
|
|
39544
39871
|
"/repos/{owner}/{repo}/events": {
|
|
39545
39872
|
"get": {
|
|
39546
39873
|
"summary": "List repository events",
|
|
39547
|
-
"description": "",
|
|
39874
|
+
"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",
|
|
39548
39875
|
"tags": [
|
|
39549
39876
|
"activity"
|
|
39550
39877
|
],
|
|
@@ -41700,7 +42027,7 @@
|
|
|
41700
42027
|
"/repos/{owner}/{repo}/import": {
|
|
41701
42028
|
"get": {
|
|
41702
42029
|
"summary": "Get an import status",
|
|
41703
|
-
"description": "View the progress of an import.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub Enterprise Cloud.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.",
|
|
42030
|
+
"description": "View the progress of an import.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub Enterprise Cloud. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub Enterprise Cloud.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Enterprise Cloud Support](https://support.github.com/contact?tags=dotcom-rest-api) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import) and [retry](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update an import](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.",
|
|
41704
42031
|
"tags": [
|
|
41705
42032
|
"migrations"
|
|
41706
42033
|
],
|
|
@@ -41750,7 +42077,7 @@
|
|
|
41750
42077
|
},
|
|
41751
42078
|
"put": {
|
|
41752
42079
|
"summary": "Start an import",
|
|
41753
|
-
"description": "Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response.",
|
|
42080
|
+
"description": "Start a source import to a GitHub Enterprise Cloud repository using GitHub Enterprise Cloud Importer. Importing into a GitHub Enterprise Cloud repository with GitHub Actions enabled is not supported and will return a status `422 Unprocessable Entity` response.\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end on October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update these docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.",
|
|
41754
42081
|
"tags": [
|
|
41755
42082
|
"migrations"
|
|
41756
42083
|
],
|
|
@@ -41862,7 +42189,7 @@
|
|
|
41862
42189
|
},
|
|
41863
42190
|
"patch": {
|
|
41864
42191
|
"summary": "Update an import",
|
|
41865
|
-
"description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.",
|
|
42192
|
+
"description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API\nrequest. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will\nhave the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array.\nYou can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.",
|
|
41866
42193
|
"tags": [
|
|
41867
42194
|
"migrations"
|
|
41868
42195
|
],
|
|
@@ -41972,7 +42299,7 @@
|
|
|
41972
42299
|
},
|
|
41973
42300
|
"delete": {
|
|
41974
42301
|
"summary": "Cancel an import",
|
|
41975
|
-
"description": "Stop an import for a repository.",
|
|
42302
|
+
"description": "Stop an import for a repository.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n",
|
|
41976
42303
|
"tags": [
|
|
41977
42304
|
"migrations"
|
|
41978
42305
|
],
|
|
@@ -42009,7 +42336,7 @@
|
|
|
42009
42336
|
"/repos/{owner}/{repo}/import/authors": {
|
|
42010
42337
|
"get": {
|
|
42011
42338
|
"summary": "Get commit authors",
|
|
42012
|
-
"description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot <hubot@12341234-abab-fefe-8787-fedcba987654>`.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.",
|
|
42339
|
+
"description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Enterprise Cloud Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot <hubot@12341234-abab-fefe-8787-fedcba987654>`.\n\nThis endpoint and the [Map a commit author](https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author) endpoint allow you to provide correct Git author information.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.",
|
|
42013
42340
|
"tags": [
|
|
42014
42341
|
"migrations"
|
|
42015
42342
|
],
|
|
@@ -42067,7 +42394,7 @@
|
|
|
42067
42394
|
"/repos/{owner}/{repo}/import/authors/{author_id}": {
|
|
42068
42395
|
"patch": {
|
|
42069
42396
|
"summary": "Map a commit author",
|
|
42070
|
-
"description": "Update an author's identity for the import. Your application can continue updating authors any time before you push
|
|
42397
|
+
"description": "Update an author's identity for the import. Your application can continue updating authors any time before you push\nnew commits to the repository.\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n",
|
|
42071
42398
|
"tags": [
|
|
42072
42399
|
"migrations"
|
|
42073
42400
|
],
|
|
@@ -42159,7 +42486,7 @@
|
|
|
42159
42486
|
"/repos/{owner}/{repo}/import/large_files": {
|
|
42160
42487
|
"get": {
|
|
42161
42488
|
"summary": "Get large files",
|
|
42162
|
-
"description": "List files larger than 100MB found during the import",
|
|
42489
|
+
"description": "List files larger than 100MB found during the import\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n",
|
|
42163
42490
|
"tags": [
|
|
42164
42491
|
"migrations"
|
|
42165
42492
|
],
|
|
@@ -42211,7 +42538,7 @@
|
|
|
42211
42538
|
"/repos/{owner}/{repo}/import/lfs": {
|
|
42212
42539
|
"patch": {
|
|
42213
42540
|
"summary": "Update Git LFS preference",
|
|
42214
|
-
"description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability
|
|
42541
|
+
"description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability\nis powered by [Git LFS](https://git-lfs.com).\n\nYou can learn more about our LFS feature and working with large files [on our help\nsite](https://docs.github.com/enterprise-cloud@latest//repositories/working-with-files/managing-large-files).\n\n**Warning:** Support for importing Mercurial, Subversion and Team Foundation Version Control repositories will end\non October 17, 2023. For more details, see [changelog](https://gh.io/github-importer-non-git-eol). In the coming weeks, we will update\nthese docs to reflect relevant changes to the API and will contact all integrators using the \"Source imports\" API.\n",
|
|
42215
42542
|
"tags": [
|
|
42216
42543
|
"migrations"
|
|
42217
42544
|
],
|
|
@@ -48448,7 +48775,7 @@
|
|
|
48448
48775
|
"nullable": true,
|
|
48449
48776
|
"properties": {
|
|
48450
48777
|
"location": {
|
|
48451
|
-
"description": "
|
|
48778
|
+
"description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
|
|
48452
48779
|
"type": "string"
|
|
48453
48780
|
},
|
|
48454
48781
|
"client_ip": {
|
|
@@ -49252,14 +49579,14 @@
|
|
|
49252
49579
|
},
|
|
49253
49580
|
"post": {
|
|
49254
49581
|
"summary": "Request reviewers for a pull request",
|
|
49255
|
-
"description": "This endpoint triggers [notifications](https://docs.github.com/
|
|
49582
|
+
"description": "This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. See \"[Secondary rate limits](https://docs.github.com/rest/overview/resources-in-the-rest-api#secondary-rate-limits)\" and \"[Dealing with secondary rate limits](https://docs.github.com/rest/guides/best-practices-for-integrators#dealing-with-secondary-rate-limits)\" for details.",
|
|
49256
49583
|
"tags": [
|
|
49257
49584
|
"pulls"
|
|
49258
49585
|
],
|
|
49259
49586
|
"operationId": "pulls/request-reviewers",
|
|
49260
49587
|
"externalDocs": {
|
|
49261
49588
|
"description": "API method documentation",
|
|
49262
|
-
"url": "https://docs.github.com/
|
|
49589
|
+
"url": "https://docs.github.com/rest/reference/pulls#request-reviewers-for-a-pull-request"
|
|
49263
49590
|
},
|
|
49264
49591
|
"parameters": [
|
|
49265
49592
|
{
|
|
@@ -49293,19 +49620,7 @@
|
|
|
49293
49620
|
"type": "string"
|
|
49294
49621
|
}
|
|
49295
49622
|
}
|
|
49296
|
-
}
|
|
49297
|
-
"anyOf": [
|
|
49298
|
-
{
|
|
49299
|
-
"required": [
|
|
49300
|
-
"reviewers"
|
|
49301
|
-
]
|
|
49302
|
-
},
|
|
49303
|
-
{
|
|
49304
|
-
"required": [
|
|
49305
|
-
"team_reviewers"
|
|
49306
|
-
]
|
|
49307
|
-
}
|
|
49308
|
-
]
|
|
49623
|
+
}
|
|
49309
49624
|
},
|
|
49310
49625
|
"examples": {
|
|
49311
49626
|
"default": {
|
|
@@ -51666,10 +51981,9 @@
|
|
|
51666
51981
|
"examples": {
|
|
51667
51982
|
"default": {
|
|
51668
51983
|
"value": {
|
|
51669
|
-
"id": 42,
|
|
51670
51984
|
"name": "super cool ruleset",
|
|
51671
51985
|
"target": "branch",
|
|
51672
|
-
"enforcement": "
|
|
51986
|
+
"enforcement": "active",
|
|
51673
51987
|
"bypass_mode": "repository",
|
|
51674
51988
|
"bypass_actors": [
|
|
51675
51989
|
{
|
|
@@ -51886,10 +52200,9 @@
|
|
|
51886
52200
|
"examples": {
|
|
51887
52201
|
"default": {
|
|
51888
52202
|
"value": {
|
|
51889
|
-
"id": 42,
|
|
51890
52203
|
"name": "super cool ruleset",
|
|
51891
52204
|
"target": "branch",
|
|
51892
|
-
"enforcement": "
|
|
52205
|
+
"enforcement": "active",
|
|
51893
52206
|
"bypass_mode": "repository",
|
|
51894
52207
|
"bypass_actors": [
|
|
51895
52208
|
{
|
|
@@ -52550,6 +52863,96 @@
|
|
|
52550
52863
|
"x-octokit": {}
|
|
52551
52864
|
}
|
|
52552
52865
|
},
|
|
52866
|
+
"/repos/{owner}/{repo}/security-advisories/reports": {
|
|
52867
|
+
"post": {
|
|
52868
|
+
"summary": "Privately report a security vulnerability",
|
|
52869
|
+
"description": "Report a security vulnerability to the maintainers of the repository.\nSee \"[Privately reporting a security vulnerability](https://docs.github.com/enterprise-cloud@latest//code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability)\" for more information about private vulnerability reporting.",
|
|
52870
|
+
"tags": [
|
|
52871
|
+
"security-advisories"
|
|
52872
|
+
],
|
|
52873
|
+
"operationId": "security-advisories/create-private-vulnerability-report",
|
|
52874
|
+
"externalDocs": {
|
|
52875
|
+
"description": "API method documentation",
|
|
52876
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability"
|
|
52877
|
+
},
|
|
52878
|
+
"parameters": [
|
|
52879
|
+
{
|
|
52880
|
+
"$ref": "#/components/parameters/owner"
|
|
52881
|
+
},
|
|
52882
|
+
{
|
|
52883
|
+
"$ref": "#/components/parameters/repo"
|
|
52884
|
+
}
|
|
52885
|
+
],
|
|
52886
|
+
"requestBody": {
|
|
52887
|
+
"required": true,
|
|
52888
|
+
"content": {
|
|
52889
|
+
"application/json": {
|
|
52890
|
+
"schema": {
|
|
52891
|
+
"$ref": "#/components/schemas/private-vulnerability-report-create"
|
|
52892
|
+
},
|
|
52893
|
+
"examples": {
|
|
52894
|
+
"default": {
|
|
52895
|
+
"value": {
|
|
52896
|
+
"summary": "A newly discovered vulnerability",
|
|
52897
|
+
"description": "A more in-depth description of what the problem is.",
|
|
52898
|
+
"severity": "high",
|
|
52899
|
+
"vulnerabilities": [
|
|
52900
|
+
{
|
|
52901
|
+
"package": {
|
|
52902
|
+
"name": "a-package",
|
|
52903
|
+
"ecosystem": "npm"
|
|
52904
|
+
},
|
|
52905
|
+
"vulnerable_version_range": "< 1.0.0",
|
|
52906
|
+
"patched_versions": "1.0.0",
|
|
52907
|
+
"vulnerable_functions": [
|
|
52908
|
+
"important_function"
|
|
52909
|
+
]
|
|
52910
|
+
}
|
|
52911
|
+
],
|
|
52912
|
+
"cwe_ids": [
|
|
52913
|
+
"CWE-123"
|
|
52914
|
+
]
|
|
52915
|
+
}
|
|
52916
|
+
}
|
|
52917
|
+
}
|
|
52918
|
+
}
|
|
52919
|
+
}
|
|
52920
|
+
},
|
|
52921
|
+
"responses": {
|
|
52922
|
+
"201": {
|
|
52923
|
+
"description": "Response",
|
|
52924
|
+
"content": {
|
|
52925
|
+
"application/json": {
|
|
52926
|
+
"schema": {
|
|
52927
|
+
"$ref": "#/components/schemas/repository-advisory"
|
|
52928
|
+
},
|
|
52929
|
+
"examples": {
|
|
52930
|
+
"default": {
|
|
52931
|
+
"$ref": "#/components/examples/repository-advisory-pvr"
|
|
52932
|
+
}
|
|
52933
|
+
}
|
|
52934
|
+
}
|
|
52935
|
+
}
|
|
52936
|
+
},
|
|
52937
|
+
"403": {
|
|
52938
|
+
"$ref": "#/components/responses/forbidden"
|
|
52939
|
+
},
|
|
52940
|
+
"404": {
|
|
52941
|
+
"$ref": "#/components/responses/not_found"
|
|
52942
|
+
},
|
|
52943
|
+
"422": {
|
|
52944
|
+
"$ref": "#/components/responses/validation_failed"
|
|
52945
|
+
}
|
|
52946
|
+
},
|
|
52947
|
+
"x-github": {
|
|
52948
|
+
"githubCloudOnly": false,
|
|
52949
|
+
"enabledForGitHubApps": true,
|
|
52950
|
+
"category": "security-advisories",
|
|
52951
|
+
"subcategory": "repository-advisories"
|
|
52952
|
+
},
|
|
52953
|
+
"x-octokit": {}
|
|
52954
|
+
}
|
|
52955
|
+
},
|
|
52553
52956
|
"/repos/{owner}/{repo}/security-advisories/{ghsa_id}": {
|
|
52554
52957
|
"get": {
|
|
52555
52958
|
"summary": "Get a repository security advisory",
|
|
@@ -55867,7 +56270,7 @@
|
|
|
55867
56270
|
"/search/code": {
|
|
55868
56271
|
"get": {
|
|
55869
56272
|
"summary": "Search code",
|
|
55870
|
-
"description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\n#### Considerations for code search\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\
|
|
56273
|
+
"description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest//rest/overview/resources-in-the-rest-api#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest//rest/reference/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\n#### Considerations for code search\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.",
|
|
55871
56274
|
"tags": [
|
|
55872
56275
|
"search"
|
|
55873
56276
|
],
|
|
@@ -55889,7 +56292,7 @@
|
|
|
55889
56292
|
{
|
|
55890
56293
|
"name": "sort",
|
|
55891
56294
|
"deprecated": true,
|
|
55892
|
-
"description": "**
|
|
56295
|
+
"description": "**This field is deprecated.** Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Cloud search infrastructure. Default: [best match](https://docs.github.com/enterprise-cloud@latest//rest/reference/search#ranking-search-results)",
|
|
55893
56296
|
"in": "query",
|
|
55894
56297
|
"required": false,
|
|
55895
56298
|
"schema": {
|
|
@@ -55901,7 +56304,7 @@
|
|
|
55901
56304
|
},
|
|
55902
56305
|
{
|
|
55903
56306
|
"name": "order",
|
|
55904
|
-
"description": "**
|
|
56307
|
+
"description": "**This field is deprecated.** Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. ",
|
|
55905
56308
|
"in": "query",
|
|
55906
56309
|
"deprecated": true,
|
|
55907
56310
|
"required": false,
|
|
@@ -59394,7 +59797,7 @@
|
|
|
59394
59797
|
"type": "string"
|
|
59395
59798
|
},
|
|
59396
59799
|
"location": {
|
|
59397
|
-
"description": "
|
|
59800
|
+
"description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
|
|
59398
59801
|
"type": "string"
|
|
59399
59802
|
},
|
|
59400
59803
|
"client_ip": {
|
|
@@ -59456,7 +59859,7 @@
|
|
|
59456
59859
|
}
|
|
59457
59860
|
},
|
|
59458
59861
|
"location": {
|
|
59459
|
-
"description": "
|
|
59862
|
+
"description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
|
|
59460
59863
|
"type": "string"
|
|
59461
59864
|
},
|
|
59462
59865
|
"machine": {
|
|
@@ -69452,7 +69855,100 @@
|
|
|
69452
69855
|
"content": {
|
|
69453
69856
|
"application/json": {
|
|
69454
69857
|
"schema": {
|
|
69455
|
-
"$ref": "#/components/schemas/webhook-dependabot-alert-created"
|
|
69858
|
+
"$ref": "#/components/schemas/webhook-dependabot-alert-created"
|
|
69859
|
+
}
|
|
69860
|
+
}
|
|
69861
|
+
}
|
|
69862
|
+
},
|
|
69863
|
+
"responses": {
|
|
69864
|
+
"200": {
|
|
69865
|
+
"description": "Return a 200 status to indicate that the data was received successfully"
|
|
69866
|
+
}
|
|
69867
|
+
},
|
|
69868
|
+
"x-github": {
|
|
69869
|
+
"githubCloudOnly": false,
|
|
69870
|
+
"category": "webhooks",
|
|
69871
|
+
"subcategory": "dependabot-alert",
|
|
69872
|
+
"supported-webhook-types": [
|
|
69873
|
+
"repository",
|
|
69874
|
+
"organization",
|
|
69875
|
+
"app"
|
|
69876
|
+
]
|
|
69877
|
+
}
|
|
69878
|
+
}
|
|
69879
|
+
},
|
|
69880
|
+
"dependabot-alert-dismissed": {
|
|
69881
|
+
"post": {
|
|
69882
|
+
"summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
|
|
69883
|
+
"description": "A Dependabot alert was manually closed.",
|
|
69884
|
+
"operationId": "dependabot-alert/dismissed",
|
|
69885
|
+
"externalDocs": {
|
|
69886
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
|
|
69887
|
+
},
|
|
69888
|
+
"parameters": [
|
|
69889
|
+
{
|
|
69890
|
+
"name": "User-Agent",
|
|
69891
|
+
"in": "header",
|
|
69892
|
+
"example": "GitHub-Hookshot/123abc",
|
|
69893
|
+
"schema": {
|
|
69894
|
+
"type": "string"
|
|
69895
|
+
}
|
|
69896
|
+
},
|
|
69897
|
+
{
|
|
69898
|
+
"name": "X-Github-Hook-Id",
|
|
69899
|
+
"in": "header",
|
|
69900
|
+
"example": 12312312,
|
|
69901
|
+
"schema": {
|
|
69902
|
+
"type": "string"
|
|
69903
|
+
}
|
|
69904
|
+
},
|
|
69905
|
+
{
|
|
69906
|
+
"name": "X-Github-Event",
|
|
69907
|
+
"in": "header",
|
|
69908
|
+
"example": "issues",
|
|
69909
|
+
"schema": {
|
|
69910
|
+
"type": "string"
|
|
69911
|
+
}
|
|
69912
|
+
},
|
|
69913
|
+
{
|
|
69914
|
+
"name": "X-Github-Hook-Installation-Target-Id",
|
|
69915
|
+
"in": "header",
|
|
69916
|
+
"example": 123123,
|
|
69917
|
+
"schema": {
|
|
69918
|
+
"type": "string"
|
|
69919
|
+
}
|
|
69920
|
+
},
|
|
69921
|
+
{
|
|
69922
|
+
"name": "X-Github-Hook-Installation-Target-Type",
|
|
69923
|
+
"in": "header",
|
|
69924
|
+
"example": "repository",
|
|
69925
|
+
"schema": {
|
|
69926
|
+
"type": "string"
|
|
69927
|
+
}
|
|
69928
|
+
},
|
|
69929
|
+
{
|
|
69930
|
+
"name": "X-GitHub-Delivery",
|
|
69931
|
+
"in": "header",
|
|
69932
|
+
"example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
|
|
69933
|
+
"schema": {
|
|
69934
|
+
"type": "string"
|
|
69935
|
+
}
|
|
69936
|
+
},
|
|
69937
|
+
{
|
|
69938
|
+
"name": "X-Hub-Signature-256",
|
|
69939
|
+
"in": "header",
|
|
69940
|
+
"example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
|
|
69941
|
+
"schema": {
|
|
69942
|
+
"type": "string"
|
|
69943
|
+
}
|
|
69944
|
+
}
|
|
69945
|
+
],
|
|
69946
|
+
"requestBody": {
|
|
69947
|
+
"required": true,
|
|
69948
|
+
"content": {
|
|
69949
|
+
"application/json": {
|
|
69950
|
+
"schema": {
|
|
69951
|
+
"$ref": "#/components/schemas/webhook-dependabot-alert-dismissed"
|
|
69456
69952
|
}
|
|
69457
69953
|
}
|
|
69458
69954
|
}
|
|
@@ -69474,11 +69970,11 @@
|
|
|
69474
69970
|
}
|
|
69475
69971
|
}
|
|
69476
69972
|
},
|
|
69477
|
-
"dependabot-alert-
|
|
69973
|
+
"dependabot-alert-fixed": {
|
|
69478
69974
|
"post": {
|
|
69479
69975
|
"summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
|
|
69480
|
-
"description": "A
|
|
69481
|
-
"operationId": "dependabot-alert/
|
|
69976
|
+
"description": "A manifest file change removed a vulnerability.",
|
|
69977
|
+
"operationId": "dependabot-alert/fixed",
|
|
69482
69978
|
"externalDocs": {
|
|
69483
69979
|
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
|
|
69484
69980
|
},
|
|
@@ -69545,7 +70041,7 @@
|
|
|
69545
70041
|
"content": {
|
|
69546
70042
|
"application/json": {
|
|
69547
70043
|
"schema": {
|
|
69548
|
-
"$ref": "#/components/schemas/webhook-dependabot-alert-
|
|
70044
|
+
"$ref": "#/components/schemas/webhook-dependabot-alert-fixed"
|
|
69549
70045
|
}
|
|
69550
70046
|
}
|
|
69551
70047
|
}
|
|
@@ -69567,11 +70063,11 @@
|
|
|
69567
70063
|
}
|
|
69568
70064
|
}
|
|
69569
70065
|
},
|
|
69570
|
-
"dependabot-alert-
|
|
70066
|
+
"dependabot-alert-reintroduced": {
|
|
69571
70067
|
"post": {
|
|
69572
70068
|
"summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
|
|
69573
|
-
"description": "A manifest file change
|
|
69574
|
-
"operationId": "dependabot-alert/
|
|
70069
|
+
"description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.",
|
|
70070
|
+
"operationId": "dependabot-alert/reintroduced",
|
|
69575
70071
|
"externalDocs": {
|
|
69576
70072
|
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
|
|
69577
70073
|
},
|
|
@@ -69638,7 +70134,7 @@
|
|
|
69638
70134
|
"content": {
|
|
69639
70135
|
"application/json": {
|
|
69640
70136
|
"schema": {
|
|
69641
|
-
"$ref": "#/components/schemas/webhook-dependabot-alert-
|
|
70137
|
+
"$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced"
|
|
69642
70138
|
}
|
|
69643
70139
|
}
|
|
69644
70140
|
}
|
|
@@ -69660,11 +70156,11 @@
|
|
|
69660
70156
|
}
|
|
69661
70157
|
}
|
|
69662
70158
|
},
|
|
69663
|
-
"dependabot-alert-
|
|
70159
|
+
"dependabot-alert-reopened": {
|
|
69664
70160
|
"post": {
|
|
69665
70161
|
"summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//code-security/dependabot/dependabot-alerts/about-dependabot-alerts).\" For information about the API to manage Dependabot alerts, see \"[Dependabot alerts](https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.\n\n**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.",
|
|
69666
|
-
"description": "A
|
|
69667
|
-
"operationId": "dependabot-alert/
|
|
70162
|
+
"description": "A Dependabot alert was manually reopened.",
|
|
70163
|
+
"operationId": "dependabot-alert/reopened",
|
|
69668
70164
|
"externalDocs": {
|
|
69669
70165
|
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
|
|
69670
70166
|
},
|
|
@@ -69731,7 +70227,7 @@
|
|
|
69731
70227
|
"content": {
|
|
69732
70228
|
"application/json": {
|
|
69733
70229
|
"schema": {
|
|
69734
|
-
"$ref": "#/components/schemas/webhook-dependabot-alert-
|
|
70230
|
+
"$ref": "#/components/schemas/webhook-dependabot-alert-reopened"
|
|
69735
70231
|
}
|
|
69736
70232
|
}
|
|
69737
70233
|
}
|
|
@@ -69753,13 +70249,13 @@
|
|
|
69753
70249
|
}
|
|
69754
70250
|
}
|
|
69755
70251
|
},
|
|
69756
|
-
"
|
|
70252
|
+
"deploy-key-created": {
|
|
69757
70253
|
"post": {
|
|
69758
|
-
"summary": "This event occurs when there is activity relating to
|
|
69759
|
-
"description": "A
|
|
69760
|
-
"operationId": "
|
|
70254
|
+
"summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
|
|
70255
|
+
"description": "A deploy key was created.",
|
|
70256
|
+
"operationId": "deploy-key/created",
|
|
69761
70257
|
"externalDocs": {
|
|
69762
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#
|
|
70258
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key"
|
|
69763
70259
|
},
|
|
69764
70260
|
"parameters": [
|
|
69765
70261
|
{
|
|
@@ -69824,7 +70320,7 @@
|
|
|
69824
70320
|
"content": {
|
|
69825
70321
|
"application/json": {
|
|
69826
70322
|
"schema": {
|
|
69827
|
-
"$ref": "#/components/schemas/webhook-
|
|
70323
|
+
"$ref": "#/components/schemas/webhook-deploy-key-created"
|
|
69828
70324
|
}
|
|
69829
70325
|
}
|
|
69830
70326
|
}
|
|
@@ -69837,7 +70333,7 @@
|
|
|
69837
70333
|
"x-github": {
|
|
69838
70334
|
"githubCloudOnly": false,
|
|
69839
70335
|
"category": "webhooks",
|
|
69840
|
-
"subcategory": "
|
|
70336
|
+
"subcategory": "deploy-key",
|
|
69841
70337
|
"supported-webhook-types": [
|
|
69842
70338
|
"repository",
|
|
69843
70339
|
"organization",
|
|
@@ -69846,11 +70342,11 @@
|
|
|
69846
70342
|
}
|
|
69847
70343
|
}
|
|
69848
70344
|
},
|
|
69849
|
-
"deploy-key-
|
|
70345
|
+
"deploy-key-deleted": {
|
|
69850
70346
|
"post": {
|
|
69851
|
-
"summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL
|
|
69852
|
-
"description": "A deploy key was
|
|
69853
|
-
"operationId": "deploy-key/
|
|
70347
|
+
"summary": "This event occurs when there is activity relating to deploy keys. For more information, see \"[Managing deploy keys](https://docs.github.com/enterprise-cloud@latest//developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
|
|
70348
|
+
"description": "A deploy key was deleted.",
|
|
70349
|
+
"operationId": "deploy-key/deleted",
|
|
69854
70350
|
"externalDocs": {
|
|
69855
70351
|
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key"
|
|
69856
70352
|
},
|
|
@@ -69917,7 +70413,7 @@
|
|
|
69917
70413
|
"content": {
|
|
69918
70414
|
"application/json": {
|
|
69919
70415
|
"schema": {
|
|
69920
|
-
"$ref": "#/components/schemas/webhook-deploy-key-
|
|
70416
|
+
"$ref": "#/components/schemas/webhook-deploy-key-deleted"
|
|
69921
70417
|
}
|
|
69922
70418
|
}
|
|
69923
70419
|
}
|
|
@@ -69939,13 +70435,13 @@
|
|
|
69939
70435
|
}
|
|
69940
70436
|
}
|
|
69941
70437
|
},
|
|
69942
|
-
"
|
|
70438
|
+
"deployment-created": {
|
|
69943
70439
|
"post": {
|
|
69944
|
-
"summary": "This event occurs when there is activity relating to
|
|
69945
|
-
"description": "A
|
|
69946
|
-
"operationId": "
|
|
70440
|
+
"summary": "This event occurs when there is activity relating to deployments. For more information, see \"[About deployments](https://docs.github.com/enterprise-cloud@latest//actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest//graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
|
|
70441
|
+
"description": "A deployment was created.",
|
|
70442
|
+
"operationId": "deployment/created",
|
|
69947
70443
|
"externalDocs": {
|
|
69948
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#
|
|
70444
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment"
|
|
69949
70445
|
},
|
|
69950
70446
|
"parameters": [
|
|
69951
70447
|
{
|
|
@@ -70010,7 +70506,7 @@
|
|
|
70010
70506
|
"content": {
|
|
70011
70507
|
"application/json": {
|
|
70012
70508
|
"schema": {
|
|
70013
|
-
"$ref": "#/components/schemas/webhook-
|
|
70509
|
+
"$ref": "#/components/schemas/webhook-deployment-created"
|
|
70014
70510
|
}
|
|
70015
70511
|
}
|
|
70016
70512
|
}
|
|
@@ -70023,7 +70519,7 @@
|
|
|
70023
70519
|
"x-github": {
|
|
70024
70520
|
"githubCloudOnly": false,
|
|
70025
70521
|
"category": "webhooks",
|
|
70026
|
-
"subcategory": "
|
|
70522
|
+
"subcategory": "deployment",
|
|
70027
70523
|
"supported-webhook-types": [
|
|
70028
70524
|
"repository",
|
|
70029
70525
|
"organization",
|
|
@@ -70032,13 +70528,13 @@
|
|
|
70032
70528
|
}
|
|
70033
70529
|
}
|
|
70034
70530
|
},
|
|
70035
|
-
"deployment-
|
|
70531
|
+
"deployment-protection-rule-requested": {
|
|
70036
70532
|
"post": {
|
|
70037
|
-
"summary": "This event occurs when there is activity relating to
|
|
70038
|
-
"description": "A deployment was
|
|
70039
|
-
"operationId": "deployment/
|
|
70533
|
+
"summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest//actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.",
|
|
70534
|
+
"description": "A deployment protection rule was requested for an environment.",
|
|
70535
|
+
"operationId": "deployment-protection-rule/requested",
|
|
70040
70536
|
"externalDocs": {
|
|
70041
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#
|
|
70537
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment_protection_rule"
|
|
70042
70538
|
},
|
|
70043
70539
|
"parameters": [
|
|
70044
70540
|
{
|
|
@@ -70103,7 +70599,7 @@
|
|
|
70103
70599
|
"content": {
|
|
70104
70600
|
"application/json": {
|
|
70105
70601
|
"schema": {
|
|
70106
|
-
"$ref": "#/components/schemas/webhook-deployment-
|
|
70602
|
+
"$ref": "#/components/schemas/webhook-deployment-protection-rule-requested"
|
|
70107
70603
|
}
|
|
70108
70604
|
}
|
|
70109
70605
|
}
|
|
@@ -70116,10 +70612,8 @@
|
|
|
70116
70612
|
"x-github": {
|
|
70117
70613
|
"githubCloudOnly": false,
|
|
70118
70614
|
"category": "webhooks",
|
|
70119
|
-
"subcategory": "deployment",
|
|
70615
|
+
"subcategory": "deployment-protection-rule",
|
|
70120
70616
|
"supported-webhook-types": [
|
|
70121
|
-
"repository",
|
|
70122
|
-
"organization",
|
|
70123
70617
|
"app"
|
|
70124
70618
|
]
|
|
70125
70619
|
}
|
|
@@ -97324,7 +97818,7 @@
|
|
|
97324
97818
|
}
|
|
97325
97819
|
},
|
|
97326
97820
|
"location": {
|
|
97327
|
-
"description": "The
|
|
97821
|
+
"description": "The initally assigned location of a new codespace.",
|
|
97328
97822
|
"enum": [
|
|
97329
97823
|
"EastUs",
|
|
97330
97824
|
"SouthEastAsia",
|
|
@@ -104076,6 +104570,48 @@
|
|
|
104076
104570
|
"comment"
|
|
104077
104571
|
]
|
|
104078
104572
|
},
|
|
104573
|
+
"review-custom-gates-comment-required": {
|
|
104574
|
+
"type": "object",
|
|
104575
|
+
"properties": {
|
|
104576
|
+
"environment_name": {
|
|
104577
|
+
"type": "string",
|
|
104578
|
+
"description": "The name of the environment to approve or reject."
|
|
104579
|
+
},
|
|
104580
|
+
"comment": {
|
|
104581
|
+
"type": "string",
|
|
104582
|
+
"description": "Comment associated with the pending deployment protection rule. **Required when state is not provided.**"
|
|
104583
|
+
}
|
|
104584
|
+
},
|
|
104585
|
+
"required": [
|
|
104586
|
+
"environment_name",
|
|
104587
|
+
"comment"
|
|
104588
|
+
]
|
|
104589
|
+
},
|
|
104590
|
+
"review-custom-gates-state-required": {
|
|
104591
|
+
"type": "object",
|
|
104592
|
+
"properties": {
|
|
104593
|
+
"environment_name": {
|
|
104594
|
+
"type": "string",
|
|
104595
|
+
"description": "The name of the environment to approve or reject."
|
|
104596
|
+
},
|
|
104597
|
+
"state": {
|
|
104598
|
+
"type": "string",
|
|
104599
|
+
"description": "Whether to approve or reject deployment to the specified environments.",
|
|
104600
|
+
"enum": [
|
|
104601
|
+
"approved",
|
|
104602
|
+
"rejected"
|
|
104603
|
+
]
|
|
104604
|
+
},
|
|
104605
|
+
"comment": {
|
|
104606
|
+
"type": "string",
|
|
104607
|
+
"description": "Optional comment to include with the review."
|
|
104608
|
+
}
|
|
104609
|
+
},
|
|
104610
|
+
"required": [
|
|
104611
|
+
"environment_name",
|
|
104612
|
+
"state"
|
|
104613
|
+
]
|
|
104614
|
+
},
|
|
104079
104615
|
"deployment-reviewer-type": {
|
|
104080
104616
|
"type": "string",
|
|
104081
104617
|
"description": "The type of reviewer.",
|
|
@@ -106609,8 +107145,13 @@
|
|
|
106609
107145
|
"items": {
|
|
106610
107146
|
"type": "string",
|
|
106611
107147
|
"enum": [
|
|
107148
|
+
"c",
|
|
107149
|
+
"cpp",
|
|
107150
|
+
"csharp",
|
|
106612
107151
|
"go",
|
|
107152
|
+
"java",
|
|
106613
107153
|
"javascript",
|
|
107154
|
+
"kotlin",
|
|
106614
107155
|
"python",
|
|
106615
107156
|
"ruby",
|
|
106616
107157
|
"typescript"
|
|
@@ -109750,6 +110291,70 @@
|
|
|
109750
110291
|
"name"
|
|
109751
110292
|
]
|
|
109752
110293
|
},
|
|
110294
|
+
"custom-deployment-rule-app": {
|
|
110295
|
+
"title": "Custom deployment protection rule app",
|
|
110296
|
+
"description": "A GitHub App that is providing a custom deployment protection rule.",
|
|
110297
|
+
"type": "object",
|
|
110298
|
+
"properties": {
|
|
110299
|
+
"id": {
|
|
110300
|
+
"type": "integer",
|
|
110301
|
+
"example": 3515,
|
|
110302
|
+
"description": "The unique identifier of the deployment protection rule integration."
|
|
110303
|
+
},
|
|
110304
|
+
"slug": {
|
|
110305
|
+
"type": "string",
|
|
110306
|
+
"example": "my-custom-app",
|
|
110307
|
+
"description": "The slugified name of the deployment protection rule integration."
|
|
110308
|
+
},
|
|
110309
|
+
"integration_url": {
|
|
110310
|
+
"type": "string",
|
|
110311
|
+
"example": "https://api.github.com/apps/custom-app-slug",
|
|
110312
|
+
"description": "The URL for the endpoint to get details about the app."
|
|
110313
|
+
},
|
|
110314
|
+
"node_id": {
|
|
110315
|
+
"type": "string",
|
|
110316
|
+
"example": "MDQ6R2F0ZTM1MTU=",
|
|
110317
|
+
"description": "The node ID for the deployment protection rule integration."
|
|
110318
|
+
}
|
|
110319
|
+
},
|
|
110320
|
+
"required": [
|
|
110321
|
+
"id",
|
|
110322
|
+
"slug",
|
|
110323
|
+
"integration_url",
|
|
110324
|
+
"node_id"
|
|
110325
|
+
]
|
|
110326
|
+
},
|
|
110327
|
+
"deployment-protection-rule": {
|
|
110328
|
+
"title": "Deployment protection rule",
|
|
110329
|
+
"description": "Deployment protection rule",
|
|
110330
|
+
"type": "object",
|
|
110331
|
+
"properties": {
|
|
110332
|
+
"id": {
|
|
110333
|
+
"type": "integer",
|
|
110334
|
+
"example": 3515,
|
|
110335
|
+
"description": "The unique identifier for the deployment protection rule."
|
|
110336
|
+
},
|
|
110337
|
+
"node_id": {
|
|
110338
|
+
"type": "string",
|
|
110339
|
+
"example": "MDQ6R2F0ZTM1MTU=",
|
|
110340
|
+
"description": "The node ID for the deployment protection rule."
|
|
110341
|
+
},
|
|
110342
|
+
"enabled": {
|
|
110343
|
+
"type": "boolean",
|
|
110344
|
+
"example": true,
|
|
110345
|
+
"description": "Whether the deployment protection rule is enabled for the environment."
|
|
110346
|
+
},
|
|
110347
|
+
"app": {
|
|
110348
|
+
"$ref": "#/components/schemas/custom-deployment-rule-app"
|
|
110349
|
+
}
|
|
110350
|
+
},
|
|
110351
|
+
"required": [
|
|
110352
|
+
"id",
|
|
110353
|
+
"node_id",
|
|
110354
|
+
"enabled",
|
|
110355
|
+
"app"
|
|
110356
|
+
]
|
|
110357
|
+
},
|
|
109753
110358
|
"short-blob": {
|
|
109754
110359
|
"title": "Short Blob",
|
|
109755
110360
|
"description": "Short Blob",
|
|
@@ -116400,28 +117005,122 @@
|
|
|
116400
117005
|
"type": "string"
|
|
116401
117006
|
}
|
|
116402
117007
|
},
|
|
116403
|
-
"credits": {
|
|
116404
|
-
"type": "array",
|
|
116405
|
-
"description": "A list of users receiving credit for their participation in the security advisory.",
|
|
116406
|
-
"nullable": true,
|
|
116407
|
-
"items": {
|
|
116408
|
-
"type": "object",
|
|
116409
|
-
"properties": {
|
|
116410
|
-
"login": {
|
|
116411
|
-
"type": "string",
|
|
116412
|
-
"description": "The username of the user credited."
|
|
116413
|
-
},
|
|
116414
|
-
"type": {
|
|
116415
|
-
"$ref": "#/components/schemas/repository-advisory-credit-types"
|
|
116416
|
-
}
|
|
116417
|
-
},
|
|
116418
|
-
"required": [
|
|
116419
|
-
"login",
|
|
116420
|
-
"type"
|
|
116421
|
-
],
|
|
116422
|
-
"additionalProperties": false
|
|
116423
|
-
}
|
|
116424
|
-
},
|
|
117008
|
+
"credits": {
|
|
117009
|
+
"type": "array",
|
|
117010
|
+
"description": "A list of users receiving credit for their participation in the security advisory.",
|
|
117011
|
+
"nullable": true,
|
|
117012
|
+
"items": {
|
|
117013
|
+
"type": "object",
|
|
117014
|
+
"properties": {
|
|
117015
|
+
"login": {
|
|
117016
|
+
"type": "string",
|
|
117017
|
+
"description": "The username of the user credited."
|
|
117018
|
+
},
|
|
117019
|
+
"type": {
|
|
117020
|
+
"$ref": "#/components/schemas/repository-advisory-credit-types"
|
|
117021
|
+
}
|
|
117022
|
+
},
|
|
117023
|
+
"required": [
|
|
117024
|
+
"login",
|
|
117025
|
+
"type"
|
|
117026
|
+
],
|
|
117027
|
+
"additionalProperties": false
|
|
117028
|
+
}
|
|
117029
|
+
},
|
|
117030
|
+
"severity": {
|
|
117031
|
+
"type": "string",
|
|
117032
|
+
"description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.",
|
|
117033
|
+
"nullable": true,
|
|
117034
|
+
"enum": [
|
|
117035
|
+
"critical",
|
|
117036
|
+
"high",
|
|
117037
|
+
"medium",
|
|
117038
|
+
"low"
|
|
117039
|
+
]
|
|
117040
|
+
},
|
|
117041
|
+
"cvss_vector_string": {
|
|
117042
|
+
"type": "string",
|
|
117043
|
+
"description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.",
|
|
117044
|
+
"nullable": true
|
|
117045
|
+
}
|
|
117046
|
+
},
|
|
117047
|
+
"required": [
|
|
117048
|
+
"summary",
|
|
117049
|
+
"description",
|
|
117050
|
+
"vulnerabilities"
|
|
117051
|
+
],
|
|
117052
|
+
"additionalProperties": false
|
|
117053
|
+
},
|
|
117054
|
+
"private-vulnerability-report-create": {
|
|
117055
|
+
"type": "object",
|
|
117056
|
+
"properties": {
|
|
117057
|
+
"summary": {
|
|
117058
|
+
"type": "string",
|
|
117059
|
+
"description": "A short summary of the advisory.",
|
|
117060
|
+
"maxLength": 1024
|
|
117061
|
+
},
|
|
117062
|
+
"description": {
|
|
117063
|
+
"type": "string",
|
|
117064
|
+
"description": "A detailed description of what the advisory impacts.",
|
|
117065
|
+
"maxLength": 65535
|
|
117066
|
+
},
|
|
117067
|
+
"vulnerabilities": {
|
|
117068
|
+
"type": "array",
|
|
117069
|
+
"description": "An array of products affected by the vulnerability detailed in a repository security advisory.",
|
|
117070
|
+
"nullable": true,
|
|
117071
|
+
"items": {
|
|
117072
|
+
"type": "object",
|
|
117073
|
+
"properties": {
|
|
117074
|
+
"package": {
|
|
117075
|
+
"description": "The name of the package affected by the vulnerability.",
|
|
117076
|
+
"type": "object",
|
|
117077
|
+
"properties": {
|
|
117078
|
+
"ecosystem": {
|
|
117079
|
+
"$ref": "#/components/schemas/repository-advisory-ecosystems"
|
|
117080
|
+
},
|
|
117081
|
+
"name": {
|
|
117082
|
+
"type": "string",
|
|
117083
|
+
"description": "The unique package name within its ecosystem.",
|
|
117084
|
+
"nullable": true
|
|
117085
|
+
}
|
|
117086
|
+
},
|
|
117087
|
+
"required": [
|
|
117088
|
+
"ecosystem"
|
|
117089
|
+
]
|
|
117090
|
+
},
|
|
117091
|
+
"vulnerable_version_range": {
|
|
117092
|
+
"type": "string",
|
|
117093
|
+
"description": "The range of the package versions affected by the vulnerability.",
|
|
117094
|
+
"nullable": true
|
|
117095
|
+
},
|
|
117096
|
+
"patched_versions": {
|
|
117097
|
+
"type": "string",
|
|
117098
|
+
"description": "The package version(s) that resolve the vulnerability.",
|
|
117099
|
+
"nullable": true
|
|
117100
|
+
},
|
|
117101
|
+
"vulnerable_functions": {
|
|
117102
|
+
"type": "array",
|
|
117103
|
+
"description": "The functions in the package that are affected.",
|
|
117104
|
+
"nullable": true,
|
|
117105
|
+
"items": {
|
|
117106
|
+
"type": "string"
|
|
117107
|
+
}
|
|
117108
|
+
}
|
|
117109
|
+
},
|
|
117110
|
+
"required": [
|
|
117111
|
+
"package"
|
|
117112
|
+
],
|
|
117113
|
+
"additionalProperties": false
|
|
117114
|
+
}
|
|
117115
|
+
},
|
|
117116
|
+
"cwe_ids": {
|
|
117117
|
+
"type": "array",
|
|
117118
|
+
"description": "A list of Common Weakness Enumeration (CWE) IDs.",
|
|
117119
|
+
"nullable": true,
|
|
117120
|
+
"items": {
|
|
117121
|
+
"type": "string"
|
|
117122
|
+
}
|
|
117123
|
+
},
|
|
116425
117124
|
"severity": {
|
|
116426
117125
|
"type": "string",
|
|
116427
117126
|
"description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.",
|
|
@@ -116441,8 +117140,7 @@
|
|
|
116441
117140
|
},
|
|
116442
117141
|
"required": [
|
|
116443
117142
|
"summary",
|
|
116444
|
-
"description"
|
|
116445
|
-
"vulnerabilities"
|
|
117143
|
+
"description"
|
|
116446
117144
|
],
|
|
116447
117145
|
"additionalProperties": false
|
|
116448
117146
|
},
|
|
@@ -118883,7 +119581,7 @@
|
|
|
118883
119581
|
}
|
|
118884
119582
|
},
|
|
118885
119583
|
"location": {
|
|
118886
|
-
"description": "The
|
|
119584
|
+
"description": "The initally assigned location of a new codespace.",
|
|
118887
119585
|
"enum": [
|
|
118888
119586
|
"EastUs",
|
|
118889
119587
|
"SouthEastAsia",
|
|
@@ -127722,6 +128420,52 @@
|
|
|
127722
128420
|
"sender"
|
|
127723
128421
|
]
|
|
127724
128422
|
},
|
|
128423
|
+
"webhook-deployment-protection-rule-requested": {
|
|
128424
|
+
"title": "deployment protection rule requested event",
|
|
128425
|
+
"type": "object",
|
|
128426
|
+
"properties": {
|
|
128427
|
+
"action": {
|
|
128428
|
+
"type": "string",
|
|
128429
|
+
"enum": [
|
|
128430
|
+
"requested"
|
|
128431
|
+
]
|
|
128432
|
+
},
|
|
128433
|
+
"environment": {
|
|
128434
|
+
"description": "The name of the environment that has the deployment protection rule.",
|
|
128435
|
+
"type": "string"
|
|
128436
|
+
},
|
|
128437
|
+
"event": {
|
|
128438
|
+
"description": "The event that triggered the deployment protection rule.",
|
|
128439
|
+
"type": "string"
|
|
128440
|
+
},
|
|
128441
|
+
"deployment_callback_url": {
|
|
128442
|
+
"description": "The URL to review the deployment protection rule.",
|
|
128443
|
+
"type": "string",
|
|
128444
|
+
"format": "uri"
|
|
128445
|
+
},
|
|
128446
|
+
"deployment": {
|
|
128447
|
+
"$ref": "#/components/schemas/deployment"
|
|
128448
|
+
},
|
|
128449
|
+
"pull_requests": {
|
|
128450
|
+
"type": "array",
|
|
128451
|
+
"items": {
|
|
128452
|
+
"$ref": "#/components/schemas/pull-request"
|
|
128453
|
+
}
|
|
128454
|
+
},
|
|
128455
|
+
"repository": {
|
|
128456
|
+
"$ref": "#/components/schemas/repository"
|
|
128457
|
+
},
|
|
128458
|
+
"organization": {
|
|
128459
|
+
"$ref": "#/components/schemas/organization-simple"
|
|
128460
|
+
},
|
|
128461
|
+
"installation": {
|
|
128462
|
+
"$ref": "#/components/schemas/simple-installation"
|
|
128463
|
+
},
|
|
128464
|
+
"sender": {
|
|
128465
|
+
"$ref": "#/components/schemas/simple-user"
|
|
128466
|
+
}
|
|
128467
|
+
}
|
|
128468
|
+
},
|
|
127725
128469
|
"webhook-deployment-status-created": {
|
|
127726
128470
|
"title": "deployment_status created event",
|
|
127727
128471
|
"type": "object",
|
|
@@ -170580,6 +171324,56 @@
|
|
|
170580
171324
|
"sender"
|
|
170581
171325
|
]
|
|
170582
171326
|
},
|
|
171327
|
+
"webhook-rubygems-metadata": {
|
|
171328
|
+
"title": "Ruby Gems metadata",
|
|
171329
|
+
"type": "object",
|
|
171330
|
+
"properties": {
|
|
171331
|
+
"name": {
|
|
171332
|
+
"type": "string"
|
|
171333
|
+
},
|
|
171334
|
+
"description": {
|
|
171335
|
+
"type": "string"
|
|
171336
|
+
},
|
|
171337
|
+
"readme": {
|
|
171338
|
+
"type": "string"
|
|
171339
|
+
},
|
|
171340
|
+
"homepage": {
|
|
171341
|
+
"type": "string"
|
|
171342
|
+
},
|
|
171343
|
+
"version_info": {
|
|
171344
|
+
"type": "object",
|
|
171345
|
+
"properties": {
|
|
171346
|
+
"version": {
|
|
171347
|
+
"type": "string"
|
|
171348
|
+
}
|
|
171349
|
+
}
|
|
171350
|
+
},
|
|
171351
|
+
"platform": {
|
|
171352
|
+
"type": "string"
|
|
171353
|
+
},
|
|
171354
|
+
"metadata": {
|
|
171355
|
+
"type": "object",
|
|
171356
|
+
"additionalProperties": {
|
|
171357
|
+
"type": "string"
|
|
171358
|
+
}
|
|
171359
|
+
},
|
|
171360
|
+
"repo": {
|
|
171361
|
+
"type": "string"
|
|
171362
|
+
},
|
|
171363
|
+
"dependencies": {
|
|
171364
|
+
"type": "array",
|
|
171365
|
+
"items": {
|
|
171366
|
+
"type": "object",
|
|
171367
|
+
"additionalProperties": {
|
|
171368
|
+
"type": "string"
|
|
171369
|
+
}
|
|
171370
|
+
}
|
|
171371
|
+
},
|
|
171372
|
+
"commit_oid": {
|
|
171373
|
+
"type": "string"
|
|
171374
|
+
}
|
|
171375
|
+
}
|
|
171376
|
+
},
|
|
170583
171377
|
"webhook-package-published": {
|
|
170584
171378
|
"title": "package published event",
|
|
170585
171379
|
"type": "object",
|
|
@@ -170864,7 +171658,17 @@
|
|
|
170864
171658
|
},
|
|
170865
171659
|
"docker_metadata": {
|
|
170866
171660
|
"type": "array",
|
|
170867
|
-
"items": {
|
|
171661
|
+
"items": {
|
|
171662
|
+
"type": "object",
|
|
171663
|
+
"properties": {
|
|
171664
|
+
"tags": {
|
|
171665
|
+
"type": "array",
|
|
171666
|
+
"items": {
|
|
171667
|
+
"type": "string"
|
|
171668
|
+
}
|
|
171669
|
+
}
|
|
171670
|
+
}
|
|
171671
|
+
}
|
|
170868
171672
|
},
|
|
170869
171673
|
"draft": {
|
|
170870
171674
|
"type": "boolean"
|
|
@@ -171294,7 +172098,9 @@
|
|
|
171294
172098
|
},
|
|
171295
172099
|
"rubygems_metadata": {
|
|
171296
172100
|
"type": "array",
|
|
171297
|
-
"items": {
|
|
172101
|
+
"items": {
|
|
172102
|
+
"$ref": "#/components/schemas/webhook-rubygems-metadata"
|
|
172103
|
+
}
|
|
171298
172104
|
},
|
|
171299
172105
|
"source_url": {
|
|
171300
172106
|
"type": "string"
|
|
@@ -171643,7 +172449,17 @@
|
|
|
171643
172449
|
},
|
|
171644
172450
|
"docker_metadata": {
|
|
171645
172451
|
"type": "array",
|
|
171646
|
-
"items": {
|
|
172452
|
+
"items": {
|
|
172453
|
+
"type": "object",
|
|
172454
|
+
"properties": {
|
|
172455
|
+
"tags": {
|
|
172456
|
+
"type": "array",
|
|
172457
|
+
"items": {
|
|
172458
|
+
"type": "string"
|
|
172459
|
+
}
|
|
172460
|
+
}
|
|
172461
|
+
}
|
|
172462
|
+
}
|
|
171647
172463
|
},
|
|
171648
172464
|
"draft": {
|
|
171649
172465
|
"type": "boolean"
|
|
@@ -171663,7 +172479,10 @@
|
|
|
171663
172479
|
},
|
|
171664
172480
|
"metadata": {
|
|
171665
172481
|
"type": "array",
|
|
171666
|
-
"items": {
|
|
172482
|
+
"items": {
|
|
172483
|
+
"type": "object",
|
|
172484
|
+
"additionalProperties": true
|
|
172485
|
+
}
|
|
171667
172486
|
},
|
|
171668
172487
|
"name": {
|
|
171669
172488
|
"type": "string"
|
|
@@ -171875,7 +172694,9 @@
|
|
|
171875
172694
|
},
|
|
171876
172695
|
"rubygems_metadata": {
|
|
171877
172696
|
"type": "array",
|
|
171878
|
-
"items": {
|
|
172697
|
+
"items": {
|
|
172698
|
+
"$ref": "#/components/schemas/webhook-rubygems-metadata"
|
|
172699
|
+
}
|
|
171879
172700
|
},
|
|
171880
172701
|
"source_url": {
|
|
171881
172702
|
"type": "string",
|
|
@@ -252778,7 +253599,17 @@
|
|
|
252778
253599
|
},
|
|
252779
253600
|
"docker_metadata": {
|
|
252780
253601
|
"type": "array",
|
|
252781
|
-
"items": {
|
|
253602
|
+
"items": {
|
|
253603
|
+
"type": "object",
|
|
253604
|
+
"properties": {
|
|
253605
|
+
"tags": {
|
|
253606
|
+
"type": "array",
|
|
253607
|
+
"items": {
|
|
253608
|
+
"type": "string"
|
|
253609
|
+
}
|
|
253610
|
+
}
|
|
253611
|
+
}
|
|
253612
|
+
}
|
|
252782
253613
|
},
|
|
252783
253614
|
"draft": {
|
|
252784
253615
|
"type": "boolean"
|
|
@@ -253197,7 +254028,9 @@
|
|
|
253197
254028
|
},
|
|
253198
254029
|
"rubygems_metadata": {
|
|
253199
254030
|
"type": "array",
|
|
253200
|
-
"items": {
|
|
254031
|
+
"items": {
|
|
254032
|
+
"$ref": "#/components/schemas/webhook-rubygems-metadata"
|
|
254033
|
+
}
|
|
253201
254034
|
},
|
|
253202
254035
|
"summary": {
|
|
253203
254036
|
"type": "string"
|
|
@@ -253503,7 +254336,16 @@
|
|
|
253503
254336
|
"docker_metadata": {
|
|
253504
254337
|
"type": "array",
|
|
253505
254338
|
"items": {
|
|
253506
|
-
"
|
|
254339
|
+
"type": "object",
|
|
254340
|
+
"nullable": true,
|
|
254341
|
+
"properties": {
|
|
254342
|
+
"tags": {
|
|
254343
|
+
"type": "array",
|
|
254344
|
+
"items": {
|
|
254345
|
+
"type": "string"
|
|
254346
|
+
}
|
|
254347
|
+
}
|
|
254348
|
+
}
|
|
253507
254349
|
}
|
|
253508
254350
|
},
|
|
253509
254351
|
"draft": {
|
|
@@ -253523,7 +254365,10 @@
|
|
|
253523
254365
|
},
|
|
253524
254366
|
"metadata": {
|
|
253525
254367
|
"type": "array",
|
|
253526
|
-
"items": {
|
|
254368
|
+
"items": {
|
|
254369
|
+
"type": "object",
|
|
254370
|
+
"additionalProperties": true
|
|
254371
|
+
}
|
|
253527
254372
|
},
|
|
253528
254373
|
"name": {
|
|
253529
254374
|
"type": "string"
|
|
@@ -253706,7 +254551,9 @@
|
|
|
253706
254551
|
},
|
|
253707
254552
|
"rubygems_metadata": {
|
|
253708
254553
|
"type": "array",
|
|
253709
|
-
"items": {
|
|
254554
|
+
"items": {
|
|
254555
|
+
"$ref": "#/components/schemas/webhook-rubygems-metadata"
|
|
254556
|
+
}
|
|
253710
254557
|
},
|
|
253711
254558
|
"summary": {
|
|
253712
254559
|
"type": "string"
|
|
@@ -281980,7 +282827,7 @@
|
|
|
281980
282827
|
"target": "branch",
|
|
281981
282828
|
"source_type": "Organization",
|
|
281982
282829
|
"source": "my-org",
|
|
281983
|
-
"enforcement": "
|
|
282830
|
+
"enforcement": "active",
|
|
281984
282831
|
"bypass_actors": [
|
|
281985
282832
|
{
|
|
281986
282833
|
"actor_id": 234,
|
|
@@ -290908,6 +291755,42 @@
|
|
|
290908
291755
|
"name": "main"
|
|
290909
291756
|
}
|
|
290910
291757
|
},
|
|
291758
|
+
"deployment-protection-rule": {
|
|
291759
|
+
"value": {
|
|
291760
|
+
"id": 3,
|
|
291761
|
+
"node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv",
|
|
291762
|
+
"enabled": true,
|
|
291763
|
+
"app": {
|
|
291764
|
+
"id": 1,
|
|
291765
|
+
"node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
|
|
291766
|
+
"slug": "a-custom-app",
|
|
291767
|
+
"integration_url": "https://api.github.com/apps/a-custom-app"
|
|
291768
|
+
}
|
|
291769
|
+
}
|
|
291770
|
+
},
|
|
291771
|
+
"custom-deployment-protection-rule-apps": {
|
|
291772
|
+
"value": [
|
|
291773
|
+
{
|
|
291774
|
+
"total_count": 2
|
|
291775
|
+
},
|
|
291776
|
+
{
|
|
291777
|
+
"available_custom_deployment_protection_rule_integrations": [
|
|
291778
|
+
{
|
|
291779
|
+
"id": 1,
|
|
291780
|
+
"node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
|
|
291781
|
+
"slug": "a-custom-app",
|
|
291782
|
+
"integration_url": "https://api.github.com/apps/a-custom-app"
|
|
291783
|
+
},
|
|
291784
|
+
{
|
|
291785
|
+
"id": 2,
|
|
291786
|
+
"node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy",
|
|
291787
|
+
"slug": "another-custom-app",
|
|
291788
|
+
"integration_url": "https://api.github.com/apps/another-custom-app"
|
|
291789
|
+
}
|
|
291790
|
+
]
|
|
291791
|
+
}
|
|
291792
|
+
]
|
|
291793
|
+
},
|
|
290911
291794
|
"repo-events-items": {
|
|
290912
291795
|
"value": [
|
|
290913
291796
|
{
|
|
@@ -295666,7 +296549,7 @@
|
|
|
295666
296549
|
"target": "branch",
|
|
295667
296550
|
"source_type": "Repository",
|
|
295668
296551
|
"source": "monalisa/my-repo",
|
|
295669
|
-
"enforcement": "
|
|
296552
|
+
"enforcement": "active",
|
|
295670
296553
|
"bypass_mode": "repository",
|
|
295671
296554
|
"bypass_actors": [
|
|
295672
296555
|
{
|
|
@@ -296284,6 +297167,112 @@
|
|
|
296284
297167
|
]
|
|
296285
297168
|
}
|
|
296286
297169
|
},
|
|
297170
|
+
"repository-advisory-pvr": {
|
|
297171
|
+
"value": {
|
|
297172
|
+
"ghsa_id": "GHSA-abcd-1234-efgh",
|
|
297173
|
+
"cve_id": "CVE-2050-00000",
|
|
297174
|
+
"url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh",
|
|
297175
|
+
"html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh",
|
|
297176
|
+
"summary": "A newly discovered vulnerability",
|
|
297177
|
+
"description": "A more in-depth description of what the problem is.",
|
|
297178
|
+
"severity": "high",
|
|
297179
|
+
"author": {
|
|
297180
|
+
"login": "octocat",
|
|
297181
|
+
"id": 1,
|
|
297182
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
297183
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
297184
|
+
"gravatar_id": "",
|
|
297185
|
+
"url": "https://api.github.com/users/octocat",
|
|
297186
|
+
"html_url": "https://github.com/octocat",
|
|
297187
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
297188
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
297189
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
297190
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
297191
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
297192
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
297193
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
297194
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
297195
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
297196
|
+
"type": "User",
|
|
297197
|
+
"site_admin": false
|
|
297198
|
+
},
|
|
297199
|
+
"publisher": null,
|
|
297200
|
+
"identifiers": [
|
|
297201
|
+
{
|
|
297202
|
+
"type": "GHSA",
|
|
297203
|
+
"value": "GHSA-abcd-1234-efgh"
|
|
297204
|
+
},
|
|
297205
|
+
{
|
|
297206
|
+
"type": "CVE",
|
|
297207
|
+
"value": null
|
|
297208
|
+
}
|
|
297209
|
+
],
|
|
297210
|
+
"state": "triage",
|
|
297211
|
+
"created_at": "2020-01-01T00:00:00Z",
|
|
297212
|
+
"updated_at": "2020-01-02T00:00:00Z",
|
|
297213
|
+
"published_at": null,
|
|
297214
|
+
"closed_at": null,
|
|
297215
|
+
"withdrawn_at": null,
|
|
297216
|
+
"submission": {
|
|
297217
|
+
"accepted": false
|
|
297218
|
+
},
|
|
297219
|
+
"vulnerabilities": [
|
|
297220
|
+
{
|
|
297221
|
+
"package": {
|
|
297222
|
+
"ecosystem": "npm",
|
|
297223
|
+
"name": "a-package"
|
|
297224
|
+
},
|
|
297225
|
+
"vulnerable_version_range": "< 1.0.0",
|
|
297226
|
+
"patched_versions": "1.0.0",
|
|
297227
|
+
"vulnerable_functions": [
|
|
297228
|
+
"important_function"
|
|
297229
|
+
]
|
|
297230
|
+
}
|
|
297231
|
+
],
|
|
297232
|
+
"cvss": null,
|
|
297233
|
+
"cwes": [
|
|
297234
|
+
{
|
|
297235
|
+
"cwe_id": "CWE-123",
|
|
297236
|
+
"name": "A CWE"
|
|
297237
|
+
}
|
|
297238
|
+
],
|
|
297239
|
+
"cwe_ids": [
|
|
297240
|
+
"CWE-123"
|
|
297241
|
+
],
|
|
297242
|
+
"credits": [
|
|
297243
|
+
{
|
|
297244
|
+
"login": "octocat",
|
|
297245
|
+
"type": "finder"
|
|
297246
|
+
}
|
|
297247
|
+
],
|
|
297248
|
+
"credits_detailed": [
|
|
297249
|
+
{
|
|
297250
|
+
"user": {
|
|
297251
|
+
"login": "octocat",
|
|
297252
|
+
"id": 1,
|
|
297253
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
297254
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
297255
|
+
"gravatar_id": "",
|
|
297256
|
+
"url": "https://api.github.com/users/octocat",
|
|
297257
|
+
"html_url": "https://github.com/octocat",
|
|
297258
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
297259
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
297260
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
297261
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
297262
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
297263
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
297264
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
297265
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
297266
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
297267
|
+
"type": "User",
|
|
297268
|
+
"site_admin": false
|
|
297269
|
+
},
|
|
297270
|
+
"type": "finder",
|
|
297271
|
+
"state": "accepted"
|
|
297272
|
+
}
|
|
297273
|
+
]
|
|
297274
|
+
}
|
|
297275
|
+
},
|
|
296287
297276
|
"simple-user-items-default-response": {
|
|
296288
297277
|
"summary": "Default response",
|
|
296289
297278
|
"value": [
|
|
@@ -304381,6 +305370,15 @@
|
|
|
304381
305370
|
"type": "integer"
|
|
304382
305371
|
}
|
|
304383
305372
|
},
|
|
305373
|
+
"protection-rule-id": {
|
|
305374
|
+
"name": "protection_rule_id",
|
|
305375
|
+
"description": "The unique identifier of the protection rule.",
|
|
305376
|
+
"in": "path",
|
|
305377
|
+
"required": true,
|
|
305378
|
+
"schema": {
|
|
305379
|
+
"type": "integer"
|
|
305380
|
+
}
|
|
305381
|
+
},
|
|
304384
305382
|
"since-user": {
|
|
304385
305383
|
"name": "since",
|
|
304386
305384
|
"description": "A user ID. Only return users with an ID greater than this ID.",
|