-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathoverlay.yaml
3703 lines (3703 loc) · 174 KB
/
overlay.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
overlay: 1.0.0
info:
title: Overlay vercel-api.yaml => vercel-api-suggest.yaml
version: 0.0.0
actions:
- target: $
update:
tags:
- name: access-groups
description: Access Groups
- name: artifacts
description: Artifacts
- name: billing
description: Billing
- name: deployments
description: Deployments
- name: domains
description: Domains
- name: env
description: Environment Variables
- name: events
description: Events
- name: files
description: Files
- name: git
description: Git
- name: integrations
description: Integrations
- name: projects
description: Projects
- name: secrets
description: Secrets
- name: teams
description: Teams
- name: user
description: User
- name: webhooks
description: Webhooks
- target: $["paths"]["/v1/access-groups/{idOrName}"]["get"]
update:
x-speakeasy-group: accessGroups
- target: $["paths"]["/v1/access-groups/{idOrName}"]["get"]
update:
x-speakeasy-name-override: read
- target: $["paths"]["/v1/access-groups/{idOrName}"]["post"]
update:
x-speakeasy-group: accessGroups
- target: $["paths"]["/v1/access-groups/{idOrName}"]["post"]
update:
x-speakeasy-name-override: update
- target: $["paths"]["/v1/access-groups/{idOrName}"]["delete"]
update:
x-speakeasy-group: accessGroups
- target: $["paths"]["/v1/access-groups/{idOrName}"]["delete"]
update:
x-speakeasy-name-override: delete
- target: $["paths"]["/v1/access-groups/{idOrName}/members"]["get"]
update:
x-speakeasy-group: accessGroups
- target: $["paths"]["/v1/access-groups/{idOrName}/members"]["get"]
update:
x-speakeasy-name-override: listMembers
- target: $["paths"]["/v1/access-groups"]["get"]
update:
x-speakeasy-group: accessGroups
- target: $["paths"]["/v1/access-groups"]["get"]
update:
x-speakeasy-name-override: list
- target: $["paths"]["/v1/access-groups"]["post"]
update:
x-speakeasy-group: accessGroups
- target: $["paths"]["/v1/access-groups"]["post"]
update:
x-speakeasy-name-override: create
- target: $["paths"]["/v1/access-groups/{idOrName}/projects"]["get"]
update:
x-speakeasy-group: accessGroups
- target: $["paths"]["/v1/access-groups/{idOrName}/projects"]["get"]
update:
x-speakeasy-name-override: listProjects
- target: $["paths"]["/v8/artifacts/{hash}"]["put"]
update:
x-speakeasy-name-override: upload
- target: $["paths"]["/v8/artifacts/{hash}"]["get"]
update:
x-speakeasy-name-override: download
- target: $["paths"]["/v8/artifacts/{hash}"]["head"]
update:
x-speakeasy-name-override: exists
- target: $["paths"]["/v8/artifacts"]["post"]
update:
x-speakeasy-name-override: query
- target: $["paths"]["/deployments/{deploymentId}/builds"]["get"]
update:
operationId: listDeploymentBuilds
- target: $["paths"]["/v1/deployments/{deploymentId}/checks"]["post"]
update:
x-speakeasy-name-override: create
- target: $["paths"]["/v1/deployments/{deploymentId}/checks"]["get"]
update:
x-speakeasy-name-override: list
- target: $["paths"]["/v1/deployments/{deploymentId}/checks/{checkId}"]["get"]
update:
x-speakeasy-name-override: get
- target: $["paths"]["/v1/deployments/{deploymentId}/checks/{checkId}"]["patch"]
update:
x-speakeasy-name-override: update
- target: $["paths"]["/v1/deployments/{deploymentId}/checks/{checkId}/rerequest"]["post"]
update:
x-speakeasy-name-override: rerequest
- target: $["paths"]["/data-cache/purge-all"]["delete"]
update:
operationId: datacachePurgeall
- target: $["paths"]["/data-cache/billing-settings"]["patch"]
update:
operationId: dataCacheBillingSettings
- target: $["paths"]["/v1/data-cache/projects/{projectId}"]["patch"]["responses"]["200"]["content"]["application/json"]["schema"]["properties"]["env"]["items"]["properties"]["target"]["oneOf"][0]["items"]["enum"][*]
remove: true
- target: $["paths"]["/v1/data-cache/projects/{projectId}"]["patch"]["responses"]["200"]["content"]["application/json"]["schema"]["properties"]["env"]["items"]["properties"]["target"]["oneOf"][0]["items"]["enum"]
update:
- production
- preview
- development
- target: $["paths"]["/v1/data-cache/projects/{projectId}"]["patch"]["responses"]["200"]["content"]["application/json"]["schema"]["properties"]["env"]["items"]["properties"]["target"]["oneOf"][1]["enum"][*]
remove: true
- target: $["paths"]["/v1/data-cache/projects/{projectId}"]["patch"]["responses"]["200"]["content"]["application/json"]["schema"]["properties"]["env"]["items"]["properties"]["target"]["oneOf"][1]["enum"]
update:
- production
- preview
- development
- target: $["paths"]["/v1/data-cache/projects/{projectId}"]["patch"]["responses"]["200"]["content"]["application/json"]["schema"]["properties"]["permissions"]["properties"]
update:
marketplaceInstallationMember:
items:
$ref: '#/components/schemas/ACLAction'
type: array
- target: $["paths"]["/v1/data-cache/projects/{projectId}"]["patch"]
update:
x-speakeasy-name-override: updateDataCache
- target: $["paths"]["/v3/deployments/{idOrUrl}/events"]["get"]
update:
x-speakeasy-name-override: getEvents
- target: $["paths"]
update:
/v13/deployments/{idOrUrl}#idOrUrl:
get:
description: >-
Retrieves information for a deployment either by supplying its ID (`id` property) or Hostname (`url` property). Additional details will be included when the authenticated user or team is an owner of the deployment.
operationId: getDeployment
security:
- bearerToken: []
summary: Get a deployment by ID or URL
tags:
- deployments
responses:
'200':
description: |-
The deployment including only public information
The deployment including both public and private information
content:
application/json:
schema:
oneOf:
- properties:
aliasAssignedAt:
nullable: true
oneOf:
- type: number
- type: boolean
alwaysRefuseToBuild:
type: boolean
build:
properties:
env:
items:
type: string
type: array
required:
- env
type: object
buildArtifactUrls:
items:
type: string
type: array
builds:
items:
type: object
type: array
env:
items:
type: string
type: array
inspectorUrl:
nullable: true
type: string
isInConcurrentBuildsQueue:
type: boolean
projectSettings:
properties:
buildCommand:
nullable: true
type: string
devCommand:
nullable: true
type: string
framework:
nullable: true
type: string
enum:
- blitzjs
- nextjs
- gatsby
- remix
- astro
- hexo
- eleventy
- docusaurus-2
- docusaurus
- preact
- solidstart-1
- solidstart
- dojo
- ember
- vue
- scully
- ionic-angular
- angular
- polymer
- svelte
- sveltekit
- sveltekit-1
- ionic-react
- create-react-app
- gridsome
- umijs
- sapper
- saber
- stencil
- nuxtjs
- redwoodjs
- hugo
- jekyll
- brunch
- middleman
- zola
- hydrogen
- vite
- vitepress
- vuepress
- parcel
- fasthtml
- sanity
- storybook
commandForIgnoringBuildStep:
nullable: true
type: string
installCommand:
nullable: true
type: string
outputDirectory:
nullable: true
type: string
speedInsights:
properties:
id:
type: string
enabledAt:
type: number
disabledAt:
type: number
canceledAt:
type: number
hasData:
type: boolean
paidAt:
type: number
required:
- id
type: object
webAnalytics:
properties:
id:
type: string
disabledAt:
type: number
canceledAt:
type: number
enabledAt:
type: number
hasData:
type: boolean
required:
- id
type: object
type: object
readyStateReason:
type: string
alias:
items:
type: string
type: array
aliasAssigned:
type: boolean
bootedAt:
type: number
buildingAt:
type: number
buildSkipped:
type: boolean
creator:
properties:
uid:
type: string
username:
type: string
avatar:
type: string
required:
- uid
type: object
initReadyAt:
type: number
isFirstBranchDeployment:
type: boolean
lambdas:
items:
properties:
id:
type: string
createdAt:
type: number
entrypoint:
nullable: true
type: string
readyState:
type: string
enum:
- BUILDING
- ERROR
- INITIALIZING
- READY
readyStateAt:
type: number
output:
items:
properties:
path:
type: string
functionName:
type: string
required:
- path
- functionName
type: object
type: array
required:
- output
type: object
description: >-
A partial representation of a Build used by the deployment endpoint.
type: array
public:
type: boolean
ready:
type: number
status:
type: string
enum:
- QUEUED
- BUILDING
- ERROR
- INITIALIZING
- READY
- CANCELED
team:
properties:
id:
type: string
name:
type: string
slug:
type: string
avatar:
type: string
required:
- id
- name
- slug
type: object
userAliases:
items:
type: string
type: array
previewCommentsEnabled:
type: boolean
ttyBuildLogs:
type: boolean
customEnvironment:
oneOf:
- properties:
id:
type: string
name:
type: string
slug:
type: string
type:
type: string
enum:
- production
- preview
- development
description:
type: string
branchMatcher:
properties:
type:
type: string
enum:
- startsWith
- equals
- endsWith
pattern:
type: string
required:
- type
- pattern
type: object
createdAt:
type: number
updatedAt:
type: number
domains:
items:
properties:
name:
type: string
apexName:
type: string
projectId:
type: string
redirect:
nullable: true
type: string
redirectStatusCode:
nullable: true
type: number
enum:
- 307
- 301
- 302
- 308
gitBranch:
nullable: true
type: string
customEnvironmentId:
nullable: true
type: string
updatedAt:
type: number
createdAt:
type: number
verified:
type: boolean
description: >-
`true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed.
verification:
items:
properties:
type:
type: string
domain:
type: string
value:
type: string
reason:
type: string
required:
- type
- domain
- value
- reason
type: object
description: >-
A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`.
type: array
description: >-
A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain. Possible challenges: - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`.
required:
- name
- apexName
- projectId
- verified
type: object
type: array
required:
- id
- name
- slug
- type
- createdAt
- updatedAt
type: object
- properties:
id:
type: string
required:
- id
type: object
aliasWarning:
nullable: true
properties:
code:
type: string
message:
type: string
link:
type: string
action:
type: string
required:
- code
- message
type: object
id:
type: string
type:
type: string
enum:
- LAMBDAS
createdAt:
type: number
name:
type: string
readyState:
type: string
enum:
- QUEUED
- BUILDING
- ERROR
- INITIALIZING
- READY
- CANCELED
aliasError:
nullable: true
properties:
code:
type: string
message:
type: string
required:
- code
- message
type: object
aliasFinal:
nullable: true
type: string
autoAssignCustomDomains:
type: boolean
description: applies to custom domains only, defaults to `true`
automaticAliases:
items:
type: string
type: array
buildErrorAt:
type: number
checksState:
type: string
enum:
- registered
- running
- completed
checksConclusion:
type: string
enum:
- succeeded
- failed
- skipped
- canceled
deletedAt:
nullable: true
type: number
canceledAt:
type: number
errorCode:
type: string
errorLink:
type: string
errorMessage:
nullable: true
type: string
errorStep:
type: string
passiveRegions:
items:
type: string
type: array
description: >-
Since November 2023 this field defines a set of regions that we will deploy the lambda to passively Lambdas will be deployed to these regions but only invoked if all of the primary `regions` are marked as out of service
gitSource:
oneOf:
- properties:
type:
type: string
enum:
- github
repoId:
oneOf:
- type: string
- type: number
ref:
nullable: true
type: string
sha:
type: string
prId:
nullable: true
type: number
required:
- type
- repoId
type: object
- properties:
type:
type: string
enum:
- github
org:
type: string
repo:
type: string
ref:
nullable: true
type: string
sha:
type: string
prId:
nullable: true
type: number
required:
- type
- org
- repo
type: object
- properties:
type:
type: string
enum:
- gitlab
projectId:
oneOf:
- type: string
- type: number
ref:
nullable: true
type: string
sha:
type: string
prId:
nullable: true
type: number
required:
- type
- projectId
type: object
- properties:
type:
type: string
enum:
- bitbucket
workspaceUuid:
type: string
repoUuid:
type: string
ref:
nullable: true
type: string
sha:
type: string
prId:
nullable: true
type: number
required:
- type
- repoUuid
type: object
- properties:
type:
type: string
enum:
- bitbucket
owner:
type: string
slug:
type: string
ref:
nullable: true
type: string
sha:
type: string
prId:
nullable: true
type: number
required:
- type
- owner
- slug
type: object
- properties:
type:
type: string
enum:
- custom
ref:
type: string
sha:
type: string
gitUrl:
type: string
required:
- type
- ref
- sha
- gitUrl
type: object
- properties:
type:
type: string
enum:
- github
ref:
type: string
sha:
type: string
repoId:
type: number
org:
type: string
repo:
type: string
required:
- type
- ref
- sha
- repoId
type: object
- properties:
type:
type: string
enum:
- gitlab
ref:
type: string
sha:
type: string
projectId:
type: number
required:
- type
- ref
- sha
- projectId
type: object
- properties:
type:
type: string
enum:
- bitbucket
ref:
type: string
sha:
type: string
owner:
type: string
slug:
type: string
workspaceUuid:
type: string
repoUuid:
type: string
required:
- type
- ref
- sha
- workspaceUuid
- repoUuid
type: object
meta:
additionalProperties:
type: string
type: object
project:
properties:
id:
type: string
name:
type: string
framework:
nullable: true
type: string
required:
- id
- name
type: object
readySubstate:
type: string
enum:
- STAGED
- PROMOTED
description: >-
Since June 2023 Substate of deployment when readyState is 'READY' Tracks whether or not deployment has seen production traffic: - STAGED: never seen production traffic - PROMOTED: has seen production traffic
regions:
items:
type: string
type: array
softDeletedByRetention:
type: boolean
source:
type: string
enum:
- api-trigger-git-deploy
- cli
- clone/repo
- git
- import
- import/repo
- redeploy
target:
nullable: true
type: string
enum:
- staging
- production
undeletedAt:
type: number
url:
type: string
version:
type: number
enum:
- 2
oidcTokenClaims:
type: object
additionalProperties:
oneOf:
- type: string
- items:
type: string
type: array
projectId:
type: string
plan:
type: string
enum:
- pro
- enterprise
- hobby
connectBuildsEnabled:
type: boolean
connectConfigurationId:
type: string
createdIn:
type: string
crons:
items:
properties:
schedule:
type: string
path:
type: string
required:
- schedule
- path
type: object
type: array
functions:
nullable: true
additionalProperties:
properties:
memory:
type: number
maxDuration:
type: number
runtime:
type: string
includeFiles:
type: string
excludeFiles:
type: string
type: object
type: object
monorepoManager:
nullable: true
type: string
ownerId:
type: string
passiveConnectConfigurationId:
type: string
description: >-
Since November 2023 this field defines a connect configuration that will only be used to deploy passive lambdas to (as in passiveRegions)
routes:
nullable: true
items:
oneOf:
- properties:
src:
type: string
dest:
type: string
headers:
additionalProperties:
type: string
type: object
methods:
items:
type: string
type: array
continue:
type: boolean
override:
type: boolean
caseSensitive:
type: boolean
check:
type: boolean
important:
type: boolean
status:
type: number
has:
items:
oneOf:
- properties:
type:
type: string
enum:
- host
value:
type: string
required:
- type
- value
type: object
- properties:
type:
type: string
enum:
- header
- cookie
- query
key:
type: string
value:
type: string
required:
- type
- key
type: object
type: array
missing:
items:
oneOf:
- properties:
type:
type: string
enum:
- host
value:
type: string
required:
- type
- value
type: object
- properties:
type:
type: string
enum:
- header
- cookie
- query
key:
type: string
value:
type: string
required:
- type
- key
type: object
type: array
locale:
properties:
redirect:
additionalProperties:
type: string
type: object
cookie:
type: string
type: object
middlewarePath:
type: string