@faable/deploy-sdk 2.9.0 → 2.10.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/dist/FaableDeployApi.d.ts +4 -0
- package/dist/FaableDeployApi.d.ts.map +1 -1
- package/dist/api/api-types.d.ts +6 -0
- package/dist/api/api-types.d.ts.map +1 -1
- package/dist/api/generated-client.d.ts +107 -0
- package/dist/api/generated-client.d.ts.map +1 -1
- package/dist/api/generated-client.js +61 -0
- package/dist/api/types.d.ts +367 -1
- package/dist/api/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/spec/openapi.json +754 -106
package/spec/openapi.json
CHANGED
|
@@ -805,6 +805,117 @@
|
|
|
805
805
|
}
|
|
806
806
|
}
|
|
807
807
|
},
|
|
808
|
+
"RepoBranches": {
|
|
809
|
+
"type": "object",
|
|
810
|
+
"required": [
|
|
811
|
+
"branches"
|
|
812
|
+
],
|
|
813
|
+
"properties": {
|
|
814
|
+
"branches": {
|
|
815
|
+
"type": "array",
|
|
816
|
+
"items": {
|
|
817
|
+
"type": "string"
|
|
818
|
+
}
|
|
819
|
+
}
|
|
820
|
+
}
|
|
821
|
+
},
|
|
822
|
+
"RepoWorkflows": {
|
|
823
|
+
"type": "object",
|
|
824
|
+
"required": [
|
|
825
|
+
"workflows",
|
|
826
|
+
"deploy_workflow"
|
|
827
|
+
],
|
|
828
|
+
"properties": {
|
|
829
|
+
"workflows": {
|
|
830
|
+
"type": "array",
|
|
831
|
+
"items": {
|
|
832
|
+
"type": "object",
|
|
833
|
+
"required": [
|
|
834
|
+
"name",
|
|
835
|
+
"path"
|
|
836
|
+
],
|
|
837
|
+
"properties": {
|
|
838
|
+
"name": {
|
|
839
|
+
"type": "string"
|
|
840
|
+
},
|
|
841
|
+
"path": {
|
|
842
|
+
"type": "string"
|
|
843
|
+
}
|
|
844
|
+
}
|
|
845
|
+
}
|
|
846
|
+
},
|
|
847
|
+
"deploy_workflow": {
|
|
848
|
+
"anyOf": [
|
|
849
|
+
{
|
|
850
|
+
"type": "string"
|
|
851
|
+
},
|
|
852
|
+
{
|
|
853
|
+
"type": "null"
|
|
854
|
+
}
|
|
855
|
+
]
|
|
856
|
+
}
|
|
857
|
+
}
|
|
858
|
+
},
|
|
859
|
+
"RepoConfig": {
|
|
860
|
+
"type": "object",
|
|
861
|
+
"required": [
|
|
862
|
+
"root_dir",
|
|
863
|
+
"root_dir_source"
|
|
864
|
+
],
|
|
865
|
+
"properties": {
|
|
866
|
+
"root_dir": {
|
|
867
|
+
"anyOf": [
|
|
868
|
+
{
|
|
869
|
+
"type": "string"
|
|
870
|
+
},
|
|
871
|
+
{
|
|
872
|
+
"type": "null"
|
|
873
|
+
}
|
|
874
|
+
]
|
|
875
|
+
},
|
|
876
|
+
"root_dir_source": {
|
|
877
|
+
"anyOf": [
|
|
878
|
+
{
|
|
879
|
+
"type": "string",
|
|
880
|
+
"enum": [
|
|
881
|
+
"platform"
|
|
882
|
+
]
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"type": "string",
|
|
886
|
+
"enum": [
|
|
887
|
+
"faable.json"
|
|
888
|
+
]
|
|
889
|
+
},
|
|
890
|
+
{
|
|
891
|
+
"type": "null"
|
|
892
|
+
}
|
|
893
|
+
]
|
|
894
|
+
}
|
|
895
|
+
}
|
|
896
|
+
},
|
|
897
|
+
"DeployNowResult": {
|
|
898
|
+
"type": "object",
|
|
899
|
+
"required": [
|
|
900
|
+
"status",
|
|
901
|
+
"commit",
|
|
902
|
+
"branch"
|
|
903
|
+
],
|
|
904
|
+
"properties": {
|
|
905
|
+
"status": {
|
|
906
|
+
"type": "string",
|
|
907
|
+
"enum": [
|
|
908
|
+
"created"
|
|
909
|
+
]
|
|
910
|
+
},
|
|
911
|
+
"commit": {
|
|
912
|
+
"type": "string"
|
|
913
|
+
},
|
|
914
|
+
"branch": {
|
|
915
|
+
"type": "string"
|
|
916
|
+
}
|
|
917
|
+
}
|
|
918
|
+
},
|
|
808
919
|
"DeploymentStatus": {
|
|
809
920
|
"type": "object",
|
|
810
921
|
"required": [
|
|
@@ -822,7 +933,8 @@
|
|
|
822
933
|
"READY",
|
|
823
934
|
"CANCELED",
|
|
824
935
|
"TERMINATING",
|
|
825
|
-
"SUPERSEDED"
|
|
936
|
+
"SUPERSEDED",
|
|
937
|
+
"QUOTA_HOLD"
|
|
826
938
|
],
|
|
827
939
|
"description": "High-level summary of where the Deployment is in its lifecycle",
|
|
828
940
|
"default": "QUEUED"
|
|
@@ -1066,6 +1178,10 @@
|
|
|
1066
1178
|
"redeploy_of": {
|
|
1067
1179
|
"type": "string"
|
|
1068
1180
|
},
|
|
1181
|
+
"quota_released_at": {
|
|
1182
|
+
"type": "string",
|
|
1183
|
+
"format": "date-time"
|
|
1184
|
+
},
|
|
1069
1185
|
"trigger": {
|
|
1070
1186
|
"anyOf": [
|
|
1071
1187
|
{
|
|
@@ -2638,6 +2754,66 @@
|
|
|
2638
2754
|
},
|
|
2639
2755
|
"additionalProperties": false
|
|
2640
2756
|
},
|
|
2757
|
+
"DeployQuota": {
|
|
2758
|
+
"type": "object",
|
|
2759
|
+
"required": [
|
|
2760
|
+
"limited",
|
|
2761
|
+
"over",
|
|
2762
|
+
"used",
|
|
2763
|
+
"limit",
|
|
2764
|
+
"resets_at",
|
|
2765
|
+
"held"
|
|
2766
|
+
],
|
|
2767
|
+
"properties": {
|
|
2768
|
+
"limited": {
|
|
2769
|
+
"type": "boolean"
|
|
2770
|
+
},
|
|
2771
|
+
"over": {
|
|
2772
|
+
"type": "boolean"
|
|
2773
|
+
},
|
|
2774
|
+
"used": {
|
|
2775
|
+
"type": "integer"
|
|
2776
|
+
},
|
|
2777
|
+
"limit": {
|
|
2778
|
+
"anyOf": [
|
|
2779
|
+
{
|
|
2780
|
+
"type": "integer"
|
|
2781
|
+
},
|
|
2782
|
+
{
|
|
2783
|
+
"type": "null"
|
|
2784
|
+
}
|
|
2785
|
+
]
|
|
2786
|
+
},
|
|
2787
|
+
"resets_at": {
|
|
2788
|
+
"type": "string",
|
|
2789
|
+
"format": "date-time"
|
|
2790
|
+
},
|
|
2791
|
+
"held": {
|
|
2792
|
+
"type": "integer"
|
|
2793
|
+
}
|
|
2794
|
+
}
|
|
2795
|
+
},
|
|
2796
|
+
"DeployQuotaRelease": {
|
|
2797
|
+
"type": "object",
|
|
2798
|
+
"required": [
|
|
2799
|
+
"released",
|
|
2800
|
+
"canceled"
|
|
2801
|
+
],
|
|
2802
|
+
"properties": {
|
|
2803
|
+
"released": {
|
|
2804
|
+
"type": "array",
|
|
2805
|
+
"items": {
|
|
2806
|
+
"type": "string"
|
|
2807
|
+
}
|
|
2808
|
+
},
|
|
2809
|
+
"canceled": {
|
|
2810
|
+
"type": "array",
|
|
2811
|
+
"items": {
|
|
2812
|
+
"type": "string"
|
|
2813
|
+
}
|
|
2814
|
+
}
|
|
2815
|
+
}
|
|
2816
|
+
},
|
|
2641
2817
|
"AppChecknameResponse": {
|
|
2642
2818
|
"type": "object",
|
|
2643
2819
|
"required": [
|
|
@@ -5287,52 +5463,23 @@
|
|
|
5287
5463
|
}
|
|
5288
5464
|
}
|
|
5289
5465
|
},
|
|
5290
|
-
"/
|
|
5466
|
+
"/app/{id}/repo/branches": {
|
|
5291
5467
|
"get": {
|
|
5292
|
-
"operationId": "
|
|
5293
|
-
"summary": "List
|
|
5468
|
+
"operationId": "app/repo_branches",
|
|
5469
|
+
"summary": "List repository branches",
|
|
5294
5470
|
"tags": [
|
|
5295
|
-
"
|
|
5471
|
+
"apps",
|
|
5472
|
+
"github"
|
|
5296
5473
|
],
|
|
5297
|
-
"description": "
|
|
5474
|
+
"description": "Branch names of the linked repository.",
|
|
5298
5475
|
"parameters": [
|
|
5299
|
-
{
|
|
5300
|
-
"schema": {
|
|
5301
|
-
"type": "number",
|
|
5302
|
-
"minimum": 1,
|
|
5303
|
-
"maximum": 200
|
|
5304
|
-
},
|
|
5305
|
-
"in": "query",
|
|
5306
|
-
"name": "pageSize",
|
|
5307
|
-
"required": false,
|
|
5308
|
-
"description": "Number of items per page (max 200)"
|
|
5309
|
-
},
|
|
5310
|
-
{
|
|
5311
|
-
"schema": {
|
|
5312
|
-
"type": "string"
|
|
5313
|
-
},
|
|
5314
|
-
"in": "query",
|
|
5315
|
-
"name": "cursor",
|
|
5316
|
-
"required": false,
|
|
5317
|
-
"description": "Cursor for next page"
|
|
5318
|
-
},
|
|
5319
|
-
{
|
|
5320
|
-
"schema": {
|
|
5321
|
-
"type": "string"
|
|
5322
|
-
},
|
|
5323
|
-
"in": "query",
|
|
5324
|
-
"name": "next",
|
|
5325
|
-
"required": false,
|
|
5326
|
-
"description": "Cursor returned by the previous page"
|
|
5327
|
-
},
|
|
5328
5476
|
{
|
|
5329
5477
|
"schema": {
|
|
5330
5478
|
"type": "string"
|
|
5331
5479
|
},
|
|
5332
|
-
"in": "
|
|
5333
|
-
"name": "
|
|
5334
|
-
"required":
|
|
5335
|
-
"description": "Filter using a FaableQL query"
|
|
5480
|
+
"in": "path",
|
|
5481
|
+
"name": "id",
|
|
5482
|
+
"required": true
|
|
5336
5483
|
}
|
|
5337
5484
|
],
|
|
5338
5485
|
"security": [
|
|
@@ -5351,84 +5498,42 @@
|
|
|
5351
5498
|
"schema": {
|
|
5352
5499
|
"type": "object",
|
|
5353
5500
|
"required": [
|
|
5354
|
-
"
|
|
5355
|
-
"results"
|
|
5501
|
+
"branches"
|
|
5356
5502
|
],
|
|
5357
5503
|
"properties": {
|
|
5358
|
-
"
|
|
5359
|
-
"anyOf": [
|
|
5360
|
-
{
|
|
5361
|
-
"type": "string"
|
|
5362
|
-
},
|
|
5363
|
-
{
|
|
5364
|
-
"type": "null"
|
|
5365
|
-
}
|
|
5366
|
-
]
|
|
5367
|
-
},
|
|
5368
|
-
"results": {
|
|
5504
|
+
"branches": {
|
|
5369
5505
|
"type": "array",
|
|
5370
5506
|
"items": {
|
|
5371
|
-
"
|
|
5507
|
+
"type": "string"
|
|
5372
5508
|
}
|
|
5373
5509
|
}
|
|
5374
|
-
}
|
|
5375
|
-
"additionalProperties": false
|
|
5510
|
+
}
|
|
5376
5511
|
}
|
|
5377
5512
|
}
|
|
5378
5513
|
}
|
|
5379
5514
|
}
|
|
5380
5515
|
}
|
|
5381
|
-
}
|
|
5382
|
-
|
|
5383
|
-
|
|
5384
|
-
|
|
5516
|
+
}
|
|
5517
|
+
},
|
|
5518
|
+
"/app/{id}/repo/workflows": {
|
|
5519
|
+
"get": {
|
|
5520
|
+
"operationId": "app/repo_workflows",
|
|
5521
|
+
"summary": "List repository workflow files",
|
|
5385
5522
|
"tags": [
|
|
5386
|
-
"
|
|
5523
|
+
"apps",
|
|
5524
|
+
"github"
|
|
5387
5525
|
],
|
|
5388
|
-
"description": "
|
|
5389
|
-
"
|
|
5390
|
-
|
|
5391
|
-
|
|
5392
|
-
|
|
5393
|
-
|
|
5394
|
-
|
|
5395
|
-
|
|
5396
|
-
|
|
5397
|
-
],
|
|
5398
|
-
"properties": {
|
|
5399
|
-
"app_id": {
|
|
5400
|
-
"type": "string"
|
|
5401
|
-
},
|
|
5402
|
-
"image": {
|
|
5403
|
-
"type": "string"
|
|
5404
|
-
},
|
|
5405
|
-
"release": {
|
|
5406
|
-
"type": "string",
|
|
5407
|
-
"maxLength": 128
|
|
5408
|
-
},
|
|
5409
|
-
"github_commit": {
|
|
5410
|
-
"type": "string"
|
|
5411
|
-
},
|
|
5412
|
-
"github_ref": {
|
|
5413
|
-
"type": "string"
|
|
5414
|
-
},
|
|
5415
|
-
"github_actor": {
|
|
5416
|
-
"type": "string"
|
|
5417
|
-
},
|
|
5418
|
-
"github_commit_message": {
|
|
5419
|
-
"type": "string"
|
|
5420
|
-
},
|
|
5421
|
-
"type": {
|
|
5422
|
-
"type": "string"
|
|
5423
|
-
},
|
|
5424
|
-
"source": {
|
|
5425
|
-
"$ref": "#/components/schemas/DeploymentSource"
|
|
5426
|
-
}
|
|
5427
|
-
}
|
|
5428
|
-
}
|
|
5429
|
-
}
|
|
5526
|
+
"description": "GitHub Actions workflow files present on the linked repository (deploy branch).",
|
|
5527
|
+
"parameters": [
|
|
5528
|
+
{
|
|
5529
|
+
"schema": {
|
|
5530
|
+
"type": "string"
|
|
5531
|
+
},
|
|
5532
|
+
"in": "path",
|
|
5533
|
+
"name": "id",
|
|
5534
|
+
"required": true
|
|
5430
5535
|
}
|
|
5431
|
-
|
|
5536
|
+
],
|
|
5432
5537
|
"security": [
|
|
5433
5538
|
{
|
|
5434
5539
|
"faable_user": [],
|
|
@@ -5438,9 +5543,422 @@
|
|
|
5438
5543
|
}
|
|
5439
5544
|
],
|
|
5440
5545
|
"responses": {
|
|
5441
|
-
"
|
|
5442
|
-
"description": "
|
|
5443
|
-
"content": {
|
|
5546
|
+
"200": {
|
|
5547
|
+
"description": "Default Response",
|
|
5548
|
+
"content": {
|
|
5549
|
+
"application/json": {
|
|
5550
|
+
"schema": {
|
|
5551
|
+
"type": "object",
|
|
5552
|
+
"required": [
|
|
5553
|
+
"workflows",
|
|
5554
|
+
"deploy_workflow"
|
|
5555
|
+
],
|
|
5556
|
+
"properties": {
|
|
5557
|
+
"workflows": {
|
|
5558
|
+
"type": "array",
|
|
5559
|
+
"items": {
|
|
5560
|
+
"type": "object",
|
|
5561
|
+
"required": [
|
|
5562
|
+
"name",
|
|
5563
|
+
"path"
|
|
5564
|
+
],
|
|
5565
|
+
"properties": {
|
|
5566
|
+
"name": {
|
|
5567
|
+
"type": "string"
|
|
5568
|
+
},
|
|
5569
|
+
"path": {
|
|
5570
|
+
"type": "string"
|
|
5571
|
+
}
|
|
5572
|
+
}
|
|
5573
|
+
}
|
|
5574
|
+
},
|
|
5575
|
+
"deploy_workflow": {
|
|
5576
|
+
"anyOf": [
|
|
5577
|
+
{
|
|
5578
|
+
"type": "string"
|
|
5579
|
+
},
|
|
5580
|
+
{
|
|
5581
|
+
"type": "null"
|
|
5582
|
+
}
|
|
5583
|
+
]
|
|
5584
|
+
}
|
|
5585
|
+
}
|
|
5586
|
+
}
|
|
5587
|
+
}
|
|
5588
|
+
}
|
|
5589
|
+
}
|
|
5590
|
+
}
|
|
5591
|
+
}
|
|
5592
|
+
},
|
|
5593
|
+
"/app/{id}/repo/config": {
|
|
5594
|
+
"get": {
|
|
5595
|
+
"operationId": "app/repo_config",
|
|
5596
|
+
"summary": "Get effective repository build config",
|
|
5597
|
+
"tags": [
|
|
5598
|
+
"apps",
|
|
5599
|
+
"github"
|
|
5600
|
+
],
|
|
5601
|
+
"description": "Effective build configuration read from the repository: the monorepo Root Directory and its source (platform override or the repo's faable.json).",
|
|
5602
|
+
"parameters": [
|
|
5603
|
+
{
|
|
5604
|
+
"schema": {
|
|
5605
|
+
"type": "string"
|
|
5606
|
+
},
|
|
5607
|
+
"in": "path",
|
|
5608
|
+
"name": "id",
|
|
5609
|
+
"required": true
|
|
5610
|
+
}
|
|
5611
|
+
],
|
|
5612
|
+
"security": [
|
|
5613
|
+
{
|
|
5614
|
+
"faable_user": [],
|
|
5615
|
+
"faable_cli": [],
|
|
5616
|
+
"apikey": [],
|
|
5617
|
+
"faable_machine": []
|
|
5618
|
+
}
|
|
5619
|
+
],
|
|
5620
|
+
"responses": {
|
|
5621
|
+
"200": {
|
|
5622
|
+
"description": "Default Response",
|
|
5623
|
+
"content": {
|
|
5624
|
+
"application/json": {
|
|
5625
|
+
"schema": {
|
|
5626
|
+
"type": "object",
|
|
5627
|
+
"required": [
|
|
5628
|
+
"root_dir",
|
|
5629
|
+
"root_dir_source"
|
|
5630
|
+
],
|
|
5631
|
+
"properties": {
|
|
5632
|
+
"root_dir": {
|
|
5633
|
+
"anyOf": [
|
|
5634
|
+
{
|
|
5635
|
+
"type": "string"
|
|
5636
|
+
},
|
|
5637
|
+
{
|
|
5638
|
+
"type": "null"
|
|
5639
|
+
}
|
|
5640
|
+
]
|
|
5641
|
+
},
|
|
5642
|
+
"root_dir_source": {
|
|
5643
|
+
"anyOf": [
|
|
5644
|
+
{
|
|
5645
|
+
"type": "string",
|
|
5646
|
+
"enum": [
|
|
5647
|
+
"platform"
|
|
5648
|
+
]
|
|
5649
|
+
},
|
|
5650
|
+
{
|
|
5651
|
+
"type": "string",
|
|
5652
|
+
"enum": [
|
|
5653
|
+
"faable.json"
|
|
5654
|
+
]
|
|
5655
|
+
},
|
|
5656
|
+
{
|
|
5657
|
+
"type": "null"
|
|
5658
|
+
}
|
|
5659
|
+
]
|
|
5660
|
+
}
|
|
5661
|
+
}
|
|
5662
|
+
}
|
|
5663
|
+
}
|
|
5664
|
+
}
|
|
5665
|
+
}
|
|
5666
|
+
}
|
|
5667
|
+
}
|
|
5668
|
+
},
|
|
5669
|
+
"/app/{id}/deploy-mode": {
|
|
5670
|
+
"post": {
|
|
5671
|
+
"operationId": "app/set_deploy_mode",
|
|
5672
|
+
"summary": "Set the deploy mode",
|
|
5673
|
+
"tags": [
|
|
5674
|
+
"apps",
|
|
5675
|
+
"github"
|
|
5676
|
+
],
|
|
5677
|
+
"description": "Choose how pushes deploy: 'push' = every push deploys directly; 'ci' = deploy once the commit's CI checks pass. Both are platform-managed (webhook) triggers.",
|
|
5678
|
+
"requestBody": {
|
|
5679
|
+
"required": true,
|
|
5680
|
+
"content": {
|
|
5681
|
+
"application/json": {
|
|
5682
|
+
"schema": {
|
|
5683
|
+
"type": "object",
|
|
5684
|
+
"required": [
|
|
5685
|
+
"mode"
|
|
5686
|
+
],
|
|
5687
|
+
"properties": {
|
|
5688
|
+
"mode": {
|
|
5689
|
+
"anyOf": [
|
|
5690
|
+
{
|
|
5691
|
+
"type": "string",
|
|
5692
|
+
"enum": [
|
|
5693
|
+
"push"
|
|
5694
|
+
]
|
|
5695
|
+
},
|
|
5696
|
+
{
|
|
5697
|
+
"type": "string",
|
|
5698
|
+
"enum": [
|
|
5699
|
+
"ci"
|
|
5700
|
+
]
|
|
5701
|
+
},
|
|
5702
|
+
{
|
|
5703
|
+
"type": "string",
|
|
5704
|
+
"enum": [
|
|
5705
|
+
"workflow"
|
|
5706
|
+
]
|
|
5707
|
+
}
|
|
5708
|
+
]
|
|
5709
|
+
}
|
|
5710
|
+
},
|
|
5711
|
+
"additionalProperties": false
|
|
5712
|
+
}
|
|
5713
|
+
}
|
|
5714
|
+
}
|
|
5715
|
+
},
|
|
5716
|
+
"parameters": [
|
|
5717
|
+
{
|
|
5718
|
+
"schema": {
|
|
5719
|
+
"type": "string"
|
|
5720
|
+
},
|
|
5721
|
+
"in": "path",
|
|
5722
|
+
"name": "id",
|
|
5723
|
+
"required": true
|
|
5724
|
+
}
|
|
5725
|
+
],
|
|
5726
|
+
"security": [
|
|
5727
|
+
{
|
|
5728
|
+
"faable_user": [],
|
|
5729
|
+
"faable_cli": [],
|
|
5730
|
+
"apikey": [],
|
|
5731
|
+
"faable_machine": []
|
|
5732
|
+
}
|
|
5733
|
+
],
|
|
5734
|
+
"responses": {
|
|
5735
|
+
"200": {
|
|
5736
|
+
"description": "App",
|
|
5737
|
+
"content": {
|
|
5738
|
+
"application/json": {
|
|
5739
|
+
"schema": {
|
|
5740
|
+
"$ref": "#/components/schemas/App"
|
|
5741
|
+
}
|
|
5742
|
+
}
|
|
5743
|
+
}
|
|
5744
|
+
}
|
|
5745
|
+
}
|
|
5746
|
+
}
|
|
5747
|
+
},
|
|
5748
|
+
"/app/{id}/deploy": {
|
|
5749
|
+
"post": {
|
|
5750
|
+
"operationId": "app/deploy_now",
|
|
5751
|
+
"summary": "Deploy the latest commit now",
|
|
5752
|
+
"tags": [
|
|
5753
|
+
"apps",
|
|
5754
|
+
"deployments"
|
|
5755
|
+
],
|
|
5756
|
+
"description": "Build and deploy the current head of the deploy branch, without waiting for a push. Same path as a push webhook, including the same-commit dedupe.",
|
|
5757
|
+
"parameters": [
|
|
5758
|
+
{
|
|
5759
|
+
"schema": {
|
|
5760
|
+
"type": "string"
|
|
5761
|
+
},
|
|
5762
|
+
"in": "path",
|
|
5763
|
+
"name": "id",
|
|
5764
|
+
"required": true
|
|
5765
|
+
}
|
|
5766
|
+
],
|
|
5767
|
+
"security": [
|
|
5768
|
+
{
|
|
5769
|
+
"faable_user": [],
|
|
5770
|
+
"faable_cli": [],
|
|
5771
|
+
"apikey": [],
|
|
5772
|
+
"faable_machine": []
|
|
5773
|
+
}
|
|
5774
|
+
],
|
|
5775
|
+
"responses": {
|
|
5776
|
+
"200": {
|
|
5777
|
+
"description": "Default Response",
|
|
5778
|
+
"content": {
|
|
5779
|
+
"application/json": {
|
|
5780
|
+
"schema": {
|
|
5781
|
+
"type": "object",
|
|
5782
|
+
"required": [
|
|
5783
|
+
"status",
|
|
5784
|
+
"commit",
|
|
5785
|
+
"branch"
|
|
5786
|
+
],
|
|
5787
|
+
"properties": {
|
|
5788
|
+
"status": {
|
|
5789
|
+
"type": "string",
|
|
5790
|
+
"enum": [
|
|
5791
|
+
"created"
|
|
5792
|
+
]
|
|
5793
|
+
},
|
|
5794
|
+
"commit": {
|
|
5795
|
+
"type": "string"
|
|
5796
|
+
},
|
|
5797
|
+
"branch": {
|
|
5798
|
+
"type": "string"
|
|
5799
|
+
}
|
|
5800
|
+
}
|
|
5801
|
+
}
|
|
5802
|
+
}
|
|
5803
|
+
}
|
|
5804
|
+
}
|
|
5805
|
+
}
|
|
5806
|
+
}
|
|
5807
|
+
},
|
|
5808
|
+
"/deployment": {
|
|
5809
|
+
"get": {
|
|
5810
|
+
"operationId": "deployment/list",
|
|
5811
|
+
"summary": "List Deployments",
|
|
5812
|
+
"tags": [
|
|
5813
|
+
"deployments"
|
|
5814
|
+
],
|
|
5815
|
+
"description": "List Deployments",
|
|
5816
|
+
"parameters": [
|
|
5817
|
+
{
|
|
5818
|
+
"schema": {
|
|
5819
|
+
"type": "number",
|
|
5820
|
+
"minimum": 1,
|
|
5821
|
+
"maximum": 200
|
|
5822
|
+
},
|
|
5823
|
+
"in": "query",
|
|
5824
|
+
"name": "pageSize",
|
|
5825
|
+
"required": false,
|
|
5826
|
+
"description": "Number of items per page (max 200)"
|
|
5827
|
+
},
|
|
5828
|
+
{
|
|
5829
|
+
"schema": {
|
|
5830
|
+
"type": "string"
|
|
5831
|
+
},
|
|
5832
|
+
"in": "query",
|
|
5833
|
+
"name": "cursor",
|
|
5834
|
+
"required": false,
|
|
5835
|
+
"description": "Cursor for next page"
|
|
5836
|
+
},
|
|
5837
|
+
{
|
|
5838
|
+
"schema": {
|
|
5839
|
+
"type": "string"
|
|
5840
|
+
},
|
|
5841
|
+
"in": "query",
|
|
5842
|
+
"name": "next",
|
|
5843
|
+
"required": false,
|
|
5844
|
+
"description": "Cursor returned by the previous page"
|
|
5845
|
+
},
|
|
5846
|
+
{
|
|
5847
|
+
"schema": {
|
|
5848
|
+
"type": "string"
|
|
5849
|
+
},
|
|
5850
|
+
"in": "query",
|
|
5851
|
+
"name": "query",
|
|
5852
|
+
"required": false,
|
|
5853
|
+
"description": "Filter using a FaableQL query"
|
|
5854
|
+
}
|
|
5855
|
+
],
|
|
5856
|
+
"security": [
|
|
5857
|
+
{
|
|
5858
|
+
"faable_user": [],
|
|
5859
|
+
"faable_cli": [],
|
|
5860
|
+
"apikey": [],
|
|
5861
|
+
"faable_machine": []
|
|
5862
|
+
}
|
|
5863
|
+
],
|
|
5864
|
+
"responses": {
|
|
5865
|
+
"200": {
|
|
5866
|
+
"description": "Default Response",
|
|
5867
|
+
"content": {
|
|
5868
|
+
"application/json": {
|
|
5869
|
+
"schema": {
|
|
5870
|
+
"type": "object",
|
|
5871
|
+
"required": [
|
|
5872
|
+
"next",
|
|
5873
|
+
"results"
|
|
5874
|
+
],
|
|
5875
|
+
"properties": {
|
|
5876
|
+
"next": {
|
|
5877
|
+
"anyOf": [
|
|
5878
|
+
{
|
|
5879
|
+
"type": "string"
|
|
5880
|
+
},
|
|
5881
|
+
{
|
|
5882
|
+
"type": "null"
|
|
5883
|
+
}
|
|
5884
|
+
]
|
|
5885
|
+
},
|
|
5886
|
+
"results": {
|
|
5887
|
+
"type": "array",
|
|
5888
|
+
"items": {
|
|
5889
|
+
"$ref": "#/components/schemas/Deployment"
|
|
5890
|
+
}
|
|
5891
|
+
}
|
|
5892
|
+
},
|
|
5893
|
+
"additionalProperties": false
|
|
5894
|
+
}
|
|
5895
|
+
}
|
|
5896
|
+
}
|
|
5897
|
+
}
|
|
5898
|
+
}
|
|
5899
|
+
},
|
|
5900
|
+
"post": {
|
|
5901
|
+
"operationId": "deployment/create",
|
|
5902
|
+
"summary": "Create Deployment",
|
|
5903
|
+
"tags": [
|
|
5904
|
+
"deployments"
|
|
5905
|
+
],
|
|
5906
|
+
"description": "Create Deployment",
|
|
5907
|
+
"requestBody": {
|
|
5908
|
+
"required": true,
|
|
5909
|
+
"content": {
|
|
5910
|
+
"application/json": {
|
|
5911
|
+
"schema": {
|
|
5912
|
+
"type": "object",
|
|
5913
|
+
"required": [
|
|
5914
|
+
"app_id"
|
|
5915
|
+
],
|
|
5916
|
+
"properties": {
|
|
5917
|
+
"app_id": {
|
|
5918
|
+
"type": "string"
|
|
5919
|
+
},
|
|
5920
|
+
"image": {
|
|
5921
|
+
"type": "string"
|
|
5922
|
+
},
|
|
5923
|
+
"release": {
|
|
5924
|
+
"type": "string",
|
|
5925
|
+
"maxLength": 128
|
|
5926
|
+
},
|
|
5927
|
+
"github_commit": {
|
|
5928
|
+
"type": "string"
|
|
5929
|
+
},
|
|
5930
|
+
"github_ref": {
|
|
5931
|
+
"type": "string"
|
|
5932
|
+
},
|
|
5933
|
+
"github_actor": {
|
|
5934
|
+
"type": "string"
|
|
5935
|
+
},
|
|
5936
|
+
"github_commit_message": {
|
|
5937
|
+
"type": "string"
|
|
5938
|
+
},
|
|
5939
|
+
"type": {
|
|
5940
|
+
"type": "string"
|
|
5941
|
+
},
|
|
5942
|
+
"source": {
|
|
5943
|
+
"$ref": "#/components/schemas/DeploymentSource"
|
|
5944
|
+
}
|
|
5945
|
+
}
|
|
5946
|
+
}
|
|
5947
|
+
}
|
|
5948
|
+
}
|
|
5949
|
+
},
|
|
5950
|
+
"security": [
|
|
5951
|
+
{
|
|
5952
|
+
"faable_user": [],
|
|
5953
|
+
"faable_cli": [],
|
|
5954
|
+
"apikey": [],
|
|
5955
|
+
"faable_machine": []
|
|
5956
|
+
}
|
|
5957
|
+
],
|
|
5958
|
+
"responses": {
|
|
5959
|
+
"201": {
|
|
5960
|
+
"description": "Deployment",
|
|
5961
|
+
"content": {
|
|
5444
5962
|
"application/json": {
|
|
5445
5963
|
"schema": {
|
|
5446
5964
|
"type": "object",
|
|
@@ -5491,6 +6009,10 @@
|
|
|
5491
6009
|
"redeploy_of": {
|
|
5492
6010
|
"type": "string"
|
|
5493
6011
|
},
|
|
6012
|
+
"quota_released_at": {
|
|
6013
|
+
"type": "string",
|
|
6014
|
+
"format": "date-time"
|
|
6015
|
+
},
|
|
5494
6016
|
"trigger": {
|
|
5495
6017
|
"anyOf": [
|
|
5496
6018
|
{
|
|
@@ -5608,6 +6130,10 @@
|
|
|
5608
6130
|
"redeploy_of": {
|
|
5609
6131
|
"type": "string"
|
|
5610
6132
|
},
|
|
6133
|
+
"quota_released_at": {
|
|
6134
|
+
"type": "string",
|
|
6135
|
+
"format": "date-time"
|
|
6136
|
+
},
|
|
5611
6137
|
"trigger": {
|
|
5612
6138
|
"anyOf": [
|
|
5613
6139
|
{
|
|
@@ -5744,6 +6270,10 @@
|
|
|
5744
6270
|
"redeploy_of": {
|
|
5745
6271
|
"type": "string"
|
|
5746
6272
|
},
|
|
6273
|
+
"quota_released_at": {
|
|
6274
|
+
"type": "string",
|
|
6275
|
+
"format": "date-time"
|
|
6276
|
+
},
|
|
5747
6277
|
"trigger": {
|
|
5748
6278
|
"anyOf": [
|
|
5749
6279
|
{
|
|
@@ -5859,6 +6389,10 @@
|
|
|
5859
6389
|
"redeploy_of": {
|
|
5860
6390
|
"type": "string"
|
|
5861
6391
|
},
|
|
6392
|
+
"quota_released_at": {
|
|
6393
|
+
"type": "string",
|
|
6394
|
+
"format": "date-time"
|
|
6395
|
+
},
|
|
5862
6396
|
"trigger": {
|
|
5863
6397
|
"anyOf": [
|
|
5864
6398
|
{
|
|
@@ -6970,6 +7504,120 @@
|
|
|
6970
7504
|
}
|
|
6971
7505
|
}
|
|
6972
7506
|
}
|
|
7507
|
+
},
|
|
7508
|
+
"/deploy-quota": {
|
|
7509
|
+
"get": {
|
|
7510
|
+
"operationId": "deploy_quota/get",
|
|
7511
|
+
"summary": "Get the team's daily deploy quota status",
|
|
7512
|
+
"tags": [
|
|
7513
|
+
"deployments"
|
|
7514
|
+
],
|
|
7515
|
+
"description": "Daily deploy allowance of the current team: how much was used today, when it resets, and how many builds are held waiting for it.",
|
|
7516
|
+
"security": [
|
|
7517
|
+
{
|
|
7518
|
+
"faable_user": [],
|
|
7519
|
+
"faable_cli": [],
|
|
7520
|
+
"apikey": [],
|
|
7521
|
+
"faable_machine": []
|
|
7522
|
+
}
|
|
7523
|
+
],
|
|
7524
|
+
"responses": {
|
|
7525
|
+
"200": {
|
|
7526
|
+
"description": "Default Response",
|
|
7527
|
+
"content": {
|
|
7528
|
+
"application/json": {
|
|
7529
|
+
"schema": {
|
|
7530
|
+
"type": "object",
|
|
7531
|
+
"required": [
|
|
7532
|
+
"limited",
|
|
7533
|
+
"over",
|
|
7534
|
+
"used",
|
|
7535
|
+
"limit",
|
|
7536
|
+
"resets_at",
|
|
7537
|
+
"held"
|
|
7538
|
+
],
|
|
7539
|
+
"properties": {
|
|
7540
|
+
"limited": {
|
|
7541
|
+
"type": "boolean"
|
|
7542
|
+
},
|
|
7543
|
+
"over": {
|
|
7544
|
+
"type": "boolean"
|
|
7545
|
+
},
|
|
7546
|
+
"used": {
|
|
7547
|
+
"type": "integer"
|
|
7548
|
+
},
|
|
7549
|
+
"limit": {
|
|
7550
|
+
"anyOf": [
|
|
7551
|
+
{
|
|
7552
|
+
"type": "integer"
|
|
7553
|
+
},
|
|
7554
|
+
{
|
|
7555
|
+
"type": "null"
|
|
7556
|
+
}
|
|
7557
|
+
]
|
|
7558
|
+
},
|
|
7559
|
+
"resets_at": {
|
|
7560
|
+
"type": "string",
|
|
7561
|
+
"format": "date-time"
|
|
7562
|
+
},
|
|
7563
|
+
"held": {
|
|
7564
|
+
"type": "integer"
|
|
7565
|
+
}
|
|
7566
|
+
}
|
|
7567
|
+
}
|
|
7568
|
+
}
|
|
7569
|
+
}
|
|
7570
|
+
}
|
|
7571
|
+
}
|
|
7572
|
+
}
|
|
7573
|
+
},
|
|
7574
|
+
"/deploy-quota/release": {
|
|
7575
|
+
"post": {
|
|
7576
|
+
"operationId": "deploy_quota/release",
|
|
7577
|
+
"summary": "Roll out the builds held by the daily deploy quota",
|
|
7578
|
+
"tags": [
|
|
7579
|
+
"deployments"
|
|
7580
|
+
],
|
|
7581
|
+
"description": "Releases the team's held deployments if its current plan allows it (per app, only the newest held build rolls out; older ones are canceled). Safe to call at any time — it does nothing while the quota is still spent.",
|
|
7582
|
+
"security": [
|
|
7583
|
+
{
|
|
7584
|
+
"faable_user": [],
|
|
7585
|
+
"faable_cli": [],
|
|
7586
|
+
"apikey": [],
|
|
7587
|
+
"faable_machine": []
|
|
7588
|
+
}
|
|
7589
|
+
],
|
|
7590
|
+
"responses": {
|
|
7591
|
+
"200": {
|
|
7592
|
+
"description": "Default Response",
|
|
7593
|
+
"content": {
|
|
7594
|
+
"application/json": {
|
|
7595
|
+
"schema": {
|
|
7596
|
+
"type": "object",
|
|
7597
|
+
"required": [
|
|
7598
|
+
"released",
|
|
7599
|
+
"canceled"
|
|
7600
|
+
],
|
|
7601
|
+
"properties": {
|
|
7602
|
+
"released": {
|
|
7603
|
+
"type": "array",
|
|
7604
|
+
"items": {
|
|
7605
|
+
"type": "string"
|
|
7606
|
+
}
|
|
7607
|
+
},
|
|
7608
|
+
"canceled": {
|
|
7609
|
+
"type": "array",
|
|
7610
|
+
"items": {
|
|
7611
|
+
"type": "string"
|
|
7612
|
+
}
|
|
7613
|
+
}
|
|
7614
|
+
}
|
|
7615
|
+
}
|
|
7616
|
+
}
|
|
7617
|
+
}
|
|
7618
|
+
}
|
|
7619
|
+
}
|
|
7620
|
+
}
|
|
6973
7621
|
}
|
|
6974
7622
|
},
|
|
6975
7623
|
"servers": [
|