@octokit/openapi 11.0.0 → 11.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated/api.github.com.deref.json +7446 -606
- package/generated/api.github.com.json +1135 -104
- package/generated/ghec-diff-to-api.github.com.deref.json +4944 -11
- package/generated/ghec-diff-to-api.github.com.json +92 -1
- package/generated/ghec.deref.json +7446 -606
- package/generated/ghec.json +1135 -104
- package/generated/ghes-3.5-diff-to-ghes-3.6.deref.json +2 -2
- package/generated/ghes-3.5-diff-to-ghes-3.6.json +2 -2
- package/generated/ghes-3.5.deref.json +2 -2
- package/generated/ghes-3.5.json +2 -2
- package/generated/ghes-3.6-diff-to-ghes-3.7.deref.json +2 -2
- package/generated/ghes-3.6-diff-to-ghes-3.7.json +2 -2
- package/generated/ghes-3.6.deref.json +2 -2
- package/generated/ghes-3.6.json +2 -2
- package/generated/ghes-3.7-diff-to-ghes-3.8.deref.json +252 -11
- package/generated/ghes-3.7-diff-to-ghes-3.8.json +1 -1
- package/generated/ghes-3.7.deref.json +253 -12
- package/generated/ghes-3.7.json +115 -12
- package/generated/ghes-3.8-anicca-diff-to-api.github.com.deref.json +17 -0
- package/generated/ghes-3.8-diff-to-api.github.com.deref.json +252 -11
- package/generated/ghes-3.8-diff-to-api.github.com.json +1 -1
- package/generated/ghes-3.8.deref.json +403 -12
- package/generated/ghes-3.8.json +265 -12
- package/generated/github.ae-anicca-diff-to-api.github.com.deref.json +17 -0
- package/generated/github.ae-diff-to-api.github.com.deref.json +4996 -146
- package/generated/github.ae-diff-to-api.github.com.json +96 -5
- package/generated/github.ae.deref.json +5146 -146
- package/generated/github.ae.json +405 -15
- package/package.json +1 -1
package/generated/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.0",
|
|
5
5
|
"title": "GitHub's official OpenAPI spec + Octokit extension",
|
|
6
6
|
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
|
|
7
7
|
"license": {
|
|
@@ -19401,10 +19401,9 @@
|
|
|
19401
19401
|
"examples": {
|
|
19402
19402
|
"default": {
|
|
19403
19403
|
"value": {
|
|
19404
|
-
"id": 21,
|
|
19405
19404
|
"name": "super cool ruleset",
|
|
19406
19405
|
"target": "branch",
|
|
19407
|
-
"enforcement": "
|
|
19406
|
+
"enforcement": "active",
|
|
19408
19407
|
"bypass_actors": [
|
|
19409
19408
|
{
|
|
19410
19409
|
"actor_id": 234,
|
|
@@ -19596,10 +19595,9 @@
|
|
|
19596
19595
|
"examples": {
|
|
19597
19596
|
"default": {
|
|
19598
19597
|
"value": {
|
|
19599
|
-
"id": 21,
|
|
19600
19598
|
"name": "super cool ruleset",
|
|
19601
19599
|
"target": "branch",
|
|
19602
|
-
"enforcement": "
|
|
19600
|
+
"enforcement": "active",
|
|
19603
19601
|
"bypass_actors": [
|
|
19604
19602
|
{
|
|
19605
19603
|
"actor_id": 234,
|
|
@@ -27485,6 +27483,70 @@
|
|
|
27485
27483
|
"x-octokit": {}
|
|
27486
27484
|
}
|
|
27487
27485
|
},
|
|
27486
|
+
"/repos/{owner}/{repo}/actions/runs/{run_id}/deployment_protection_rule": {
|
|
27487
|
+
"post": {
|
|
27488
|
+
"summary": "Review custom deployment protection rules for a workflow run",
|
|
27489
|
+
"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.",
|
|
27490
|
+
"tags": [
|
|
27491
|
+
"actions"
|
|
27492
|
+
],
|
|
27493
|
+
"operationId": "actions/review-custom-gates-for-run",
|
|
27494
|
+
"externalDocs": {
|
|
27495
|
+
"description": "API method documentation",
|
|
27496
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#review-custom-deployment-protection-rules-for-a-workflow-run"
|
|
27497
|
+
},
|
|
27498
|
+
"parameters": [
|
|
27499
|
+
{
|
|
27500
|
+
"$ref": "#/components/parameters/owner"
|
|
27501
|
+
},
|
|
27502
|
+
{
|
|
27503
|
+
"$ref": "#/components/parameters/repo"
|
|
27504
|
+
},
|
|
27505
|
+
{
|
|
27506
|
+
"$ref": "#/components/parameters/run-id"
|
|
27507
|
+
}
|
|
27508
|
+
],
|
|
27509
|
+
"requestBody": {
|
|
27510
|
+
"required": true,
|
|
27511
|
+
"content": {
|
|
27512
|
+
"application/json": {
|
|
27513
|
+
"schema": {
|
|
27514
|
+
"anyOf": [
|
|
27515
|
+
{
|
|
27516
|
+
"$ref": "#/components/schemas/review-custom-gates-comment-required"
|
|
27517
|
+
},
|
|
27518
|
+
{
|
|
27519
|
+
"$ref": "#/components/schemas/review-custom-gates-state-required"
|
|
27520
|
+
}
|
|
27521
|
+
]
|
|
27522
|
+
},
|
|
27523
|
+
"examples": {
|
|
27524
|
+
"default": {
|
|
27525
|
+
"value": {
|
|
27526
|
+
"environment_name": "prod-eus",
|
|
27527
|
+
"state": "approved",
|
|
27528
|
+
"comment": "All health checks passed."
|
|
27529
|
+
}
|
|
27530
|
+
}
|
|
27531
|
+
}
|
|
27532
|
+
}
|
|
27533
|
+
}
|
|
27534
|
+
},
|
|
27535
|
+
"responses": {
|
|
27536
|
+
"204": {
|
|
27537
|
+
"description": "Response"
|
|
27538
|
+
}
|
|
27539
|
+
},
|
|
27540
|
+
"x-github": {
|
|
27541
|
+
"githubCloudOnly": false,
|
|
27542
|
+
"enabledForGitHubApps": true,
|
|
27543
|
+
"previews": [],
|
|
27544
|
+
"category": "actions",
|
|
27545
|
+
"subcategory": "workflow-runs"
|
|
27546
|
+
},
|
|
27547
|
+
"x-octokit": {}
|
|
27548
|
+
}
|
|
27549
|
+
},
|
|
27488
27550
|
"/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": {
|
|
27489
27551
|
"get": {
|
|
27490
27552
|
"summary": "List jobs for a workflow run",
|
|
@@ -34649,7 +34711,7 @@
|
|
|
34649
34711
|
"type": "string"
|
|
34650
34712
|
},
|
|
34651
34713
|
"location": {
|
|
34652
|
-
"description": "
|
|
34714
|
+
"description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
|
|
34653
34715
|
"type": "string"
|
|
34654
34716
|
},
|
|
34655
34717
|
"client_ip": {
|
|
@@ -39541,10 +39603,296 @@
|
|
|
39541
39603
|
"x-octokit": {}
|
|
39542
39604
|
}
|
|
39543
39605
|
},
|
|
39606
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules": {
|
|
39607
|
+
"get": {
|
|
39608
|
+
"summary": "Get all deployment protection rules for an environment",
|
|
39609
|
+
"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).",
|
|
39610
|
+
"tags": [
|
|
39611
|
+
"repos"
|
|
39612
|
+
],
|
|
39613
|
+
"operationId": "repos/get-all-deployment-protection-rules",
|
|
39614
|
+
"externalDocs": {
|
|
39615
|
+
"description": "API method documentation",
|
|
39616
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-all-deployment-protection-rules"
|
|
39617
|
+
},
|
|
39618
|
+
"parameters": [
|
|
39619
|
+
{
|
|
39620
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39621
|
+
},
|
|
39622
|
+
{
|
|
39623
|
+
"$ref": "#/components/parameters/repo"
|
|
39624
|
+
},
|
|
39625
|
+
{
|
|
39626
|
+
"$ref": "#/components/parameters/owner"
|
|
39627
|
+
}
|
|
39628
|
+
],
|
|
39629
|
+
"responses": {
|
|
39630
|
+
"200": {
|
|
39631
|
+
"description": "List of deployment protection rules",
|
|
39632
|
+
"content": {
|
|
39633
|
+
"application/json": {
|
|
39634
|
+
"schema": {
|
|
39635
|
+
"type": "object",
|
|
39636
|
+
"properties": {
|
|
39637
|
+
"total_count": {
|
|
39638
|
+
"description": "The number of enabled custom deployment protection rules for this environment",
|
|
39639
|
+
"type": "integer",
|
|
39640
|
+
"example": 10
|
|
39641
|
+
},
|
|
39642
|
+
"custom_deployment_protection_rules": {
|
|
39643
|
+
"type": "array",
|
|
39644
|
+
"items": {
|
|
39645
|
+
"$ref": "#/components/schemas/deployment-protection-rule"
|
|
39646
|
+
}
|
|
39647
|
+
}
|
|
39648
|
+
},
|
|
39649
|
+
"example": "../../components/examples/deployment_protection_rules.yaml"
|
|
39650
|
+
}
|
|
39651
|
+
}
|
|
39652
|
+
}
|
|
39653
|
+
}
|
|
39654
|
+
},
|
|
39655
|
+
"x-github": {
|
|
39656
|
+
"githubCloudOnly": false,
|
|
39657
|
+
"enabledForGitHubApps": true,
|
|
39658
|
+
"category": "deployments",
|
|
39659
|
+
"subcategory": "protection-rules"
|
|
39660
|
+
},
|
|
39661
|
+
"x-octokit": {}
|
|
39662
|
+
},
|
|
39663
|
+
"post": {
|
|
39664
|
+
"summary": "Create a custom deployment protection rule on an environment",
|
|
39665
|
+
"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).",
|
|
39666
|
+
"tags": [
|
|
39667
|
+
"repos"
|
|
39668
|
+
],
|
|
39669
|
+
"operationId": "repos/create-deployment-protection-rule",
|
|
39670
|
+
"externalDocs": {
|
|
39671
|
+
"description": "API method documentation",
|
|
39672
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployment-protection-rules#create-a-deployment-protection-rule"
|
|
39673
|
+
},
|
|
39674
|
+
"parameters": [
|
|
39675
|
+
{
|
|
39676
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39677
|
+
},
|
|
39678
|
+
{
|
|
39679
|
+
"$ref": "#/components/parameters/repo"
|
|
39680
|
+
},
|
|
39681
|
+
{
|
|
39682
|
+
"$ref": "#/components/parameters/owner"
|
|
39683
|
+
}
|
|
39684
|
+
],
|
|
39685
|
+
"requestBody": {
|
|
39686
|
+
"content": {
|
|
39687
|
+
"application/json": {
|
|
39688
|
+
"schema": {
|
|
39689
|
+
"type": "object",
|
|
39690
|
+
"properties": {
|
|
39691
|
+
"integration_id": {
|
|
39692
|
+
"type": "integer",
|
|
39693
|
+
"description": "The ID of the custom app that will be enabled on the environment."
|
|
39694
|
+
}
|
|
39695
|
+
}
|
|
39696
|
+
},
|
|
39697
|
+
"examples": {
|
|
39698
|
+
"default": {
|
|
39699
|
+
"value": {
|
|
39700
|
+
"integration_id": 5
|
|
39701
|
+
}
|
|
39702
|
+
}
|
|
39703
|
+
}
|
|
39704
|
+
}
|
|
39705
|
+
},
|
|
39706
|
+
"required": true
|
|
39707
|
+
},
|
|
39708
|
+
"responses": {
|
|
39709
|
+
"201": {
|
|
39710
|
+
"description": "The enabled custom deployment protection rule",
|
|
39711
|
+
"content": {
|
|
39712
|
+
"application/json": {
|
|
39713
|
+
"schema": {
|
|
39714
|
+
"$ref": "#/components/schemas/deployment-protection-rule"
|
|
39715
|
+
},
|
|
39716
|
+
"examples": {
|
|
39717
|
+
"default": {
|
|
39718
|
+
"$ref": "#/components/examples/deployment-protection-rule"
|
|
39719
|
+
}
|
|
39720
|
+
}
|
|
39721
|
+
}
|
|
39722
|
+
}
|
|
39723
|
+
}
|
|
39724
|
+
},
|
|
39725
|
+
"x-github": {
|
|
39726
|
+
"githubCloudOnly": false,
|
|
39727
|
+
"enabledForGitHubApps": true,
|
|
39728
|
+
"category": "deployments",
|
|
39729
|
+
"subcategory": "protection-rules"
|
|
39730
|
+
},
|
|
39731
|
+
"x-octokit": {}
|
|
39732
|
+
}
|
|
39733
|
+
},
|
|
39734
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/apps": {
|
|
39735
|
+
"get": {
|
|
39736
|
+
"summary": "List custom deployment rule integrations available for an environment",
|
|
39737
|
+
"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)\".",
|
|
39738
|
+
"tags": [
|
|
39739
|
+
"repos"
|
|
39740
|
+
],
|
|
39741
|
+
"operationId": "repos/list-custom-deployment-rule-integrations",
|
|
39742
|
+
"externalDocs": {
|
|
39743
|
+
"description": "API method documentation",
|
|
39744
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#list-custom-deployment-rule-integrations"
|
|
39745
|
+
},
|
|
39746
|
+
"parameters": [
|
|
39747
|
+
{
|
|
39748
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39749
|
+
},
|
|
39750
|
+
{
|
|
39751
|
+
"$ref": "#/components/parameters/repo"
|
|
39752
|
+
},
|
|
39753
|
+
{
|
|
39754
|
+
"$ref": "#/components/parameters/owner"
|
|
39755
|
+
},
|
|
39756
|
+
{
|
|
39757
|
+
"$ref": "#/components/parameters/page"
|
|
39758
|
+
},
|
|
39759
|
+
{
|
|
39760
|
+
"$ref": "#/components/parameters/per-page"
|
|
39761
|
+
}
|
|
39762
|
+
],
|
|
39763
|
+
"responses": {
|
|
39764
|
+
"200": {
|
|
39765
|
+
"description": "A list of custom deployment rule integrations available for this environment.",
|
|
39766
|
+
"content": {
|
|
39767
|
+
"application/json": {
|
|
39768
|
+
"schema": {
|
|
39769
|
+
"type": "object",
|
|
39770
|
+
"properties": {
|
|
39771
|
+
"total_count": {
|
|
39772
|
+
"description": "The total number of custom deployment protection rule integrations available for this environment.",
|
|
39773
|
+
"type": "integer",
|
|
39774
|
+
"example": 35
|
|
39775
|
+
},
|
|
39776
|
+
"available_custom_deployment_protection_rule_integrations": {
|
|
39777
|
+
"type": "array",
|
|
39778
|
+
"items": {
|
|
39779
|
+
"$ref": "#/components/schemas/custom-deployment-rule-app"
|
|
39780
|
+
}
|
|
39781
|
+
}
|
|
39782
|
+
}
|
|
39783
|
+
},
|
|
39784
|
+
"examples": {
|
|
39785
|
+
"default": {
|
|
39786
|
+
"$ref": "#/components/examples/custom-deployment-protection-rule-apps"
|
|
39787
|
+
}
|
|
39788
|
+
}
|
|
39789
|
+
}
|
|
39790
|
+
}
|
|
39791
|
+
}
|
|
39792
|
+
},
|
|
39793
|
+
"x-github": {
|
|
39794
|
+
"githubCloudOnly": false,
|
|
39795
|
+
"enabledForGitHubApps": true,
|
|
39796
|
+
"category": "deployments",
|
|
39797
|
+
"subcategory": "protection-rules"
|
|
39798
|
+
},
|
|
39799
|
+
"x-octokit": {}
|
|
39800
|
+
}
|
|
39801
|
+
},
|
|
39802
|
+
"/repos/{owner}/{repo}/environments/{environment_name}/deployment_protection_rules/{protection_rule_id}": {
|
|
39803
|
+
"get": {
|
|
39804
|
+
"summary": "Get a custom deployment protection rule",
|
|
39805
|
+
"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).",
|
|
39806
|
+
"tags": [
|
|
39807
|
+
"repos"
|
|
39808
|
+
],
|
|
39809
|
+
"operationId": "repos/get-custom-deployment-protection-rule",
|
|
39810
|
+
"externalDocs": {
|
|
39811
|
+
"description": "API method documentation",
|
|
39812
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#get-a-deployment-protection-rule"
|
|
39813
|
+
},
|
|
39814
|
+
"parameters": [
|
|
39815
|
+
{
|
|
39816
|
+
"$ref": "#/components/parameters/owner"
|
|
39817
|
+
},
|
|
39818
|
+
{
|
|
39819
|
+
"$ref": "#/components/parameters/repo"
|
|
39820
|
+
},
|
|
39821
|
+
{
|
|
39822
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39823
|
+
},
|
|
39824
|
+
{
|
|
39825
|
+
"$ref": "#/components/parameters/protection-rule-id"
|
|
39826
|
+
}
|
|
39827
|
+
],
|
|
39828
|
+
"responses": {
|
|
39829
|
+
"200": {
|
|
39830
|
+
"description": "Response",
|
|
39831
|
+
"content": {
|
|
39832
|
+
"application/json": {
|
|
39833
|
+
"schema": {
|
|
39834
|
+
"$ref": "#/components/schemas/deployment-protection-rule"
|
|
39835
|
+
},
|
|
39836
|
+
"examples": {
|
|
39837
|
+
"default": {
|
|
39838
|
+
"$ref": "#/components/examples/deployment-protection-rule"
|
|
39839
|
+
}
|
|
39840
|
+
}
|
|
39841
|
+
}
|
|
39842
|
+
}
|
|
39843
|
+
}
|
|
39844
|
+
},
|
|
39845
|
+
"x-github": {
|
|
39846
|
+
"githubCloudOnly": false,
|
|
39847
|
+
"enabledForGitHubApps": true,
|
|
39848
|
+
"category": "deployments",
|
|
39849
|
+
"subcategory": "protection-rules"
|
|
39850
|
+
},
|
|
39851
|
+
"x-octokit": {}
|
|
39852
|
+
},
|
|
39853
|
+
"delete": {
|
|
39854
|
+
"summary": "Disable a custom protection rule for an environment",
|
|
39855
|
+
"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)\".",
|
|
39856
|
+
"tags": [
|
|
39857
|
+
"repos"
|
|
39858
|
+
],
|
|
39859
|
+
"operationId": "repos/disable-deployment-protection-rule",
|
|
39860
|
+
"externalDocs": {
|
|
39861
|
+
"description": "API method documentation",
|
|
39862
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/deployments/protection-rules#disable-deployment-protection-rule"
|
|
39863
|
+
},
|
|
39864
|
+
"parameters": [
|
|
39865
|
+
{
|
|
39866
|
+
"$ref": "#/components/parameters/environment-name"
|
|
39867
|
+
},
|
|
39868
|
+
{
|
|
39869
|
+
"$ref": "#/components/parameters/repo"
|
|
39870
|
+
},
|
|
39871
|
+
{
|
|
39872
|
+
"$ref": "#/components/parameters/owner"
|
|
39873
|
+
},
|
|
39874
|
+
{
|
|
39875
|
+
"$ref": "#/components/parameters/protection-rule-id"
|
|
39876
|
+
}
|
|
39877
|
+
],
|
|
39878
|
+
"responses": {
|
|
39879
|
+
"204": {
|
|
39880
|
+
"description": "Response"
|
|
39881
|
+
}
|
|
39882
|
+
},
|
|
39883
|
+
"x-github": {
|
|
39884
|
+
"githubCloudOnly": false,
|
|
39885
|
+
"enabledForGitHubApps": true,
|
|
39886
|
+
"category": "deployments",
|
|
39887
|
+
"subcategory": "protection-rules"
|
|
39888
|
+
},
|
|
39889
|
+
"x-octokit": {}
|
|
39890
|
+
}
|
|
39891
|
+
},
|
|
39544
39892
|
"/repos/{owner}/{repo}/events": {
|
|
39545
39893
|
"get": {
|
|
39546
39894
|
"summary": "List repository events",
|
|
39547
|
-
"description": "",
|
|
39895
|
+
"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
39896
|
"tags": [
|
|
39549
39897
|
"activity"
|
|
39550
39898
|
],
|
|
@@ -41700,7 +42048,7 @@
|
|
|
41700
42048
|
"/repos/{owner}/{repo}/import": {
|
|
41701
42049
|
"get": {
|
|
41702
42050
|
"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.",
|
|
42051
|
+
"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
42052
|
"tags": [
|
|
41705
42053
|
"migrations"
|
|
41706
42054
|
],
|
|
@@ -41750,7 +42098,7 @@
|
|
|
41750
42098
|
},
|
|
41751
42099
|
"put": {
|
|
41752
42100
|
"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.",
|
|
42101
|
+
"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
42102
|
"tags": [
|
|
41755
42103
|
"migrations"
|
|
41756
42104
|
],
|
|
@@ -41862,7 +42210,7 @@
|
|
|
41862
42210
|
},
|
|
41863
42211
|
"patch": {
|
|
41864
42212
|
"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.",
|
|
42213
|
+
"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
42214
|
"tags": [
|
|
41867
42215
|
"migrations"
|
|
41868
42216
|
],
|
|
@@ -41972,7 +42320,7 @@
|
|
|
41972
42320
|
},
|
|
41973
42321
|
"delete": {
|
|
41974
42322
|
"summary": "Cancel an import",
|
|
41975
|
-
"description": "Stop an import for a repository.",
|
|
42323
|
+
"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
42324
|
"tags": [
|
|
41977
42325
|
"migrations"
|
|
41978
42326
|
],
|
|
@@ -42009,7 +42357,7 @@
|
|
|
42009
42357
|
"/repos/{owner}/{repo}/import/authors": {
|
|
42010
42358
|
"get": {
|
|
42011
42359
|
"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.",
|
|
42360
|
+
"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
42361
|
"tags": [
|
|
42014
42362
|
"migrations"
|
|
42015
42363
|
],
|
|
@@ -42067,7 +42415,7 @@
|
|
|
42067
42415
|
"/repos/{owner}/{repo}/import/authors/{author_id}": {
|
|
42068
42416
|
"patch": {
|
|
42069
42417
|
"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
|
|
42418
|
+
"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
42419
|
"tags": [
|
|
42072
42420
|
"migrations"
|
|
42073
42421
|
],
|
|
@@ -42159,7 +42507,7 @@
|
|
|
42159
42507
|
"/repos/{owner}/{repo}/import/large_files": {
|
|
42160
42508
|
"get": {
|
|
42161
42509
|
"summary": "Get large files",
|
|
42162
|
-
"description": "List files larger than 100MB found during the import",
|
|
42510
|
+
"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
42511
|
"tags": [
|
|
42164
42512
|
"migrations"
|
|
42165
42513
|
],
|
|
@@ -42211,7 +42559,7 @@
|
|
|
42211
42559
|
"/repos/{owner}/{repo}/import/lfs": {
|
|
42212
42560
|
"patch": {
|
|
42213
42561
|
"summary": "Update Git LFS preference",
|
|
42214
|
-
"description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability
|
|
42562
|
+
"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
42563
|
"tags": [
|
|
42216
42564
|
"migrations"
|
|
42217
42565
|
],
|
|
@@ -48448,7 +48796,7 @@
|
|
|
48448
48796
|
"nullable": true,
|
|
48449
48797
|
"properties": {
|
|
48450
48798
|
"location": {
|
|
48451
|
-
"description": "
|
|
48799
|
+
"description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
|
|
48452
48800
|
"type": "string"
|
|
48453
48801
|
},
|
|
48454
48802
|
"client_ip": {
|
|
@@ -51666,10 +52014,9 @@
|
|
|
51666
52014
|
"examples": {
|
|
51667
52015
|
"default": {
|
|
51668
52016
|
"value": {
|
|
51669
|
-
"id": 42,
|
|
51670
52017
|
"name": "super cool ruleset",
|
|
51671
52018
|
"target": "branch",
|
|
51672
|
-
"enforcement": "
|
|
52019
|
+
"enforcement": "active",
|
|
51673
52020
|
"bypass_mode": "repository",
|
|
51674
52021
|
"bypass_actors": [
|
|
51675
52022
|
{
|
|
@@ -51886,10 +52233,9 @@
|
|
|
51886
52233
|
"examples": {
|
|
51887
52234
|
"default": {
|
|
51888
52235
|
"value": {
|
|
51889
|
-
"id": 42,
|
|
51890
52236
|
"name": "super cool ruleset",
|
|
51891
52237
|
"target": "branch",
|
|
51892
|
-
"enforcement": "
|
|
52238
|
+
"enforcement": "active",
|
|
51893
52239
|
"bypass_mode": "repository",
|
|
51894
52240
|
"bypass_actors": [
|
|
51895
52241
|
{
|
|
@@ -52550,6 +52896,96 @@
|
|
|
52550
52896
|
"x-octokit": {}
|
|
52551
52897
|
}
|
|
52552
52898
|
},
|
|
52899
|
+
"/repos/{owner}/{repo}/security-advisories/reports": {
|
|
52900
|
+
"post": {
|
|
52901
|
+
"summary": "Privately report a security vulnerability",
|
|
52902
|
+
"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.",
|
|
52903
|
+
"tags": [
|
|
52904
|
+
"security-advisories"
|
|
52905
|
+
],
|
|
52906
|
+
"operationId": "security-advisories/create-private-vulnerability-report",
|
|
52907
|
+
"externalDocs": {
|
|
52908
|
+
"description": "API method documentation",
|
|
52909
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability"
|
|
52910
|
+
},
|
|
52911
|
+
"parameters": [
|
|
52912
|
+
{
|
|
52913
|
+
"$ref": "#/components/parameters/owner"
|
|
52914
|
+
},
|
|
52915
|
+
{
|
|
52916
|
+
"$ref": "#/components/parameters/repo"
|
|
52917
|
+
}
|
|
52918
|
+
],
|
|
52919
|
+
"requestBody": {
|
|
52920
|
+
"required": true,
|
|
52921
|
+
"content": {
|
|
52922
|
+
"application/json": {
|
|
52923
|
+
"schema": {
|
|
52924
|
+
"$ref": "#/components/schemas/private-vulnerability-report-create"
|
|
52925
|
+
},
|
|
52926
|
+
"examples": {
|
|
52927
|
+
"default": {
|
|
52928
|
+
"value": {
|
|
52929
|
+
"summary": "A newly discovered vulnerability",
|
|
52930
|
+
"description": "A more in-depth description of what the problem is.",
|
|
52931
|
+
"severity": "high",
|
|
52932
|
+
"vulnerabilities": [
|
|
52933
|
+
{
|
|
52934
|
+
"package": {
|
|
52935
|
+
"name": "a-package",
|
|
52936
|
+
"ecosystem": "npm"
|
|
52937
|
+
},
|
|
52938
|
+
"vulnerable_version_range": "< 1.0.0",
|
|
52939
|
+
"patched_versions": "1.0.0",
|
|
52940
|
+
"vulnerable_functions": [
|
|
52941
|
+
"important_function"
|
|
52942
|
+
]
|
|
52943
|
+
}
|
|
52944
|
+
],
|
|
52945
|
+
"cwe_ids": [
|
|
52946
|
+
"CWE-123"
|
|
52947
|
+
]
|
|
52948
|
+
}
|
|
52949
|
+
}
|
|
52950
|
+
}
|
|
52951
|
+
}
|
|
52952
|
+
}
|
|
52953
|
+
},
|
|
52954
|
+
"responses": {
|
|
52955
|
+
"201": {
|
|
52956
|
+
"description": "Response",
|
|
52957
|
+
"content": {
|
|
52958
|
+
"application/json": {
|
|
52959
|
+
"schema": {
|
|
52960
|
+
"$ref": "#/components/schemas/repository-advisory"
|
|
52961
|
+
},
|
|
52962
|
+
"examples": {
|
|
52963
|
+
"default": {
|
|
52964
|
+
"$ref": "#/components/examples/repository-advisory-pvr"
|
|
52965
|
+
}
|
|
52966
|
+
}
|
|
52967
|
+
}
|
|
52968
|
+
}
|
|
52969
|
+
},
|
|
52970
|
+
"403": {
|
|
52971
|
+
"$ref": "#/components/responses/forbidden"
|
|
52972
|
+
},
|
|
52973
|
+
"404": {
|
|
52974
|
+
"$ref": "#/components/responses/not_found"
|
|
52975
|
+
},
|
|
52976
|
+
"422": {
|
|
52977
|
+
"$ref": "#/components/responses/validation_failed"
|
|
52978
|
+
}
|
|
52979
|
+
},
|
|
52980
|
+
"x-github": {
|
|
52981
|
+
"githubCloudOnly": false,
|
|
52982
|
+
"enabledForGitHubApps": true,
|
|
52983
|
+
"category": "security-advisories",
|
|
52984
|
+
"subcategory": "repository-advisories"
|
|
52985
|
+
},
|
|
52986
|
+
"x-octokit": {}
|
|
52987
|
+
}
|
|
52988
|
+
},
|
|
52553
52989
|
"/repos/{owner}/{repo}/security-advisories/{ghsa_id}": {
|
|
52554
52990
|
"get": {
|
|
52555
52991
|
"summary": "Get a repository security advisory",
|
|
@@ -55867,7 +56303,7 @@
|
|
|
55867
56303
|
"/search/code": {
|
|
55868
56304
|
"get": {
|
|
55869
56305
|
"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\
|
|
56306
|
+
"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
56307
|
"tags": [
|
|
55872
56308
|
"search"
|
|
55873
56309
|
],
|
|
@@ -55889,7 +56325,7 @@
|
|
|
55889
56325
|
{
|
|
55890
56326
|
"name": "sort",
|
|
55891
56327
|
"deprecated": true,
|
|
55892
|
-
"description": "**
|
|
56328
|
+
"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
56329
|
"in": "query",
|
|
55894
56330
|
"required": false,
|
|
55895
56331
|
"schema": {
|
|
@@ -55901,7 +56337,7 @@
|
|
|
55901
56337
|
},
|
|
55902
56338
|
{
|
|
55903
56339
|
"name": "order",
|
|
55904
|
-
"description": "**
|
|
56340
|
+
"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
56341
|
"in": "query",
|
|
55906
56342
|
"deprecated": true,
|
|
55907
56343
|
"required": false,
|
|
@@ -59394,7 +59830,7 @@
|
|
|
59394
59830
|
"type": "string"
|
|
59395
59831
|
},
|
|
59396
59832
|
"location": {
|
|
59397
|
-
"description": "
|
|
59833
|
+
"description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
|
|
59398
59834
|
"type": "string"
|
|
59399
59835
|
},
|
|
59400
59836
|
"client_ip": {
|
|
@@ -59456,7 +59892,7 @@
|
|
|
59456
59892
|
}
|
|
59457
59893
|
},
|
|
59458
59894
|
"location": {
|
|
59459
|
-
"description": "
|
|
59895
|
+
"description": "The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.",
|
|
59460
59896
|
"type": "string"
|
|
59461
59897
|
},
|
|
59462
59898
|
"machine": {
|
|
@@ -69452,7 +69888,100 @@
|
|
|
69452
69888
|
"content": {
|
|
69453
69889
|
"application/json": {
|
|
69454
69890
|
"schema": {
|
|
69455
|
-
"$ref": "#/components/schemas/webhook-dependabot-alert-created"
|
|
69891
|
+
"$ref": "#/components/schemas/webhook-dependabot-alert-created"
|
|
69892
|
+
}
|
|
69893
|
+
}
|
|
69894
|
+
}
|
|
69895
|
+
},
|
|
69896
|
+
"responses": {
|
|
69897
|
+
"200": {
|
|
69898
|
+
"description": "Return a 200 status to indicate that the data was received successfully"
|
|
69899
|
+
}
|
|
69900
|
+
},
|
|
69901
|
+
"x-github": {
|
|
69902
|
+
"githubCloudOnly": false,
|
|
69903
|
+
"category": "webhooks",
|
|
69904
|
+
"subcategory": "dependabot-alert",
|
|
69905
|
+
"supported-webhook-types": [
|
|
69906
|
+
"repository",
|
|
69907
|
+
"organization",
|
|
69908
|
+
"app"
|
|
69909
|
+
]
|
|
69910
|
+
}
|
|
69911
|
+
}
|
|
69912
|
+
},
|
|
69913
|
+
"dependabot-alert-dismissed": {
|
|
69914
|
+
"post": {
|
|
69915
|
+
"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.",
|
|
69916
|
+
"description": "A Dependabot alert was manually closed.",
|
|
69917
|
+
"operationId": "dependabot-alert/dismissed",
|
|
69918
|
+
"externalDocs": {
|
|
69919
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
|
|
69920
|
+
},
|
|
69921
|
+
"parameters": [
|
|
69922
|
+
{
|
|
69923
|
+
"name": "User-Agent",
|
|
69924
|
+
"in": "header",
|
|
69925
|
+
"example": "GitHub-Hookshot/123abc",
|
|
69926
|
+
"schema": {
|
|
69927
|
+
"type": "string"
|
|
69928
|
+
}
|
|
69929
|
+
},
|
|
69930
|
+
{
|
|
69931
|
+
"name": "X-Github-Hook-Id",
|
|
69932
|
+
"in": "header",
|
|
69933
|
+
"example": 12312312,
|
|
69934
|
+
"schema": {
|
|
69935
|
+
"type": "string"
|
|
69936
|
+
}
|
|
69937
|
+
},
|
|
69938
|
+
{
|
|
69939
|
+
"name": "X-Github-Event",
|
|
69940
|
+
"in": "header",
|
|
69941
|
+
"example": "issues",
|
|
69942
|
+
"schema": {
|
|
69943
|
+
"type": "string"
|
|
69944
|
+
}
|
|
69945
|
+
},
|
|
69946
|
+
{
|
|
69947
|
+
"name": "X-Github-Hook-Installation-Target-Id",
|
|
69948
|
+
"in": "header",
|
|
69949
|
+
"example": 123123,
|
|
69950
|
+
"schema": {
|
|
69951
|
+
"type": "string"
|
|
69952
|
+
}
|
|
69953
|
+
},
|
|
69954
|
+
{
|
|
69955
|
+
"name": "X-Github-Hook-Installation-Target-Type",
|
|
69956
|
+
"in": "header",
|
|
69957
|
+
"example": "repository",
|
|
69958
|
+
"schema": {
|
|
69959
|
+
"type": "string"
|
|
69960
|
+
}
|
|
69961
|
+
},
|
|
69962
|
+
{
|
|
69963
|
+
"name": "X-GitHub-Delivery",
|
|
69964
|
+
"in": "header",
|
|
69965
|
+
"example": "0b989ba4-242f-11e5-81e1-c7b6966d2516",
|
|
69966
|
+
"schema": {
|
|
69967
|
+
"type": "string"
|
|
69968
|
+
}
|
|
69969
|
+
},
|
|
69970
|
+
{
|
|
69971
|
+
"name": "X-Hub-Signature-256",
|
|
69972
|
+
"in": "header",
|
|
69973
|
+
"example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e",
|
|
69974
|
+
"schema": {
|
|
69975
|
+
"type": "string"
|
|
69976
|
+
}
|
|
69977
|
+
}
|
|
69978
|
+
],
|
|
69979
|
+
"requestBody": {
|
|
69980
|
+
"required": true,
|
|
69981
|
+
"content": {
|
|
69982
|
+
"application/json": {
|
|
69983
|
+
"schema": {
|
|
69984
|
+
"$ref": "#/components/schemas/webhook-dependabot-alert-dismissed"
|
|
69456
69985
|
}
|
|
69457
69986
|
}
|
|
69458
69987
|
}
|
|
@@ -69474,11 +70003,11 @@
|
|
|
69474
70003
|
}
|
|
69475
70004
|
}
|
|
69476
70005
|
},
|
|
69477
|
-
"dependabot-alert-
|
|
70006
|
+
"dependabot-alert-fixed": {
|
|
69478
70007
|
"post": {
|
|
69479
70008
|
"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/
|
|
70009
|
+
"description": "A manifest file change removed a vulnerability.",
|
|
70010
|
+
"operationId": "dependabot-alert/fixed",
|
|
69482
70011
|
"externalDocs": {
|
|
69483
70012
|
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
|
|
69484
70013
|
},
|
|
@@ -69545,7 +70074,7 @@
|
|
|
69545
70074
|
"content": {
|
|
69546
70075
|
"application/json": {
|
|
69547
70076
|
"schema": {
|
|
69548
|
-
"$ref": "#/components/schemas/webhook-dependabot-alert-
|
|
70077
|
+
"$ref": "#/components/schemas/webhook-dependabot-alert-fixed"
|
|
69549
70078
|
}
|
|
69550
70079
|
}
|
|
69551
70080
|
}
|
|
@@ -69567,11 +70096,11 @@
|
|
|
69567
70096
|
}
|
|
69568
70097
|
}
|
|
69569
70098
|
},
|
|
69570
|
-
"dependabot-alert-
|
|
70099
|
+
"dependabot-alert-reintroduced": {
|
|
69571
70100
|
"post": {
|
|
69572
70101
|
"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/
|
|
70102
|
+
"description": "A manifest file change introduced a vulnerable dependency that had previously been fixed.",
|
|
70103
|
+
"operationId": "dependabot-alert/reintroduced",
|
|
69575
70104
|
"externalDocs": {
|
|
69576
70105
|
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
|
|
69577
70106
|
},
|
|
@@ -69638,7 +70167,7 @@
|
|
|
69638
70167
|
"content": {
|
|
69639
70168
|
"application/json": {
|
|
69640
70169
|
"schema": {
|
|
69641
|
-
"$ref": "#/components/schemas/webhook-dependabot-alert-
|
|
70170
|
+
"$ref": "#/components/schemas/webhook-dependabot-alert-reintroduced"
|
|
69642
70171
|
}
|
|
69643
70172
|
}
|
|
69644
70173
|
}
|
|
@@ -69660,11 +70189,11 @@
|
|
|
69660
70189
|
}
|
|
69661
70190
|
}
|
|
69662
70191
|
},
|
|
69663
|
-
"dependabot-alert-
|
|
70192
|
+
"dependabot-alert-reopened": {
|
|
69664
70193
|
"post": {
|
|
69665
70194
|
"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/
|
|
70195
|
+
"description": "A Dependabot alert was manually reopened.",
|
|
70196
|
+
"operationId": "dependabot-alert/reopened",
|
|
69668
70197
|
"externalDocs": {
|
|
69669
70198
|
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#dependabot-alert"
|
|
69670
70199
|
},
|
|
@@ -69731,7 +70260,7 @@
|
|
|
69731
70260
|
"content": {
|
|
69732
70261
|
"application/json": {
|
|
69733
70262
|
"schema": {
|
|
69734
|
-
"$ref": "#/components/schemas/webhook-dependabot-alert-
|
|
70263
|
+
"$ref": "#/components/schemas/webhook-dependabot-alert-reopened"
|
|
69735
70264
|
}
|
|
69736
70265
|
}
|
|
69737
70266
|
}
|
|
@@ -69753,13 +70282,13 @@
|
|
|
69753
70282
|
}
|
|
69754
70283
|
}
|
|
69755
70284
|
},
|
|
69756
|
-
"
|
|
70285
|
+
"deploy-key-created": {
|
|
69757
70286
|
"post": {
|
|
69758
|
-
"summary": "This event occurs when there is activity relating to
|
|
69759
|
-
"description": "A
|
|
69760
|
-
"operationId": "
|
|
70287
|
+
"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.",
|
|
70288
|
+
"description": "A deploy key was created.",
|
|
70289
|
+
"operationId": "deploy-key/created",
|
|
69761
70290
|
"externalDocs": {
|
|
69762
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#
|
|
70291
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key"
|
|
69763
70292
|
},
|
|
69764
70293
|
"parameters": [
|
|
69765
70294
|
{
|
|
@@ -69824,7 +70353,7 @@
|
|
|
69824
70353
|
"content": {
|
|
69825
70354
|
"application/json": {
|
|
69826
70355
|
"schema": {
|
|
69827
|
-
"$ref": "#/components/schemas/webhook-
|
|
70356
|
+
"$ref": "#/components/schemas/webhook-deploy-key-created"
|
|
69828
70357
|
}
|
|
69829
70358
|
}
|
|
69830
70359
|
}
|
|
@@ -69837,7 +70366,7 @@
|
|
|
69837
70366
|
"x-github": {
|
|
69838
70367
|
"githubCloudOnly": false,
|
|
69839
70368
|
"category": "webhooks",
|
|
69840
|
-
"subcategory": "
|
|
70369
|
+
"subcategory": "deploy-key",
|
|
69841
70370
|
"supported-webhook-types": [
|
|
69842
70371
|
"repository",
|
|
69843
70372
|
"organization",
|
|
@@ -69846,11 +70375,11 @@
|
|
|
69846
70375
|
}
|
|
69847
70376
|
}
|
|
69848
70377
|
},
|
|
69849
|
-
"deploy-key-
|
|
70378
|
+
"deploy-key-deleted": {
|
|
69850
70379
|
"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/
|
|
70380
|
+
"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.",
|
|
70381
|
+
"description": "A deploy key was deleted.",
|
|
70382
|
+
"operationId": "deploy-key/deleted",
|
|
69854
70383
|
"externalDocs": {
|
|
69855
70384
|
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deploy-key"
|
|
69856
70385
|
},
|
|
@@ -69917,7 +70446,7 @@
|
|
|
69917
70446
|
"content": {
|
|
69918
70447
|
"application/json": {
|
|
69919
70448
|
"schema": {
|
|
69920
|
-
"$ref": "#/components/schemas/webhook-deploy-key-
|
|
70449
|
+
"$ref": "#/components/schemas/webhook-deploy-key-deleted"
|
|
69921
70450
|
}
|
|
69922
70451
|
}
|
|
69923
70452
|
}
|
|
@@ -69939,13 +70468,13 @@
|
|
|
69939
70468
|
}
|
|
69940
70469
|
}
|
|
69941
70470
|
},
|
|
69942
|
-
"
|
|
70471
|
+
"deployment-created": {
|
|
69943
70472
|
"post": {
|
|
69944
|
-
"summary": "This event occurs when there is activity relating to
|
|
69945
|
-
"description": "A
|
|
69946
|
-
"operationId": "
|
|
70473
|
+
"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.",
|
|
70474
|
+
"description": "A deployment was created.",
|
|
70475
|
+
"operationId": "deployment/created",
|
|
69947
70476
|
"externalDocs": {
|
|
69948
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#
|
|
70477
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment"
|
|
69949
70478
|
},
|
|
69950
70479
|
"parameters": [
|
|
69951
70480
|
{
|
|
@@ -70010,7 +70539,7 @@
|
|
|
70010
70539
|
"content": {
|
|
70011
70540
|
"application/json": {
|
|
70012
70541
|
"schema": {
|
|
70013
|
-
"$ref": "#/components/schemas/webhook-
|
|
70542
|
+
"$ref": "#/components/schemas/webhook-deployment-created"
|
|
70014
70543
|
}
|
|
70015
70544
|
}
|
|
70016
70545
|
}
|
|
@@ -70023,7 +70552,7 @@
|
|
|
70023
70552
|
"x-github": {
|
|
70024
70553
|
"githubCloudOnly": false,
|
|
70025
70554
|
"category": "webhooks",
|
|
70026
|
-
"subcategory": "
|
|
70555
|
+
"subcategory": "deployment",
|
|
70027
70556
|
"supported-webhook-types": [
|
|
70028
70557
|
"repository",
|
|
70029
70558
|
"organization",
|
|
@@ -70032,13 +70561,13 @@
|
|
|
70032
70561
|
}
|
|
70033
70562
|
}
|
|
70034
70563
|
},
|
|
70035
|
-
"deployment-
|
|
70564
|
+
"deployment-protection-rule-requested": {
|
|
70036
70565
|
"post": {
|
|
70037
|
-
"summary": "This event occurs when there is activity relating to
|
|
70038
|
-
"description": "A deployment was
|
|
70039
|
-
"operationId": "deployment/
|
|
70566
|
+
"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.",
|
|
70567
|
+
"description": "A deployment protection rule was requested for an environment.",
|
|
70568
|
+
"operationId": "deployment-protection-rule/requested",
|
|
70040
70569
|
"externalDocs": {
|
|
70041
|
-
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#
|
|
70570
|
+
"url": "https://docs.github.com/enterprise-cloud@latest//developers/webhooks-and-events/webhooks/webhook-events-and-payloads#deployment_protection_rule"
|
|
70042
70571
|
},
|
|
70043
70572
|
"parameters": [
|
|
70044
70573
|
{
|
|
@@ -70103,7 +70632,7 @@
|
|
|
70103
70632
|
"content": {
|
|
70104
70633
|
"application/json": {
|
|
70105
70634
|
"schema": {
|
|
70106
|
-
"$ref": "#/components/schemas/webhook-deployment-
|
|
70635
|
+
"$ref": "#/components/schemas/webhook-deployment-protection-rule-requested"
|
|
70107
70636
|
}
|
|
70108
70637
|
}
|
|
70109
70638
|
}
|
|
@@ -70116,10 +70645,8 @@
|
|
|
70116
70645
|
"x-github": {
|
|
70117
70646
|
"githubCloudOnly": false,
|
|
70118
70647
|
"category": "webhooks",
|
|
70119
|
-
"subcategory": "deployment",
|
|
70648
|
+
"subcategory": "deployment-protection-rule",
|
|
70120
70649
|
"supported-webhook-types": [
|
|
70121
|
-
"repository",
|
|
70122
|
-
"organization",
|
|
70123
70650
|
"app"
|
|
70124
70651
|
]
|
|
70125
70652
|
}
|
|
@@ -97324,7 +97851,7 @@
|
|
|
97324
97851
|
}
|
|
97325
97852
|
},
|
|
97326
97853
|
"location": {
|
|
97327
|
-
"description": "The
|
|
97854
|
+
"description": "The initally assigned location of a new codespace.",
|
|
97328
97855
|
"enum": [
|
|
97329
97856
|
"EastUs",
|
|
97330
97857
|
"SouthEastAsia",
|
|
@@ -104076,6 +104603,48 @@
|
|
|
104076
104603
|
"comment"
|
|
104077
104604
|
]
|
|
104078
104605
|
},
|
|
104606
|
+
"review-custom-gates-comment-required": {
|
|
104607
|
+
"type": "object",
|
|
104608
|
+
"properties": {
|
|
104609
|
+
"environment_name": {
|
|
104610
|
+
"type": "string",
|
|
104611
|
+
"description": "The name of the environment to approve or reject."
|
|
104612
|
+
},
|
|
104613
|
+
"comment": {
|
|
104614
|
+
"type": "string",
|
|
104615
|
+
"description": "Comment associated with the pending deployment protection rule. **Required when state is not provided.**"
|
|
104616
|
+
}
|
|
104617
|
+
},
|
|
104618
|
+
"required": [
|
|
104619
|
+
"environment_name",
|
|
104620
|
+
"comment"
|
|
104621
|
+
]
|
|
104622
|
+
},
|
|
104623
|
+
"review-custom-gates-state-required": {
|
|
104624
|
+
"type": "object",
|
|
104625
|
+
"properties": {
|
|
104626
|
+
"environment_name": {
|
|
104627
|
+
"type": "string",
|
|
104628
|
+
"description": "The name of the environment to approve or reject."
|
|
104629
|
+
},
|
|
104630
|
+
"state": {
|
|
104631
|
+
"type": "string",
|
|
104632
|
+
"description": "Whether to approve or reject deployment to the specified environments.",
|
|
104633
|
+
"enum": [
|
|
104634
|
+
"approved",
|
|
104635
|
+
"rejected"
|
|
104636
|
+
]
|
|
104637
|
+
},
|
|
104638
|
+
"comment": {
|
|
104639
|
+
"type": "string",
|
|
104640
|
+
"description": "Optional comment to include with the review."
|
|
104641
|
+
}
|
|
104642
|
+
},
|
|
104643
|
+
"required": [
|
|
104644
|
+
"environment_name",
|
|
104645
|
+
"state"
|
|
104646
|
+
]
|
|
104647
|
+
},
|
|
104079
104648
|
"deployment-reviewer-type": {
|
|
104080
104649
|
"type": "string",
|
|
104081
104650
|
"description": "The type of reviewer.",
|
|
@@ -106609,8 +107178,13 @@
|
|
|
106609
107178
|
"items": {
|
|
106610
107179
|
"type": "string",
|
|
106611
107180
|
"enum": [
|
|
107181
|
+
"c",
|
|
107182
|
+
"cpp",
|
|
107183
|
+
"csharp",
|
|
106612
107184
|
"go",
|
|
107185
|
+
"java",
|
|
106613
107186
|
"javascript",
|
|
107187
|
+
"kotlin",
|
|
106614
107188
|
"python",
|
|
106615
107189
|
"ruby",
|
|
106616
107190
|
"typescript"
|
|
@@ -109750,6 +110324,70 @@
|
|
|
109750
110324
|
"name"
|
|
109751
110325
|
]
|
|
109752
110326
|
},
|
|
110327
|
+
"custom-deployment-rule-app": {
|
|
110328
|
+
"title": "Custom deployment protection rule app",
|
|
110329
|
+
"description": "A GitHub App that is providing a custom deployment protection rule.",
|
|
110330
|
+
"type": "object",
|
|
110331
|
+
"properties": {
|
|
110332
|
+
"id": {
|
|
110333
|
+
"type": "integer",
|
|
110334
|
+
"example": 3515,
|
|
110335
|
+
"description": "The unique identifier of the deployment protection rule integration."
|
|
110336
|
+
},
|
|
110337
|
+
"slug": {
|
|
110338
|
+
"type": "string",
|
|
110339
|
+
"example": "my-custom-app",
|
|
110340
|
+
"description": "The slugified name of the deployment protection rule integration."
|
|
110341
|
+
},
|
|
110342
|
+
"integration_url": {
|
|
110343
|
+
"type": "string",
|
|
110344
|
+
"example": "https://api.github.com/apps/custom-app-slug",
|
|
110345
|
+
"description": "The URL for the endpoint to get details about the app."
|
|
110346
|
+
},
|
|
110347
|
+
"node_id": {
|
|
110348
|
+
"type": "string",
|
|
110349
|
+
"example": "MDQ6R2F0ZTM1MTU=",
|
|
110350
|
+
"description": "The node ID for the deployment protection rule integration."
|
|
110351
|
+
}
|
|
110352
|
+
},
|
|
110353
|
+
"required": [
|
|
110354
|
+
"id",
|
|
110355
|
+
"slug",
|
|
110356
|
+
"integration_url",
|
|
110357
|
+
"node_id"
|
|
110358
|
+
]
|
|
110359
|
+
},
|
|
110360
|
+
"deployment-protection-rule": {
|
|
110361
|
+
"title": "Deployment protection rule",
|
|
110362
|
+
"description": "Deployment protection rule",
|
|
110363
|
+
"type": "object",
|
|
110364
|
+
"properties": {
|
|
110365
|
+
"id": {
|
|
110366
|
+
"type": "integer",
|
|
110367
|
+
"example": 3515,
|
|
110368
|
+
"description": "The unique identifier for the deployment protection rule."
|
|
110369
|
+
},
|
|
110370
|
+
"node_id": {
|
|
110371
|
+
"type": "string",
|
|
110372
|
+
"example": "MDQ6R2F0ZTM1MTU=",
|
|
110373
|
+
"description": "The node ID for the deployment protection rule."
|
|
110374
|
+
},
|
|
110375
|
+
"enabled": {
|
|
110376
|
+
"type": "boolean",
|
|
110377
|
+
"example": true,
|
|
110378
|
+
"description": "Whether the deployment protection rule is enabled for the environment."
|
|
110379
|
+
},
|
|
110380
|
+
"app": {
|
|
110381
|
+
"$ref": "#/components/schemas/custom-deployment-rule-app"
|
|
110382
|
+
}
|
|
110383
|
+
},
|
|
110384
|
+
"required": [
|
|
110385
|
+
"id",
|
|
110386
|
+
"node_id",
|
|
110387
|
+
"enabled",
|
|
110388
|
+
"app"
|
|
110389
|
+
]
|
|
110390
|
+
},
|
|
109753
110391
|
"short-blob": {
|
|
109754
110392
|
"title": "Short Blob",
|
|
109755
110393
|
"description": "Short Blob",
|
|
@@ -116400,28 +117038,122 @@
|
|
|
116400
117038
|
"type": "string"
|
|
116401
117039
|
}
|
|
116402
117040
|
},
|
|
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
|
-
},
|
|
117041
|
+
"credits": {
|
|
117042
|
+
"type": "array",
|
|
117043
|
+
"description": "A list of users receiving credit for their participation in the security advisory.",
|
|
117044
|
+
"nullable": true,
|
|
117045
|
+
"items": {
|
|
117046
|
+
"type": "object",
|
|
117047
|
+
"properties": {
|
|
117048
|
+
"login": {
|
|
117049
|
+
"type": "string",
|
|
117050
|
+
"description": "The username of the user credited."
|
|
117051
|
+
},
|
|
117052
|
+
"type": {
|
|
117053
|
+
"$ref": "#/components/schemas/repository-advisory-credit-types"
|
|
117054
|
+
}
|
|
117055
|
+
},
|
|
117056
|
+
"required": [
|
|
117057
|
+
"login",
|
|
117058
|
+
"type"
|
|
117059
|
+
],
|
|
117060
|
+
"additionalProperties": false
|
|
117061
|
+
}
|
|
117062
|
+
},
|
|
117063
|
+
"severity": {
|
|
117064
|
+
"type": "string",
|
|
117065
|
+
"description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.",
|
|
117066
|
+
"nullable": true,
|
|
117067
|
+
"enum": [
|
|
117068
|
+
"critical",
|
|
117069
|
+
"high",
|
|
117070
|
+
"medium",
|
|
117071
|
+
"low"
|
|
117072
|
+
]
|
|
117073
|
+
},
|
|
117074
|
+
"cvss_vector_string": {
|
|
117075
|
+
"type": "string",
|
|
117076
|
+
"description": "The CVSS vector that calculates the severity of the advisory. You must choose between setting this field or `severity`.",
|
|
117077
|
+
"nullable": true
|
|
117078
|
+
}
|
|
117079
|
+
},
|
|
117080
|
+
"required": [
|
|
117081
|
+
"summary",
|
|
117082
|
+
"description",
|
|
117083
|
+
"vulnerabilities"
|
|
117084
|
+
],
|
|
117085
|
+
"additionalProperties": false
|
|
117086
|
+
},
|
|
117087
|
+
"private-vulnerability-report-create": {
|
|
117088
|
+
"type": "object",
|
|
117089
|
+
"properties": {
|
|
117090
|
+
"summary": {
|
|
117091
|
+
"type": "string",
|
|
117092
|
+
"description": "A short summary of the advisory.",
|
|
117093
|
+
"maxLength": 1024
|
|
117094
|
+
},
|
|
117095
|
+
"description": {
|
|
117096
|
+
"type": "string",
|
|
117097
|
+
"description": "A detailed description of what the advisory impacts.",
|
|
117098
|
+
"maxLength": 65535
|
|
117099
|
+
},
|
|
117100
|
+
"vulnerabilities": {
|
|
117101
|
+
"type": "array",
|
|
117102
|
+
"description": "An array of products affected by the vulnerability detailed in a repository security advisory.",
|
|
117103
|
+
"nullable": true,
|
|
117104
|
+
"items": {
|
|
117105
|
+
"type": "object",
|
|
117106
|
+
"properties": {
|
|
117107
|
+
"package": {
|
|
117108
|
+
"description": "The name of the package affected by the vulnerability.",
|
|
117109
|
+
"type": "object",
|
|
117110
|
+
"properties": {
|
|
117111
|
+
"ecosystem": {
|
|
117112
|
+
"$ref": "#/components/schemas/repository-advisory-ecosystems"
|
|
117113
|
+
},
|
|
117114
|
+
"name": {
|
|
117115
|
+
"type": "string",
|
|
117116
|
+
"description": "The unique package name within its ecosystem.",
|
|
117117
|
+
"nullable": true
|
|
117118
|
+
}
|
|
117119
|
+
},
|
|
117120
|
+
"required": [
|
|
117121
|
+
"ecosystem"
|
|
117122
|
+
]
|
|
117123
|
+
},
|
|
117124
|
+
"vulnerable_version_range": {
|
|
117125
|
+
"type": "string",
|
|
117126
|
+
"description": "The range of the package versions affected by the vulnerability.",
|
|
117127
|
+
"nullable": true
|
|
117128
|
+
},
|
|
117129
|
+
"patched_versions": {
|
|
117130
|
+
"type": "string",
|
|
117131
|
+
"description": "The package version(s) that resolve the vulnerability.",
|
|
117132
|
+
"nullable": true
|
|
117133
|
+
},
|
|
117134
|
+
"vulnerable_functions": {
|
|
117135
|
+
"type": "array",
|
|
117136
|
+
"description": "The functions in the package that are affected.",
|
|
117137
|
+
"nullable": true,
|
|
117138
|
+
"items": {
|
|
117139
|
+
"type": "string"
|
|
117140
|
+
}
|
|
117141
|
+
}
|
|
117142
|
+
},
|
|
117143
|
+
"required": [
|
|
117144
|
+
"package"
|
|
117145
|
+
],
|
|
117146
|
+
"additionalProperties": false
|
|
117147
|
+
}
|
|
117148
|
+
},
|
|
117149
|
+
"cwe_ids": {
|
|
117150
|
+
"type": "array",
|
|
117151
|
+
"description": "A list of Common Weakness Enumeration (CWE) IDs.",
|
|
117152
|
+
"nullable": true,
|
|
117153
|
+
"items": {
|
|
117154
|
+
"type": "string"
|
|
117155
|
+
}
|
|
117156
|
+
},
|
|
116425
117157
|
"severity": {
|
|
116426
117158
|
"type": "string",
|
|
116427
117159
|
"description": "The severity of the advisory. You must choose between setting this field or `cvss_vector_string`.",
|
|
@@ -116441,8 +117173,7 @@
|
|
|
116441
117173
|
},
|
|
116442
117174
|
"required": [
|
|
116443
117175
|
"summary",
|
|
116444
|
-
"description"
|
|
116445
|
-
"vulnerabilities"
|
|
117176
|
+
"description"
|
|
116446
117177
|
],
|
|
116447
117178
|
"additionalProperties": false
|
|
116448
117179
|
},
|
|
@@ -118883,7 +119614,7 @@
|
|
|
118883
119614
|
}
|
|
118884
119615
|
},
|
|
118885
119616
|
"location": {
|
|
118886
|
-
"description": "The
|
|
119617
|
+
"description": "The initally assigned location of a new codespace.",
|
|
118887
119618
|
"enum": [
|
|
118888
119619
|
"EastUs",
|
|
118889
119620
|
"SouthEastAsia",
|
|
@@ -127722,6 +128453,52 @@
|
|
|
127722
128453
|
"sender"
|
|
127723
128454
|
]
|
|
127724
128455
|
},
|
|
128456
|
+
"webhook-deployment-protection-rule-requested": {
|
|
128457
|
+
"title": "deployment protection rule requested event",
|
|
128458
|
+
"type": "object",
|
|
128459
|
+
"properties": {
|
|
128460
|
+
"action": {
|
|
128461
|
+
"type": "string",
|
|
128462
|
+
"enum": [
|
|
128463
|
+
"requested"
|
|
128464
|
+
]
|
|
128465
|
+
},
|
|
128466
|
+
"environment": {
|
|
128467
|
+
"description": "The name of the environment that has the deployment protection rule.",
|
|
128468
|
+
"type": "string"
|
|
128469
|
+
},
|
|
128470
|
+
"event": {
|
|
128471
|
+
"description": "The event that triggered the deployment protection rule.",
|
|
128472
|
+
"type": "string"
|
|
128473
|
+
},
|
|
128474
|
+
"deployment_callback_url": {
|
|
128475
|
+
"description": "The URL to review the deployment protection rule.",
|
|
128476
|
+
"type": "string",
|
|
128477
|
+
"format": "uri"
|
|
128478
|
+
},
|
|
128479
|
+
"deployment": {
|
|
128480
|
+
"$ref": "#/components/schemas/deployment"
|
|
128481
|
+
},
|
|
128482
|
+
"pull_requests": {
|
|
128483
|
+
"type": "array",
|
|
128484
|
+
"items": {
|
|
128485
|
+
"$ref": "#/components/schemas/pull-request"
|
|
128486
|
+
}
|
|
128487
|
+
},
|
|
128488
|
+
"repository": {
|
|
128489
|
+
"$ref": "#/components/schemas/repository"
|
|
128490
|
+
},
|
|
128491
|
+
"organization": {
|
|
128492
|
+
"$ref": "#/components/schemas/organization-simple"
|
|
128493
|
+
},
|
|
128494
|
+
"installation": {
|
|
128495
|
+
"$ref": "#/components/schemas/simple-installation"
|
|
128496
|
+
},
|
|
128497
|
+
"sender": {
|
|
128498
|
+
"$ref": "#/components/schemas/simple-user"
|
|
128499
|
+
}
|
|
128500
|
+
}
|
|
128501
|
+
},
|
|
127725
128502
|
"webhook-deployment-status-created": {
|
|
127726
128503
|
"title": "deployment_status created event",
|
|
127727
128504
|
"type": "object",
|
|
@@ -170580,6 +171357,56 @@
|
|
|
170580
171357
|
"sender"
|
|
170581
171358
|
]
|
|
170582
171359
|
},
|
|
171360
|
+
"webhook-rubygems-metadata": {
|
|
171361
|
+
"title": "Ruby Gems metadata",
|
|
171362
|
+
"type": "object",
|
|
171363
|
+
"properties": {
|
|
171364
|
+
"name": {
|
|
171365
|
+
"type": "string"
|
|
171366
|
+
},
|
|
171367
|
+
"description": {
|
|
171368
|
+
"type": "string"
|
|
171369
|
+
},
|
|
171370
|
+
"readme": {
|
|
171371
|
+
"type": "string"
|
|
171372
|
+
},
|
|
171373
|
+
"homepage": {
|
|
171374
|
+
"type": "string"
|
|
171375
|
+
},
|
|
171376
|
+
"version_info": {
|
|
171377
|
+
"type": "object",
|
|
171378
|
+
"properties": {
|
|
171379
|
+
"version": {
|
|
171380
|
+
"type": "string"
|
|
171381
|
+
}
|
|
171382
|
+
}
|
|
171383
|
+
},
|
|
171384
|
+
"platform": {
|
|
171385
|
+
"type": "string"
|
|
171386
|
+
},
|
|
171387
|
+
"metadata": {
|
|
171388
|
+
"type": "object",
|
|
171389
|
+
"additionalProperties": {
|
|
171390
|
+
"type": "string"
|
|
171391
|
+
}
|
|
171392
|
+
},
|
|
171393
|
+
"repo": {
|
|
171394
|
+
"type": "string"
|
|
171395
|
+
},
|
|
171396
|
+
"dependencies": {
|
|
171397
|
+
"type": "array",
|
|
171398
|
+
"items": {
|
|
171399
|
+
"type": "object",
|
|
171400
|
+
"additionalProperties": {
|
|
171401
|
+
"type": "string"
|
|
171402
|
+
}
|
|
171403
|
+
}
|
|
171404
|
+
},
|
|
171405
|
+
"commit_oid": {
|
|
171406
|
+
"type": "string"
|
|
171407
|
+
}
|
|
171408
|
+
}
|
|
171409
|
+
},
|
|
170583
171410
|
"webhook-package-published": {
|
|
170584
171411
|
"title": "package published event",
|
|
170585
171412
|
"type": "object",
|
|
@@ -170864,7 +171691,17 @@
|
|
|
170864
171691
|
},
|
|
170865
171692
|
"docker_metadata": {
|
|
170866
171693
|
"type": "array",
|
|
170867
|
-
"items": {
|
|
171694
|
+
"items": {
|
|
171695
|
+
"type": "object",
|
|
171696
|
+
"properties": {
|
|
171697
|
+
"tags": {
|
|
171698
|
+
"type": "array",
|
|
171699
|
+
"items": {
|
|
171700
|
+
"type": "string"
|
|
171701
|
+
}
|
|
171702
|
+
}
|
|
171703
|
+
}
|
|
171704
|
+
}
|
|
170868
171705
|
},
|
|
170869
171706
|
"draft": {
|
|
170870
171707
|
"type": "boolean"
|
|
@@ -171294,7 +172131,9 @@
|
|
|
171294
172131
|
},
|
|
171295
172132
|
"rubygems_metadata": {
|
|
171296
172133
|
"type": "array",
|
|
171297
|
-
"items": {
|
|
172134
|
+
"items": {
|
|
172135
|
+
"$ref": "#/components/schemas/webhook-rubygems-metadata"
|
|
172136
|
+
}
|
|
171298
172137
|
},
|
|
171299
172138
|
"source_url": {
|
|
171300
172139
|
"type": "string"
|
|
@@ -171643,7 +172482,17 @@
|
|
|
171643
172482
|
},
|
|
171644
172483
|
"docker_metadata": {
|
|
171645
172484
|
"type": "array",
|
|
171646
|
-
"items": {
|
|
172485
|
+
"items": {
|
|
172486
|
+
"type": "object",
|
|
172487
|
+
"properties": {
|
|
172488
|
+
"tags": {
|
|
172489
|
+
"type": "array",
|
|
172490
|
+
"items": {
|
|
172491
|
+
"type": "string"
|
|
172492
|
+
}
|
|
172493
|
+
}
|
|
172494
|
+
}
|
|
172495
|
+
}
|
|
171647
172496
|
},
|
|
171648
172497
|
"draft": {
|
|
171649
172498
|
"type": "boolean"
|
|
@@ -171663,7 +172512,10 @@
|
|
|
171663
172512
|
},
|
|
171664
172513
|
"metadata": {
|
|
171665
172514
|
"type": "array",
|
|
171666
|
-
"items": {
|
|
172515
|
+
"items": {
|
|
172516
|
+
"type": "object",
|
|
172517
|
+
"additionalProperties": true
|
|
172518
|
+
}
|
|
171667
172519
|
},
|
|
171668
172520
|
"name": {
|
|
171669
172521
|
"type": "string"
|
|
@@ -171875,7 +172727,9 @@
|
|
|
171875
172727
|
},
|
|
171876
172728
|
"rubygems_metadata": {
|
|
171877
172729
|
"type": "array",
|
|
171878
|
-
"items": {
|
|
172730
|
+
"items": {
|
|
172731
|
+
"$ref": "#/components/schemas/webhook-rubygems-metadata"
|
|
172732
|
+
}
|
|
171879
172733
|
},
|
|
171880
172734
|
"source_url": {
|
|
171881
172735
|
"type": "string",
|
|
@@ -252778,7 +253632,17 @@
|
|
|
252778
253632
|
},
|
|
252779
253633
|
"docker_metadata": {
|
|
252780
253634
|
"type": "array",
|
|
252781
|
-
"items": {
|
|
253635
|
+
"items": {
|
|
253636
|
+
"type": "object",
|
|
253637
|
+
"properties": {
|
|
253638
|
+
"tags": {
|
|
253639
|
+
"type": "array",
|
|
253640
|
+
"items": {
|
|
253641
|
+
"type": "string"
|
|
253642
|
+
}
|
|
253643
|
+
}
|
|
253644
|
+
}
|
|
253645
|
+
}
|
|
252782
253646
|
},
|
|
252783
253647
|
"draft": {
|
|
252784
253648
|
"type": "boolean"
|
|
@@ -253197,7 +254061,9 @@
|
|
|
253197
254061
|
},
|
|
253198
254062
|
"rubygems_metadata": {
|
|
253199
254063
|
"type": "array",
|
|
253200
|
-
"items": {
|
|
254064
|
+
"items": {
|
|
254065
|
+
"$ref": "#/components/schemas/webhook-rubygems-metadata"
|
|
254066
|
+
}
|
|
253201
254067
|
},
|
|
253202
254068
|
"summary": {
|
|
253203
254069
|
"type": "string"
|
|
@@ -253503,7 +254369,16 @@
|
|
|
253503
254369
|
"docker_metadata": {
|
|
253504
254370
|
"type": "array",
|
|
253505
254371
|
"items": {
|
|
253506
|
-
"
|
|
254372
|
+
"type": "object",
|
|
254373
|
+
"nullable": true,
|
|
254374
|
+
"properties": {
|
|
254375
|
+
"tags": {
|
|
254376
|
+
"type": "array",
|
|
254377
|
+
"items": {
|
|
254378
|
+
"type": "string"
|
|
254379
|
+
}
|
|
254380
|
+
}
|
|
254381
|
+
}
|
|
253507
254382
|
}
|
|
253508
254383
|
},
|
|
253509
254384
|
"draft": {
|
|
@@ -253523,7 +254398,10 @@
|
|
|
253523
254398
|
},
|
|
253524
254399
|
"metadata": {
|
|
253525
254400
|
"type": "array",
|
|
253526
|
-
"items": {
|
|
254401
|
+
"items": {
|
|
254402
|
+
"type": "object",
|
|
254403
|
+
"additionalProperties": true
|
|
254404
|
+
}
|
|
253527
254405
|
},
|
|
253528
254406
|
"name": {
|
|
253529
254407
|
"type": "string"
|
|
@@ -253706,7 +254584,9 @@
|
|
|
253706
254584
|
},
|
|
253707
254585
|
"rubygems_metadata": {
|
|
253708
254586
|
"type": "array",
|
|
253709
|
-
"items": {
|
|
254587
|
+
"items": {
|
|
254588
|
+
"$ref": "#/components/schemas/webhook-rubygems-metadata"
|
|
254589
|
+
}
|
|
253710
254590
|
},
|
|
253711
254591
|
"summary": {
|
|
253712
254592
|
"type": "string"
|
|
@@ -281980,7 +282860,7 @@
|
|
|
281980
282860
|
"target": "branch",
|
|
281981
282861
|
"source_type": "Organization",
|
|
281982
282862
|
"source": "my-org",
|
|
281983
|
-
"enforcement": "
|
|
282863
|
+
"enforcement": "active",
|
|
281984
282864
|
"bypass_actors": [
|
|
281985
282865
|
{
|
|
281986
282866
|
"actor_id": 234,
|
|
@@ -290908,6 +291788,42 @@
|
|
|
290908
291788
|
"name": "main"
|
|
290909
291789
|
}
|
|
290910
291790
|
},
|
|
291791
|
+
"deployment-protection-rule": {
|
|
291792
|
+
"value": {
|
|
291793
|
+
"id": 3,
|
|
291794
|
+
"node_id": "IEH37kRlcGxveW1lbnRTdGF0ddiv",
|
|
291795
|
+
"enabled": true,
|
|
291796
|
+
"app": {
|
|
291797
|
+
"id": 1,
|
|
291798
|
+
"node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
|
|
291799
|
+
"slug": "a-custom-app",
|
|
291800
|
+
"integration_url": "https://api.github.com/apps/a-custom-app"
|
|
291801
|
+
}
|
|
291802
|
+
}
|
|
291803
|
+
},
|
|
291804
|
+
"custom-deployment-protection-rule-apps": {
|
|
291805
|
+
"value": [
|
|
291806
|
+
{
|
|
291807
|
+
"total_count": 2
|
|
291808
|
+
},
|
|
291809
|
+
{
|
|
291810
|
+
"available_custom_deployment_protection_rule_integrations": [
|
|
291811
|
+
{
|
|
291812
|
+
"id": 1,
|
|
291813
|
+
"node_id": "GHT58kRlcGxveW1lbnRTdTY!bbcy",
|
|
291814
|
+
"slug": "a-custom-app",
|
|
291815
|
+
"integration_url": "https://api.github.com/apps/a-custom-app"
|
|
291816
|
+
},
|
|
291817
|
+
{
|
|
291818
|
+
"id": 2,
|
|
291819
|
+
"node_id": "UHVE67RlcGxveW1lbnRTdTY!jfeuy",
|
|
291820
|
+
"slug": "another-custom-app",
|
|
291821
|
+
"integration_url": "https://api.github.com/apps/another-custom-app"
|
|
291822
|
+
}
|
|
291823
|
+
]
|
|
291824
|
+
}
|
|
291825
|
+
]
|
|
291826
|
+
},
|
|
290911
291827
|
"repo-events-items": {
|
|
290912
291828
|
"value": [
|
|
290913
291829
|
{
|
|
@@ -295666,7 +296582,7 @@
|
|
|
295666
296582
|
"target": "branch",
|
|
295667
296583
|
"source_type": "Repository",
|
|
295668
296584
|
"source": "monalisa/my-repo",
|
|
295669
|
-
"enforcement": "
|
|
296585
|
+
"enforcement": "active",
|
|
295670
296586
|
"bypass_mode": "repository",
|
|
295671
296587
|
"bypass_actors": [
|
|
295672
296588
|
{
|
|
@@ -296284,6 +297200,112 @@
|
|
|
296284
297200
|
]
|
|
296285
297201
|
}
|
|
296286
297202
|
},
|
|
297203
|
+
"repository-advisory-pvr": {
|
|
297204
|
+
"value": {
|
|
297205
|
+
"ghsa_id": "GHSA-abcd-1234-efgh",
|
|
297206
|
+
"cve_id": "CVE-2050-00000",
|
|
297207
|
+
"url": "https://api.github.com/repos/repo/a-package/security-advisories/GHSA-abcd-1234-efgh",
|
|
297208
|
+
"html_url": "https://github.com/repo/a-package/security/advisories/GHSA-abcd-1234-efgh",
|
|
297209
|
+
"summary": "A newly discovered vulnerability",
|
|
297210
|
+
"description": "A more in-depth description of what the problem is.",
|
|
297211
|
+
"severity": "high",
|
|
297212
|
+
"author": {
|
|
297213
|
+
"login": "octocat",
|
|
297214
|
+
"id": 1,
|
|
297215
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
297216
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
297217
|
+
"gravatar_id": "",
|
|
297218
|
+
"url": "https://api.github.com/users/octocat",
|
|
297219
|
+
"html_url": "https://github.com/octocat",
|
|
297220
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
297221
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
297222
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
297223
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
297224
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
297225
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
297226
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
297227
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
297228
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
297229
|
+
"type": "User",
|
|
297230
|
+
"site_admin": false
|
|
297231
|
+
},
|
|
297232
|
+
"publisher": null,
|
|
297233
|
+
"identifiers": [
|
|
297234
|
+
{
|
|
297235
|
+
"type": "GHSA",
|
|
297236
|
+
"value": "GHSA-abcd-1234-efgh"
|
|
297237
|
+
},
|
|
297238
|
+
{
|
|
297239
|
+
"type": "CVE",
|
|
297240
|
+
"value": null
|
|
297241
|
+
}
|
|
297242
|
+
],
|
|
297243
|
+
"state": "triage",
|
|
297244
|
+
"created_at": "2020-01-01T00:00:00Z",
|
|
297245
|
+
"updated_at": "2020-01-02T00:00:00Z",
|
|
297246
|
+
"published_at": null,
|
|
297247
|
+
"closed_at": null,
|
|
297248
|
+
"withdrawn_at": null,
|
|
297249
|
+
"submission": {
|
|
297250
|
+
"accepted": false
|
|
297251
|
+
},
|
|
297252
|
+
"vulnerabilities": [
|
|
297253
|
+
{
|
|
297254
|
+
"package": {
|
|
297255
|
+
"ecosystem": "npm",
|
|
297256
|
+
"name": "a-package"
|
|
297257
|
+
},
|
|
297258
|
+
"vulnerable_version_range": "< 1.0.0",
|
|
297259
|
+
"patched_versions": "1.0.0",
|
|
297260
|
+
"vulnerable_functions": [
|
|
297261
|
+
"important_function"
|
|
297262
|
+
]
|
|
297263
|
+
}
|
|
297264
|
+
],
|
|
297265
|
+
"cvss": null,
|
|
297266
|
+
"cwes": [
|
|
297267
|
+
{
|
|
297268
|
+
"cwe_id": "CWE-123",
|
|
297269
|
+
"name": "A CWE"
|
|
297270
|
+
}
|
|
297271
|
+
],
|
|
297272
|
+
"cwe_ids": [
|
|
297273
|
+
"CWE-123"
|
|
297274
|
+
],
|
|
297275
|
+
"credits": [
|
|
297276
|
+
{
|
|
297277
|
+
"login": "octocat",
|
|
297278
|
+
"type": "finder"
|
|
297279
|
+
}
|
|
297280
|
+
],
|
|
297281
|
+
"credits_detailed": [
|
|
297282
|
+
{
|
|
297283
|
+
"user": {
|
|
297284
|
+
"login": "octocat",
|
|
297285
|
+
"id": 1,
|
|
297286
|
+
"node_id": "MDQ6VXNlcjE=",
|
|
297287
|
+
"avatar_url": "https://github.com/images/error/octocat_happy.gif",
|
|
297288
|
+
"gravatar_id": "",
|
|
297289
|
+
"url": "https://api.github.com/users/octocat",
|
|
297290
|
+
"html_url": "https://github.com/octocat",
|
|
297291
|
+
"followers_url": "https://api.github.com/users/octocat/followers",
|
|
297292
|
+
"following_url": "https://api.github.com/users/octocat/following{/other_user}",
|
|
297293
|
+
"gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
|
|
297294
|
+
"starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
|
|
297295
|
+
"subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
|
|
297296
|
+
"organizations_url": "https://api.github.com/users/octocat/orgs",
|
|
297297
|
+
"repos_url": "https://api.github.com/users/octocat/repos",
|
|
297298
|
+
"events_url": "https://api.github.com/users/octocat/events{/privacy}",
|
|
297299
|
+
"received_events_url": "https://api.github.com/users/octocat/received_events",
|
|
297300
|
+
"type": "User",
|
|
297301
|
+
"site_admin": false
|
|
297302
|
+
},
|
|
297303
|
+
"type": "finder",
|
|
297304
|
+
"state": "accepted"
|
|
297305
|
+
}
|
|
297306
|
+
]
|
|
297307
|
+
}
|
|
297308
|
+
},
|
|
296287
297309
|
"simple-user-items-default-response": {
|
|
296288
297310
|
"summary": "Default response",
|
|
296289
297311
|
"value": [
|
|
@@ -304381,6 +305403,15 @@
|
|
|
304381
305403
|
"type": "integer"
|
|
304382
305404
|
}
|
|
304383
305405
|
},
|
|
305406
|
+
"protection-rule-id": {
|
|
305407
|
+
"name": "protection_rule_id",
|
|
305408
|
+
"description": "The unique identifier of the protection rule.",
|
|
305409
|
+
"in": "path",
|
|
305410
|
+
"required": true,
|
|
305411
|
+
"schema": {
|
|
305412
|
+
"type": "integer"
|
|
305413
|
+
}
|
|
305414
|
+
},
|
|
304384
305415
|
"since-user": {
|
|
304385
305416
|
"name": "since",
|
|
304386
305417
|
"description": "A user ID. Only return users with an ID greater than this ID.",
|