@faable/deploy-sdk 2.7.1 → 2.9.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 +36 -8
- package/dist/FaableDeployApi.d.ts.map +1 -1
- package/dist/api/api-types.d.ts +0 -1
- package/dist/api/api-types.d.ts.map +1 -1
- package/dist/api/generated-client.d.ts +75 -35
- package/dist/api/generated-client.d.ts.map +1 -1
- package/dist/api/generated-client.js +0 -18
- package/dist/api/types.d.ts +85 -107
- package/dist/api/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/spec/openapi.json +416 -216
package/spec/openapi.json
CHANGED
|
@@ -239,7 +239,6 @@
|
|
|
239
239
|
"phase",
|
|
240
240
|
"deployment",
|
|
241
241
|
"deployment_previous",
|
|
242
|
-
"deploy_workflow",
|
|
243
242
|
"last_commited_purge",
|
|
244
243
|
"last_commited_purge_key",
|
|
245
244
|
"last_commited_purge_service",
|
|
@@ -297,64 +296,6 @@
|
|
|
297
296
|
],
|
|
298
297
|
"default": null
|
|
299
298
|
},
|
|
300
|
-
"deploy_workflow": {
|
|
301
|
-
"anyOf": [
|
|
302
|
-
{
|
|
303
|
-
"type": "object",
|
|
304
|
-
"required": [
|
|
305
|
-
"configured",
|
|
306
|
-
"path",
|
|
307
|
-
"verified_at",
|
|
308
|
-
"commit"
|
|
309
|
-
],
|
|
310
|
-
"properties": {
|
|
311
|
-
"configured": {
|
|
312
|
-
"type": "boolean",
|
|
313
|
-
"description": "Whether a Faable deploy workflow exists on the repository"
|
|
314
|
-
},
|
|
315
|
-
"path": {
|
|
316
|
-
"anyOf": [
|
|
317
|
-
{
|
|
318
|
-
"type": "string",
|
|
319
|
-
"description": "Workflow file path, e.g. \".github/workflows/deploy.yaml\""
|
|
320
|
-
},
|
|
321
|
-
{
|
|
322
|
-
"type": "null"
|
|
323
|
-
}
|
|
324
|
-
]
|
|
325
|
-
},
|
|
326
|
-
"verified_at": {
|
|
327
|
-
"anyOf": [
|
|
328
|
-
{
|
|
329
|
-
"type": "string",
|
|
330
|
-
"description": "ISO date of the last time the workflow was verified"
|
|
331
|
-
},
|
|
332
|
-
{
|
|
333
|
-
"type": "null"
|
|
334
|
-
}
|
|
335
|
-
]
|
|
336
|
-
},
|
|
337
|
-
"commit": {
|
|
338
|
-
"anyOf": [
|
|
339
|
-
{
|
|
340
|
-
"type": "string",
|
|
341
|
-
"description": "Head commit sha at the last verification (from webhook)"
|
|
342
|
-
},
|
|
343
|
-
{
|
|
344
|
-
"type": "null"
|
|
345
|
-
}
|
|
346
|
-
]
|
|
347
|
-
}
|
|
348
|
-
},
|
|
349
|
-
"additionalProperties": false
|
|
350
|
-
},
|
|
351
|
-
{
|
|
352
|
-
"type": "null"
|
|
353
|
-
}
|
|
354
|
-
],
|
|
355
|
-
"default": null,
|
|
356
|
-
"description": "Observed state of the push-to-deploy workflow on the linked repository"
|
|
357
|
-
},
|
|
358
299
|
"last_commited_purge": {
|
|
359
300
|
"type": "string",
|
|
360
301
|
"description": "Last commited cache Purge",
|
|
@@ -433,6 +374,26 @@
|
|
|
433
374
|
"default": null,
|
|
434
375
|
"description": "Live versions of the app: the promoted one plus any draining (coexistence) versions"
|
|
435
376
|
},
|
|
377
|
+
"cold_state": {
|
|
378
|
+
"anyOf": [
|
|
379
|
+
{
|
|
380
|
+
"type": "string",
|
|
381
|
+
"enum": [
|
|
382
|
+
"asleep"
|
|
383
|
+
]
|
|
384
|
+
},
|
|
385
|
+
{
|
|
386
|
+
"type": "string",
|
|
387
|
+
"enum": [
|
|
388
|
+
"waking"
|
|
389
|
+
]
|
|
390
|
+
},
|
|
391
|
+
{
|
|
392
|
+
"type": "null"
|
|
393
|
+
}
|
|
394
|
+
],
|
|
395
|
+
"description": "Scale-to-zero sub-state of the promoted deployment (admin-only)"
|
|
396
|
+
},
|
|
436
397
|
"secrets_revision": {
|
|
437
398
|
"type": "string",
|
|
438
399
|
"description": "Opaque revision token; changes whenever the app secrets change",
|
|
@@ -630,6 +591,17 @@
|
|
|
630
591
|
"description": "High-level summary of where the Database is in its lifecycle",
|
|
631
592
|
"default": "UNKNOWN"
|
|
632
593
|
},
|
|
594
|
+
"notify_deploy_success": {
|
|
595
|
+
"anyOf": [
|
|
596
|
+
{
|
|
597
|
+
"type": "boolean"
|
|
598
|
+
},
|
|
599
|
+
{
|
|
600
|
+
"type": "null"
|
|
601
|
+
}
|
|
602
|
+
],
|
|
603
|
+
"description": "Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this."
|
|
604
|
+
},
|
|
633
605
|
"status": {
|
|
634
606
|
"$ref": "#/components/schemas/AppStatus"
|
|
635
607
|
},
|
|
@@ -642,6 +614,39 @@
|
|
|
642
614
|
"github_installation_id": {
|
|
643
615
|
"type": "string"
|
|
644
616
|
},
|
|
617
|
+
"github_installation_state": {
|
|
618
|
+
"anyOf": [
|
|
619
|
+
{
|
|
620
|
+
"type": "string"
|
|
621
|
+
},
|
|
622
|
+
{
|
|
623
|
+
"type": "null"
|
|
624
|
+
}
|
|
625
|
+
],
|
|
626
|
+
"description": "Platform GitHub access health, maintained by installation lifecycle webhooks. Absent/null = ok; 'deleted' | 'suspended' | 'repo_removed' = access broken until re-linked."
|
|
627
|
+
},
|
|
628
|
+
"deploy_trigger": {
|
|
629
|
+
"anyOf": [
|
|
630
|
+
{
|
|
631
|
+
"type": "string"
|
|
632
|
+
},
|
|
633
|
+
{
|
|
634
|
+
"type": "null"
|
|
635
|
+
}
|
|
636
|
+
],
|
|
637
|
+
"description": "Push-to-deploy trigger. Absent/null = 'workflow' (committed GitHub Action); 'webhook' = the push webhook creates deployments server-side (deploy v4)."
|
|
638
|
+
},
|
|
639
|
+
"deploy_gate": {
|
|
640
|
+
"anyOf": [
|
|
641
|
+
{
|
|
642
|
+
"type": "string"
|
|
643
|
+
},
|
|
644
|
+
{
|
|
645
|
+
"type": "null"
|
|
646
|
+
}
|
|
647
|
+
],
|
|
648
|
+
"description": "Wait-for-CI gate for webhook triggers. Absent/null = deploy on push; 'ci' = deploy only after the commit's check suites complete green."
|
|
649
|
+
},
|
|
645
650
|
"metadata": {
|
|
646
651
|
"type": "object",
|
|
647
652
|
"properties": {},
|
|
@@ -771,27 +776,20 @@
|
|
|
771
776
|
},
|
|
772
777
|
"instance_type": {
|
|
773
778
|
"type": "string"
|
|
779
|
+
},
|
|
780
|
+
"notify_deploy_success": {
|
|
781
|
+
"anyOf": [
|
|
782
|
+
{
|
|
783
|
+
"type": "boolean"
|
|
784
|
+
},
|
|
785
|
+
{
|
|
786
|
+
"type": "null"
|
|
787
|
+
}
|
|
788
|
+
]
|
|
774
789
|
}
|
|
775
790
|
},
|
|
776
791
|
"additionalProperties": false
|
|
777
792
|
},
|
|
778
|
-
"DeployWorkflowStatus": {
|
|
779
|
-
"type": "object",
|
|
780
|
-
"required": [
|
|
781
|
-
"configured"
|
|
782
|
-
],
|
|
783
|
-
"properties": {
|
|
784
|
-
"configured": {
|
|
785
|
-
"type": "boolean"
|
|
786
|
-
},
|
|
787
|
-
"workflow_path": {
|
|
788
|
-
"type": "string"
|
|
789
|
-
},
|
|
790
|
-
"updated": {
|
|
791
|
-
"type": "boolean"
|
|
792
|
-
}
|
|
793
|
-
}
|
|
794
|
-
},
|
|
795
793
|
"DeployBranchResult": {
|
|
796
794
|
"type": "object",
|
|
797
795
|
"required": [
|
|
@@ -804,9 +802,6 @@
|
|
|
804
802
|
},
|
|
805
803
|
"workflow_synced": {
|
|
806
804
|
"type": "boolean"
|
|
807
|
-
},
|
|
808
|
-
"workflow_path": {
|
|
809
|
-
"type": "string"
|
|
810
805
|
}
|
|
811
806
|
}
|
|
812
807
|
},
|
|
@@ -826,7 +821,8 @@
|
|
|
826
821
|
"INITIALIZING",
|
|
827
822
|
"READY",
|
|
828
823
|
"CANCELED",
|
|
829
|
-
"TERMINATING"
|
|
824
|
+
"TERMINATING",
|
|
825
|
+
"SUPERSEDED"
|
|
830
826
|
],
|
|
831
827
|
"description": "High-level summary of where the Deployment is in its lifecycle",
|
|
832
828
|
"default": "QUEUED"
|
|
@@ -844,6 +840,26 @@
|
|
|
844
840
|
"type": "string",
|
|
845
841
|
"description": "Why the deployment failed (shown to the user on ERROR)"
|
|
846
842
|
},
|
|
843
|
+
"cold_state": {
|
|
844
|
+
"anyOf": [
|
|
845
|
+
{
|
|
846
|
+
"type": "string",
|
|
847
|
+
"enum": [
|
|
848
|
+
"asleep"
|
|
849
|
+
]
|
|
850
|
+
},
|
|
851
|
+
{
|
|
852
|
+
"type": "string",
|
|
853
|
+
"enum": [
|
|
854
|
+
"waking"
|
|
855
|
+
]
|
|
856
|
+
},
|
|
857
|
+
{
|
|
858
|
+
"type": "null"
|
|
859
|
+
}
|
|
860
|
+
],
|
|
861
|
+
"description": "Scale-to-zero sub-state (admin-only): asleep, waking or null"
|
|
862
|
+
},
|
|
847
863
|
"runtime_image": {
|
|
848
864
|
"type": "string",
|
|
849
865
|
"description": "Digest-pinned runtime image stamped at first materialization (artifact deploys)"
|
|
@@ -853,9 +869,6 @@
|
|
|
853
869
|
},
|
|
854
870
|
"DeploymentSource": {
|
|
855
871
|
"type": "object",
|
|
856
|
-
"required": [
|
|
857
|
-
"manifest"
|
|
858
|
-
],
|
|
859
872
|
"properties": {
|
|
860
873
|
"manifest": {
|
|
861
874
|
"type": "array",
|
|
@@ -891,6 +904,23 @@
|
|
|
891
904
|
"minItems": 1,
|
|
892
905
|
"maxItems": 20000
|
|
893
906
|
},
|
|
907
|
+
"git": {
|
|
908
|
+
"type": "object",
|
|
909
|
+
"required": [
|
|
910
|
+
"sha"
|
|
911
|
+
],
|
|
912
|
+
"properties": {
|
|
913
|
+
"sha": {
|
|
914
|
+
"type": "string",
|
|
915
|
+
"pattern": "^[a-f0-9]{40}$"
|
|
916
|
+
},
|
|
917
|
+
"ref": {
|
|
918
|
+
"type": "string",
|
|
919
|
+
"minLength": 1,
|
|
920
|
+
"maxLength": 250
|
|
921
|
+
}
|
|
922
|
+
}
|
|
923
|
+
},
|
|
894
924
|
"plan": {
|
|
895
925
|
"type": "object",
|
|
896
926
|
"properties": {},
|
|
@@ -943,7 +973,9 @@
|
|
|
943
973
|
"version": {
|
|
944
974
|
"anyOf": [
|
|
945
975
|
{
|
|
946
|
-
"type": "string"
|
|
976
|
+
"type": "string",
|
|
977
|
+
"pattern": "^[0-9]+(\\.[0-9]+){0,2}$",
|
|
978
|
+
"maxLength": 16
|
|
947
979
|
},
|
|
948
980
|
{
|
|
949
981
|
"type": "null"
|
|
@@ -1009,6 +1041,9 @@
|
|
|
1009
1041
|
"image": {
|
|
1010
1042
|
"type": "string"
|
|
1011
1043
|
},
|
|
1044
|
+
"release": {
|
|
1045
|
+
"type": "string"
|
|
1046
|
+
},
|
|
1012
1047
|
"github_commit": {
|
|
1013
1048
|
"type": "string"
|
|
1014
1049
|
},
|
|
@@ -1021,11 +1056,25 @@
|
|
|
1021
1056
|
"github_commit_message": {
|
|
1022
1057
|
"type": "string"
|
|
1023
1058
|
},
|
|
1024
|
-
"
|
|
1025
|
-
"
|
|
1059
|
+
"artifact_id": {
|
|
1060
|
+
"type": "string"
|
|
1026
1061
|
},
|
|
1027
|
-
"
|
|
1028
|
-
"
|
|
1062
|
+
"artifact_ready_at": {
|
|
1063
|
+
"type": "string",
|
|
1064
|
+
"format": "date-time"
|
|
1065
|
+
},
|
|
1066
|
+
"redeploy_of": {
|
|
1067
|
+
"type": "string"
|
|
1068
|
+
},
|
|
1069
|
+
"trigger": {
|
|
1070
|
+
"anyOf": [
|
|
1071
|
+
{
|
|
1072
|
+
"type": "string"
|
|
1073
|
+
},
|
|
1074
|
+
{
|
|
1075
|
+
"type": "null"
|
|
1076
|
+
}
|
|
1077
|
+
]
|
|
1029
1078
|
},
|
|
1030
1079
|
"status": {
|
|
1031
1080
|
"$ref": "#/components/schemas/DeploymentStatus"
|
|
@@ -1135,6 +1184,10 @@
|
|
|
1135
1184
|
"image": {
|
|
1136
1185
|
"type": "string"
|
|
1137
1186
|
},
|
|
1187
|
+
"release": {
|
|
1188
|
+
"type": "string",
|
|
1189
|
+
"maxLength": 128
|
|
1190
|
+
},
|
|
1138
1191
|
"github_commit": {
|
|
1139
1192
|
"type": "string"
|
|
1140
1193
|
},
|
|
@@ -3575,6 +3628,17 @@
|
|
|
3575
3628
|
"description": "High-level summary of where the Database is in its lifecycle",
|
|
3576
3629
|
"default": "UNKNOWN"
|
|
3577
3630
|
},
|
|
3631
|
+
"notify_deploy_success": {
|
|
3632
|
+
"anyOf": [
|
|
3633
|
+
{
|
|
3634
|
+
"type": "boolean"
|
|
3635
|
+
},
|
|
3636
|
+
{
|
|
3637
|
+
"type": "null"
|
|
3638
|
+
}
|
|
3639
|
+
],
|
|
3640
|
+
"description": "Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this."
|
|
3641
|
+
},
|
|
3578
3642
|
"status": {
|
|
3579
3643
|
"$ref": "#/components/schemas/AppStatus"
|
|
3580
3644
|
},
|
|
@@ -3587,6 +3651,39 @@
|
|
|
3587
3651
|
"github_installation_id": {
|
|
3588
3652
|
"type": "string"
|
|
3589
3653
|
},
|
|
3654
|
+
"github_installation_state": {
|
|
3655
|
+
"anyOf": [
|
|
3656
|
+
{
|
|
3657
|
+
"type": "string"
|
|
3658
|
+
},
|
|
3659
|
+
{
|
|
3660
|
+
"type": "null"
|
|
3661
|
+
}
|
|
3662
|
+
],
|
|
3663
|
+
"description": "Platform GitHub access health, maintained by installation lifecycle webhooks. Absent/null = ok; 'deleted' | 'suspended' | 'repo_removed' = access broken until re-linked."
|
|
3664
|
+
},
|
|
3665
|
+
"deploy_trigger": {
|
|
3666
|
+
"anyOf": [
|
|
3667
|
+
{
|
|
3668
|
+
"type": "string"
|
|
3669
|
+
},
|
|
3670
|
+
{
|
|
3671
|
+
"type": "null"
|
|
3672
|
+
}
|
|
3673
|
+
],
|
|
3674
|
+
"description": "Push-to-deploy trigger. Absent/null = 'workflow' (committed GitHub Action); 'webhook' = the push webhook creates deployments server-side (deploy v4)."
|
|
3675
|
+
},
|
|
3676
|
+
"deploy_gate": {
|
|
3677
|
+
"anyOf": [
|
|
3678
|
+
{
|
|
3679
|
+
"type": "string"
|
|
3680
|
+
},
|
|
3681
|
+
{
|
|
3682
|
+
"type": "null"
|
|
3683
|
+
}
|
|
3684
|
+
],
|
|
3685
|
+
"description": "Wait-for-CI gate for webhook triggers. Absent/null = deploy on push; 'ci' = deploy only after the commit's check suites complete green."
|
|
3686
|
+
},
|
|
3590
3687
|
"metadata": {
|
|
3591
3688
|
"type": "object",
|
|
3592
3689
|
"properties": {},
|
|
@@ -3814,6 +3911,17 @@
|
|
|
3814
3911
|
"description": "High-level summary of where the Database is in its lifecycle",
|
|
3815
3912
|
"default": "UNKNOWN"
|
|
3816
3913
|
},
|
|
3914
|
+
"notify_deploy_success": {
|
|
3915
|
+
"anyOf": [
|
|
3916
|
+
{
|
|
3917
|
+
"type": "boolean"
|
|
3918
|
+
},
|
|
3919
|
+
{
|
|
3920
|
+
"type": "null"
|
|
3921
|
+
}
|
|
3922
|
+
],
|
|
3923
|
+
"description": "Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this."
|
|
3924
|
+
},
|
|
3817
3925
|
"status": {
|
|
3818
3926
|
"$ref": "#/components/schemas/AppStatus"
|
|
3819
3927
|
},
|
|
@@ -3826,6 +3934,39 @@
|
|
|
3826
3934
|
"github_installation_id": {
|
|
3827
3935
|
"type": "string"
|
|
3828
3936
|
},
|
|
3937
|
+
"github_installation_state": {
|
|
3938
|
+
"anyOf": [
|
|
3939
|
+
{
|
|
3940
|
+
"type": "string"
|
|
3941
|
+
},
|
|
3942
|
+
{
|
|
3943
|
+
"type": "null"
|
|
3944
|
+
}
|
|
3945
|
+
],
|
|
3946
|
+
"description": "Platform GitHub access health, maintained by installation lifecycle webhooks. Absent/null = ok; 'deleted' | 'suspended' | 'repo_removed' = access broken until re-linked."
|
|
3947
|
+
},
|
|
3948
|
+
"deploy_trigger": {
|
|
3949
|
+
"anyOf": [
|
|
3950
|
+
{
|
|
3951
|
+
"type": "string"
|
|
3952
|
+
},
|
|
3953
|
+
{
|
|
3954
|
+
"type": "null"
|
|
3955
|
+
}
|
|
3956
|
+
],
|
|
3957
|
+
"description": "Push-to-deploy trigger. Absent/null = 'workflow' (committed GitHub Action); 'webhook' = the push webhook creates deployments server-side (deploy v4)."
|
|
3958
|
+
},
|
|
3959
|
+
"deploy_gate": {
|
|
3960
|
+
"anyOf": [
|
|
3961
|
+
{
|
|
3962
|
+
"type": "string"
|
|
3963
|
+
},
|
|
3964
|
+
{
|
|
3965
|
+
"type": "null"
|
|
3966
|
+
}
|
|
3967
|
+
],
|
|
3968
|
+
"description": "Wait-for-CI gate for webhook triggers. Absent/null = deploy on push; 'ci' = deploy only after the commit's check suites complete green."
|
|
3969
|
+
},
|
|
3829
3970
|
"metadata": {
|
|
3830
3971
|
"type": "object",
|
|
3831
3972
|
"properties": {},
|
|
@@ -3878,6 +4019,16 @@
|
|
|
3878
4019
|
},
|
|
3879
4020
|
"instance_type": {
|
|
3880
4021
|
"type": "string"
|
|
4022
|
+
},
|
|
4023
|
+
"notify_deploy_success": {
|
|
4024
|
+
"anyOf": [
|
|
4025
|
+
{
|
|
4026
|
+
"type": "boolean"
|
|
4027
|
+
},
|
|
4028
|
+
{
|
|
4029
|
+
"type": "null"
|
|
4030
|
+
}
|
|
4031
|
+
]
|
|
3881
4032
|
}
|
|
3882
4033
|
},
|
|
3883
4034
|
"additionalProperties": false
|
|
@@ -4062,6 +4213,17 @@
|
|
|
4062
4213
|
"description": "High-level summary of where the Database is in its lifecycle",
|
|
4063
4214
|
"default": "UNKNOWN"
|
|
4064
4215
|
},
|
|
4216
|
+
"notify_deploy_success": {
|
|
4217
|
+
"anyOf": [
|
|
4218
|
+
{
|
|
4219
|
+
"type": "boolean"
|
|
4220
|
+
},
|
|
4221
|
+
{
|
|
4222
|
+
"type": "null"
|
|
4223
|
+
}
|
|
4224
|
+
],
|
|
4225
|
+
"description": "Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this."
|
|
4226
|
+
},
|
|
4065
4227
|
"status": {
|
|
4066
4228
|
"$ref": "#/components/schemas/AppStatus"
|
|
4067
4229
|
},
|
|
@@ -4074,6 +4236,39 @@
|
|
|
4074
4236
|
"github_installation_id": {
|
|
4075
4237
|
"type": "string"
|
|
4076
4238
|
},
|
|
4239
|
+
"github_installation_state": {
|
|
4240
|
+
"anyOf": [
|
|
4241
|
+
{
|
|
4242
|
+
"type": "string"
|
|
4243
|
+
},
|
|
4244
|
+
{
|
|
4245
|
+
"type": "null"
|
|
4246
|
+
}
|
|
4247
|
+
],
|
|
4248
|
+
"description": "Platform GitHub access health, maintained by installation lifecycle webhooks. Absent/null = ok; 'deleted' | 'suspended' | 'repo_removed' = access broken until re-linked."
|
|
4249
|
+
},
|
|
4250
|
+
"deploy_trigger": {
|
|
4251
|
+
"anyOf": [
|
|
4252
|
+
{
|
|
4253
|
+
"type": "string"
|
|
4254
|
+
},
|
|
4255
|
+
{
|
|
4256
|
+
"type": "null"
|
|
4257
|
+
}
|
|
4258
|
+
],
|
|
4259
|
+
"description": "Push-to-deploy trigger. Absent/null = 'workflow' (committed GitHub Action); 'webhook' = the push webhook creates deployments server-side (deploy v4)."
|
|
4260
|
+
},
|
|
4261
|
+
"deploy_gate": {
|
|
4262
|
+
"anyOf": [
|
|
4263
|
+
{
|
|
4264
|
+
"type": "string"
|
|
4265
|
+
},
|
|
4266
|
+
{
|
|
4267
|
+
"type": "null"
|
|
4268
|
+
}
|
|
4269
|
+
],
|
|
4270
|
+
"description": "Wait-for-CI gate for webhook triggers. Absent/null = deploy on push; 'ci' = deploy only after the commit's check suites complete green."
|
|
4271
|
+
},
|
|
4077
4272
|
"metadata": {
|
|
4078
4273
|
"type": "object",
|
|
4079
4274
|
"properties": {},
|
|
@@ -4281,6 +4476,17 @@
|
|
|
4281
4476
|
"description": "High-level summary of where the Database is in its lifecycle",
|
|
4282
4477
|
"default": "UNKNOWN"
|
|
4283
4478
|
},
|
|
4479
|
+
"notify_deploy_success": {
|
|
4480
|
+
"anyOf": [
|
|
4481
|
+
{
|
|
4482
|
+
"type": "boolean"
|
|
4483
|
+
},
|
|
4484
|
+
{
|
|
4485
|
+
"type": "null"
|
|
4486
|
+
}
|
|
4487
|
+
],
|
|
4488
|
+
"description": "Success deploy emails (first deploy + every promote). Absent/null = enabled; false = muted. Failure emails are never gated by this."
|
|
4489
|
+
},
|
|
4284
4490
|
"status": {
|
|
4285
4491
|
"$ref": "#/components/schemas/AppStatus"
|
|
4286
4492
|
},
|
|
@@ -4293,6 +4499,39 @@
|
|
|
4293
4499
|
"github_installation_id": {
|
|
4294
4500
|
"type": "string"
|
|
4295
4501
|
},
|
|
4502
|
+
"github_installation_state": {
|
|
4503
|
+
"anyOf": [
|
|
4504
|
+
{
|
|
4505
|
+
"type": "string"
|
|
4506
|
+
},
|
|
4507
|
+
{
|
|
4508
|
+
"type": "null"
|
|
4509
|
+
}
|
|
4510
|
+
],
|
|
4511
|
+
"description": "Platform GitHub access health, maintained by installation lifecycle webhooks. Absent/null = ok; 'deleted' | 'suspended' | 'repo_removed' = access broken until re-linked."
|
|
4512
|
+
},
|
|
4513
|
+
"deploy_trigger": {
|
|
4514
|
+
"anyOf": [
|
|
4515
|
+
{
|
|
4516
|
+
"type": "string"
|
|
4517
|
+
},
|
|
4518
|
+
{
|
|
4519
|
+
"type": "null"
|
|
4520
|
+
}
|
|
4521
|
+
],
|
|
4522
|
+
"description": "Push-to-deploy trigger. Absent/null = 'workflow' (committed GitHub Action); 'webhook' = the push webhook creates deployments server-side (deploy v4)."
|
|
4523
|
+
},
|
|
4524
|
+
"deploy_gate": {
|
|
4525
|
+
"anyOf": [
|
|
4526
|
+
{
|
|
4527
|
+
"type": "string"
|
|
4528
|
+
},
|
|
4529
|
+
{
|
|
4530
|
+
"type": "null"
|
|
4531
|
+
}
|
|
4532
|
+
],
|
|
4533
|
+
"description": "Wait-for-CI gate for webhook triggers. Absent/null = deploy on push; 'ci' = deploy only after the commit's check suites complete green."
|
|
4534
|
+
},
|
|
4296
4535
|
"metadata": {
|
|
4297
4536
|
"type": "object",
|
|
4298
4537
|
"properties": {},
|
|
@@ -4974,114 +5213,6 @@
|
|
|
4974
5213
|
}
|
|
4975
5214
|
}
|
|
4976
5215
|
},
|
|
4977
|
-
"/app/{id}/deploy-workflow": {
|
|
4978
|
-
"get": {
|
|
4979
|
-
"operationId": "app/get_deploy_workflow",
|
|
4980
|
-
"summary": "Get deploy workflow status",
|
|
4981
|
-
"tags": [
|
|
4982
|
-
"apps",
|
|
4983
|
-
"github"
|
|
4984
|
-
],
|
|
4985
|
-
"description": "Check whether the app’s linked repository has a GitHub Actions workflow that deploys to Faable.",
|
|
4986
|
-
"parameters": [
|
|
4987
|
-
{
|
|
4988
|
-
"schema": {
|
|
4989
|
-
"type": "string"
|
|
4990
|
-
},
|
|
4991
|
-
"in": "path",
|
|
4992
|
-
"name": "id",
|
|
4993
|
-
"required": true
|
|
4994
|
-
}
|
|
4995
|
-
],
|
|
4996
|
-
"security": [
|
|
4997
|
-
{
|
|
4998
|
-
"faable_user": [],
|
|
4999
|
-
"faable_cli": [],
|
|
5000
|
-
"apikey": [],
|
|
5001
|
-
"faable_machine": []
|
|
5002
|
-
}
|
|
5003
|
-
],
|
|
5004
|
-
"responses": {
|
|
5005
|
-
"200": {
|
|
5006
|
-
"description": "Default Response",
|
|
5007
|
-
"content": {
|
|
5008
|
-
"application/json": {
|
|
5009
|
-
"schema": {
|
|
5010
|
-
"type": "object",
|
|
5011
|
-
"required": [
|
|
5012
|
-
"configured"
|
|
5013
|
-
],
|
|
5014
|
-
"properties": {
|
|
5015
|
-
"configured": {
|
|
5016
|
-
"type": "boolean"
|
|
5017
|
-
},
|
|
5018
|
-
"workflow_path": {
|
|
5019
|
-
"type": "string"
|
|
5020
|
-
},
|
|
5021
|
-
"updated": {
|
|
5022
|
-
"type": "boolean"
|
|
5023
|
-
}
|
|
5024
|
-
}
|
|
5025
|
-
}
|
|
5026
|
-
}
|
|
5027
|
-
}
|
|
5028
|
-
}
|
|
5029
|
-
}
|
|
5030
|
-
},
|
|
5031
|
-
"post": {
|
|
5032
|
-
"operationId": "app/setup_deploy_workflow",
|
|
5033
|
-
"summary": "Set up deploy workflow",
|
|
5034
|
-
"tags": [
|
|
5035
|
-
"apps",
|
|
5036
|
-
"github"
|
|
5037
|
-
],
|
|
5038
|
-
"description": "Commit the Faable deploy GitHub Actions workflow to the app’s linked repository (no-op if already present; upgrades an unmodified legacy workflow).",
|
|
5039
|
-
"parameters": [
|
|
5040
|
-
{
|
|
5041
|
-
"schema": {
|
|
5042
|
-
"type": "string"
|
|
5043
|
-
},
|
|
5044
|
-
"in": "path",
|
|
5045
|
-
"name": "id",
|
|
5046
|
-
"required": true
|
|
5047
|
-
}
|
|
5048
|
-
],
|
|
5049
|
-
"security": [
|
|
5050
|
-
{
|
|
5051
|
-
"faable_user": [],
|
|
5052
|
-
"faable_cli": [],
|
|
5053
|
-
"apikey": [],
|
|
5054
|
-
"faable_machine": []
|
|
5055
|
-
}
|
|
5056
|
-
],
|
|
5057
|
-
"responses": {
|
|
5058
|
-
"200": {
|
|
5059
|
-
"description": "Default Response",
|
|
5060
|
-
"content": {
|
|
5061
|
-
"application/json": {
|
|
5062
|
-
"schema": {
|
|
5063
|
-
"type": "object",
|
|
5064
|
-
"required": [
|
|
5065
|
-
"configured"
|
|
5066
|
-
],
|
|
5067
|
-
"properties": {
|
|
5068
|
-
"configured": {
|
|
5069
|
-
"type": "boolean"
|
|
5070
|
-
},
|
|
5071
|
-
"workflow_path": {
|
|
5072
|
-
"type": "string"
|
|
5073
|
-
},
|
|
5074
|
-
"updated": {
|
|
5075
|
-
"type": "boolean"
|
|
5076
|
-
}
|
|
5077
|
-
}
|
|
5078
|
-
}
|
|
5079
|
-
}
|
|
5080
|
-
}
|
|
5081
|
-
}
|
|
5082
|
-
}
|
|
5083
|
-
}
|
|
5084
|
-
},
|
|
5085
5216
|
"/app/{id}/deploy-branch": {
|
|
5086
5217
|
"post": {
|
|
5087
5218
|
"operationId": "app/set_deploy_branch",
|
|
@@ -5090,7 +5221,7 @@
|
|
|
5090
5221
|
"apps",
|
|
5091
5222
|
"github"
|
|
5092
5223
|
],
|
|
5093
|
-
"description": "Change the branch the app deploys from.
|
|
5224
|
+
"description": "Change the branch the app deploys from. Apps deploying from their own GitHub Actions workflow must update the branch trigger in the workflow file themselves.",
|
|
5094
5225
|
"requestBody": {
|
|
5095
5226
|
"required": true,
|
|
5096
5227
|
"content": {
|
|
@@ -5147,9 +5278,6 @@
|
|
|
5147
5278
|
},
|
|
5148
5279
|
"workflow_synced": {
|
|
5149
5280
|
"type": "boolean"
|
|
5150
|
-
},
|
|
5151
|
-
"workflow_path": {
|
|
5152
|
-
"type": "string"
|
|
5153
5281
|
}
|
|
5154
5282
|
}
|
|
5155
5283
|
}
|
|
@@ -5274,6 +5402,10 @@
|
|
|
5274
5402
|
"image": {
|
|
5275
5403
|
"type": "string"
|
|
5276
5404
|
},
|
|
5405
|
+
"release": {
|
|
5406
|
+
"type": "string",
|
|
5407
|
+
"maxLength": 128
|
|
5408
|
+
},
|
|
5277
5409
|
"github_commit": {
|
|
5278
5410
|
"type": "string"
|
|
5279
5411
|
},
|
|
@@ -5334,6 +5466,9 @@
|
|
|
5334
5466
|
"image": {
|
|
5335
5467
|
"type": "string"
|
|
5336
5468
|
},
|
|
5469
|
+
"release": {
|
|
5470
|
+
"type": "string"
|
|
5471
|
+
},
|
|
5337
5472
|
"github_commit": {
|
|
5338
5473
|
"type": "string"
|
|
5339
5474
|
},
|
|
@@ -5346,11 +5481,25 @@
|
|
|
5346
5481
|
"github_commit_message": {
|
|
5347
5482
|
"type": "string"
|
|
5348
5483
|
},
|
|
5349
|
-
"
|
|
5350
|
-
"
|
|
5484
|
+
"artifact_id": {
|
|
5485
|
+
"type": "string"
|
|
5486
|
+
},
|
|
5487
|
+
"artifact_ready_at": {
|
|
5488
|
+
"type": "string",
|
|
5489
|
+
"format": "date-time"
|
|
5351
5490
|
},
|
|
5352
|
-
"
|
|
5353
|
-
"
|
|
5491
|
+
"redeploy_of": {
|
|
5492
|
+
"type": "string"
|
|
5493
|
+
},
|
|
5494
|
+
"trigger": {
|
|
5495
|
+
"anyOf": [
|
|
5496
|
+
{
|
|
5497
|
+
"type": "string"
|
|
5498
|
+
},
|
|
5499
|
+
{
|
|
5500
|
+
"type": "null"
|
|
5501
|
+
}
|
|
5502
|
+
]
|
|
5354
5503
|
},
|
|
5355
5504
|
"status": {
|
|
5356
5505
|
"$ref": "#/components/schemas/DeploymentStatus"
|
|
@@ -5434,6 +5583,9 @@
|
|
|
5434
5583
|
"image": {
|
|
5435
5584
|
"type": "string"
|
|
5436
5585
|
},
|
|
5586
|
+
"release": {
|
|
5587
|
+
"type": "string"
|
|
5588
|
+
},
|
|
5437
5589
|
"github_commit": {
|
|
5438
5590
|
"type": "string"
|
|
5439
5591
|
},
|
|
@@ -5446,11 +5598,25 @@
|
|
|
5446
5598
|
"github_commit_message": {
|
|
5447
5599
|
"type": "string"
|
|
5448
5600
|
},
|
|
5449
|
-
"
|
|
5450
|
-
"
|
|
5601
|
+
"artifact_id": {
|
|
5602
|
+
"type": "string"
|
|
5603
|
+
},
|
|
5604
|
+
"artifact_ready_at": {
|
|
5605
|
+
"type": "string",
|
|
5606
|
+
"format": "date-time"
|
|
5451
5607
|
},
|
|
5452
|
-
"
|
|
5453
|
-
"
|
|
5608
|
+
"redeploy_of": {
|
|
5609
|
+
"type": "string"
|
|
5610
|
+
},
|
|
5611
|
+
"trigger": {
|
|
5612
|
+
"anyOf": [
|
|
5613
|
+
{
|
|
5614
|
+
"type": "string"
|
|
5615
|
+
},
|
|
5616
|
+
{
|
|
5617
|
+
"type": "null"
|
|
5618
|
+
}
|
|
5619
|
+
]
|
|
5454
5620
|
},
|
|
5455
5621
|
"status": {
|
|
5456
5622
|
"$ref": "#/components/schemas/DeploymentStatus"
|
|
@@ -5553,6 +5719,9 @@
|
|
|
5553
5719
|
"image": {
|
|
5554
5720
|
"type": "string"
|
|
5555
5721
|
},
|
|
5722
|
+
"release": {
|
|
5723
|
+
"type": "string"
|
|
5724
|
+
},
|
|
5556
5725
|
"github_commit": {
|
|
5557
5726
|
"type": "string"
|
|
5558
5727
|
},
|
|
@@ -5565,11 +5734,25 @@
|
|
|
5565
5734
|
"github_commit_message": {
|
|
5566
5735
|
"type": "string"
|
|
5567
5736
|
},
|
|
5568
|
-
"
|
|
5569
|
-
"
|
|
5737
|
+
"artifact_id": {
|
|
5738
|
+
"type": "string"
|
|
5739
|
+
},
|
|
5740
|
+
"artifact_ready_at": {
|
|
5741
|
+
"type": "string",
|
|
5742
|
+
"format": "date-time"
|
|
5570
5743
|
},
|
|
5571
|
-
"
|
|
5572
|
-
"
|
|
5744
|
+
"redeploy_of": {
|
|
5745
|
+
"type": "string"
|
|
5746
|
+
},
|
|
5747
|
+
"trigger": {
|
|
5748
|
+
"anyOf": [
|
|
5749
|
+
{
|
|
5750
|
+
"type": "string"
|
|
5751
|
+
},
|
|
5752
|
+
{
|
|
5753
|
+
"type": "null"
|
|
5754
|
+
}
|
|
5755
|
+
]
|
|
5573
5756
|
},
|
|
5574
5757
|
"status": {
|
|
5575
5758
|
"$ref": "#/components/schemas/DeploymentStatus"
|
|
@@ -5651,6 +5834,9 @@
|
|
|
5651
5834
|
"image": {
|
|
5652
5835
|
"type": "string"
|
|
5653
5836
|
},
|
|
5837
|
+
"release": {
|
|
5838
|
+
"type": "string"
|
|
5839
|
+
},
|
|
5654
5840
|
"github_commit": {
|
|
5655
5841
|
"type": "string"
|
|
5656
5842
|
},
|
|
@@ -5663,11 +5849,25 @@
|
|
|
5663
5849
|
"github_commit_message": {
|
|
5664
5850
|
"type": "string"
|
|
5665
5851
|
},
|
|
5666
|
-
"
|
|
5667
|
-
"
|
|
5852
|
+
"artifact_id": {
|
|
5853
|
+
"type": "string"
|
|
5854
|
+
},
|
|
5855
|
+
"artifact_ready_at": {
|
|
5856
|
+
"type": "string",
|
|
5857
|
+
"format": "date-time"
|
|
5668
5858
|
},
|
|
5669
|
-
"
|
|
5670
|
-
"
|
|
5859
|
+
"redeploy_of": {
|
|
5860
|
+
"type": "string"
|
|
5861
|
+
},
|
|
5862
|
+
"trigger": {
|
|
5863
|
+
"anyOf": [
|
|
5864
|
+
{
|
|
5865
|
+
"type": "string"
|
|
5866
|
+
},
|
|
5867
|
+
{
|
|
5868
|
+
"type": "null"
|
|
5869
|
+
}
|
|
5870
|
+
]
|
|
5671
5871
|
},
|
|
5672
5872
|
"status": {
|
|
5673
5873
|
"$ref": "#/components/schemas/DeploymentStatus"
|