-
Notifications
You must be signed in to change notification settings - Fork 316
Expand file tree
/
Copy pathopenapi-dashboard.yml
More file actions
925 lines (882 loc) · 22.3 KB
/
openapi-dashboard.yml
File metadata and controls
925 lines (882 loc) · 22.3 KB
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
openapi: "3.0.0"
info:
version: 0.1.0
title: E2B Dashboard API
components:
securitySchemes:
AdminTokenAuth:
type: apiKey
in: header
name: X-Admin-Token
Supabase1TokenAuth:
type: apiKey
in: header
name: X-Supabase-Token
Supabase2TeamAuth:
type: apiKey
in: header
name: X-Supabase-Team
parameters:
build_id:
name: build_id
in: path
required: true
description: Identifier of the build.
schema:
type: string
format: uuid
sandboxID:
name: sandboxID
in: path
required: true
description: Identifier of the sandbox.
schema:
type: string
builds_limit:
name: limit
in: query
required: false
description: Maximum number of items to return per page.
schema:
type: integer
format: int32
minimum: 1
maximum: 100
default: 50
builds_cursor:
name: cursor
in: query
required: false
description: Cursor returned by the previous list response in `created_at|build_id` format.
schema:
type: string
build_id_or_template:
name: build_id_or_template
in: query
required: false
description: Optional filter by build identifier, template identifier, or template alias.
schema:
type: string
build_statuses:
name: statuses
in: query
required: false
description: Comma-separated list of build statuses to include.
style: form
explode: false
schema:
type: array
items:
$ref: "#/components/schemas/BuildStatus"
build_ids:
name: build_ids
in: query
required: true
description: Comma-separated list of build IDs to get statuses for.
style: form
explode: false
schema:
type: array
items:
type: string
format: uuid
maxItems: 100
uniqueItems: true
teamID:
name: teamID
in: path
required: true
description: Identifier of the team.
schema:
type: string
format: uuid
userId:
name: userId
in: path
required: true
description: Identifier of the user.
schema:
type: string
format: uuid
teamSlug:
name: slug
in: query
required: true
description: Team slug to resolve.
schema:
type: string
responses:
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"401":
description: Authentication error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"403":
description: Forbidden
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"404":
description: Not found
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
"500":
description: Server error
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
schemas:
Error:
type: object
required:
- code
- message
properties:
code:
type: integer
format: int32
description: Error code.
message:
type: string
description: Error message.
BuildStatus:
type: string
description: Build status mapped for dashboard clients.
enum:
- building
- failed
- success
ListedBuild:
type: object
required:
- id
- template
- templateId
- status
- statusMessage
- createdAt
- finishedAt
properties:
id:
type: string
format: uuid
description: Identifier of the build.
template:
type: string
description: Template alias when present, otherwise template ID.
templateId:
type: string
description: Identifier of the template.
status:
$ref: "#/components/schemas/BuildStatus"
statusMessage:
type: string
nullable: true
description: Failure message when status is `failed`, otherwise `null`.
createdAt:
type: string
format: date-time
description: Build creation timestamp in RFC3339 format.
finishedAt:
type: string
format: date-time
nullable: true
description: Build completion timestamp in RFC3339 format, if finished.
BuildsListResponse:
type: object
required:
- data
- nextCursor
properties:
data:
type: array
items:
$ref: "#/components/schemas/ListedBuild"
nextCursor:
type: string
nullable: true
description: Cursor to pass to the next list request, or `null` if there is no next page.
BuildStatusItem:
type: object
required:
- id
- status
- finishedAt
- statusMessage
properties:
id:
type: string
format: uuid
description: Identifier of the build.
status:
$ref: "#/components/schemas/BuildStatus"
finishedAt:
type: string
format: date-time
nullable: true
description: Build completion timestamp in RFC3339 format, if finished.
statusMessage:
type: string
nullable: true
description: Failure message when status is `failed`, otherwise `null`.
BuildsStatusesResponse:
type: object
required:
- buildStatuses
properties:
buildStatuses:
type: array
description: List of build statuses
items:
$ref: "#/components/schemas/BuildStatusItem"
BuildInfo:
type: object
required:
- createdAt
- finishedAt
- status
- statusMessage
properties:
names:
type: array
items:
type: string
nullable: true
description: Template names related to this build, if available.
createdAt:
type: string
format: date-time
description: Build creation timestamp in RFC3339 format.
finishedAt:
type: string
format: date-time
nullable: true
description: Build completion timestamp in RFC3339 format, if finished.
status:
$ref: "#/components/schemas/BuildStatus"
statusMessage:
type: string
nullable: true
description: Failure message when status is `failed`, otherwise `null`.
CPUCount:
type: integer
format: int64
minimum: 1
description: CPU cores for the sandbox
MemoryMB:
type: integer
format: int64
minimum: 128
description: Memory for the sandbox in MiB
DiskSizeMB:
type: integer
format: int64
minimum: 0
description: Disk size for the sandbox in MiB
SandboxRecord:
type: object
required:
- templateID
- sandboxID
- startedAt
- cpuCount
- memoryMB
- diskSizeMB
properties:
templateID:
type: string
description: Identifier of the template from which is the sandbox created
alias:
type: string
description: Alias of the template
sandboxID:
type: string
description: Identifier of the sandbox
startedAt:
type: string
format: date-time
description: Time when the sandbox was started
stoppedAt:
type: string
format: date-time
nullable: true
description: Time when the sandbox was stopped
domain:
type: string
nullable: true
description: Base domain where the sandbox traffic is accessible
cpuCount:
$ref: "#/components/schemas/CPUCount"
memoryMB:
$ref: "#/components/schemas/MemoryMB"
diskSizeMB:
$ref: "#/components/schemas/DiskSizeMB"
HealthResponse:
type: object
required:
- message
properties:
message:
type: string
description: Human-readable health check result.
UserTeamLimits:
type: object
required:
- maxLengthHours
- concurrentSandboxes
- concurrentTemplateBuilds
- maxVcpu
- maxRamMb
- diskMb
properties:
maxLengthHours:
type: integer
format: int64
concurrentSandboxes:
type: integer
format: int32
concurrentTemplateBuilds:
type: integer
format: int32
maxVcpu:
type: integer
format: int32
maxRamMb:
type: integer
format: int32
diskMb:
type: integer
format: int32
UserTeam:
type: object
required:
- id
- name
- slug
- tier
- email
- profilePictureUrl
- isBlocked
- isBanned
- blockedReason
- isDefault
- limits
- createdAt
properties:
id:
type: string
format: uuid
name:
type: string
slug:
type: string
tier:
type: string
email:
type: string
profilePictureUrl:
type: string
nullable: true
isBlocked:
type: boolean
isBanned:
type: boolean
blockedReason:
type: string
nullable: true
isDefault:
type: boolean
limits:
$ref: "#/components/schemas/UserTeamLimits"
createdAt:
type: string
format: date-time
UserTeamsResponse:
type: object
required:
- teams
properties:
teams:
type: array
items:
$ref: "#/components/schemas/UserTeam"
TeamMember:
type: object
required:
- id
- email
- isDefault
- createdAt
properties:
id:
type: string
format: uuid
email:
type: string
isDefault:
type: boolean
addedBy:
type: string
format: uuid
nullable: true
createdAt:
type: string
format: date-time
nullable: true
TeamMembersResponse:
type: object
required:
- members
properties:
members:
type: array
items:
$ref: "#/components/schemas/TeamMember"
UpdateTeamRequest:
type: object
minProperties: 1
properties:
name:
type: string
minLength: 1
maxLength: 255
profilePictureUrl:
type: string
nullable: true
UpdateTeamResponse:
type: object
required:
- id
- name
properties:
id:
type: string
format: uuid
name:
type: string
profilePictureUrl:
type: string
nullable: true
AddTeamMemberRequest:
type: object
required:
- email
properties:
email:
type: string
format: email
CreateTeamRequest:
type: object
required:
- name
properties:
name:
type: string
minLength: 1
maxLength: 255
DefaultTemplateAlias:
type: object
required:
- alias
properties:
alias:
type: string
namespace:
type: string
nullable: true
DefaultTemplate:
type: object
required:
- id
- aliases
- buildId
- ramMb
- vcpu
- totalDiskSizeMb
- createdAt
- public
- buildCount
- spawnCount
properties:
id:
type: string
aliases:
type: array
items:
$ref: "#/components/schemas/DefaultTemplateAlias"
buildId:
type: string
format: uuid
ramMb:
type: integer
format: int64
vcpu:
type: integer
format: int64
totalDiskSizeMb:
type: integer
format: int64
nullable: true
envdVersion:
type: string
nullable: true
createdAt:
type: string
format: date-time
public:
type: boolean
buildCount:
type: integer
format: int32
spawnCount:
type: integer
format: int64
DefaultTemplatesResponse:
type: object
required:
- templates
properties:
templates:
type: array
items:
$ref: "#/components/schemas/DefaultTemplate"
TeamResolveResponse:
type: object
required:
- id
- slug
properties:
id:
type: string
format: uuid
slug:
type: string
tags:
- name: builds
- name: sandboxes
- name: teams
- name: templates
paths:
/health:
get:
summary: Health check
responses:
"200":
description: Health check successful
content:
application/json:
schema:
$ref: "#/components/schemas/HealthResponse"
/builds:
get:
summary: List team builds
tags: [builds]
security:
- Supabase1TokenAuth: []
Supabase2TeamAuth: []
parameters:
- $ref: "#/components/parameters/build_id_or_template"
- $ref: "#/components/parameters/build_statuses"
- $ref: "#/components/parameters/builds_limit"
- $ref: "#/components/parameters/builds_cursor"
responses:
"200":
description: Successfully returned paginated builds.
content:
application/json:
schema:
$ref: "#/components/schemas/BuildsListResponse"
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"500":
$ref: "#/components/responses/500"
/builds/statuses:
get:
summary: Get build statuses
tags: [builds]
security:
- Supabase1TokenAuth: []
Supabase2TeamAuth: []
parameters:
- $ref: "#/components/parameters/build_ids"
responses:
"200":
description: Successfully returned build statuses
content:
application/json:
schema:
$ref: "#/components/schemas/BuildsStatusesResponse"
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"500":
$ref: "#/components/responses/500"
/builds/{build_id}:
get:
summary: Get build details
tags: [builds]
security:
- Supabase1TokenAuth: []
Supabase2TeamAuth: []
parameters:
- $ref: "#/components/parameters/build_id"
responses:
"200":
description: Successfully returned build details.
content:
application/json:
schema:
$ref: "#/components/schemas/BuildInfo"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"500":
$ref: "#/components/responses/500"
/sandboxes/{sandboxID}/record:
get:
summary: Get sandbox record
tags: [sandboxes]
security:
- Supabase1TokenAuth: []
Supabase2TeamAuth: []
parameters:
- $ref: "#/components/parameters/sandboxID"
responses:
"200":
description: Successfully returned sandbox details.
content:
application/json:
schema:
$ref: "#/components/schemas/SandboxRecord"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"500":
$ref: "#/components/responses/500"
/teams:
get:
summary: List user teams
description: Returns all teams the authenticated user belongs to, with limits and default flag.
tags: [teams]
security:
- Supabase1TokenAuth: []
responses:
"200":
description: Successfully returned user teams.
content:
application/json:
schema:
$ref: "#/components/schemas/UserTeamsResponse"
"401":
$ref: "#/components/responses/401"
"500":
$ref: "#/components/responses/500"
post:
summary: Create team
tags: [teams]
security:
- Supabase1TokenAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateTeamRequest"
responses:
"200":
description: Successfully created team.
content:
application/json:
schema:
$ref: "#/components/schemas/TeamResolveResponse"
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"500":
$ref: "#/components/responses/500"
/admin/users/{userId}/bootstrap:
post:
summary: Bootstrap user
tags: [teams]
security:
- AdminTokenAuth: []
parameters:
- $ref: "#/components/parameters/userId"
responses:
"200":
description: Successfully bootstrapped user.
content:
application/json:
schema:
$ref: "#/components/schemas/TeamResolveResponse"
"401":
$ref: "#/components/responses/401"
"500":
$ref: "#/components/responses/500"
/teams/resolve:
get:
summary: Resolve team identity
description: Resolves a team slug to the team's identity, validating the user is a member.
tags: [teams]
security:
- Supabase1TokenAuth: []
parameters:
- $ref: "#/components/parameters/teamSlug"
responses:
"200":
description: Successfully resolved team.
content:
application/json:
schema:
$ref: "#/components/schemas/TeamResolveResponse"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"500":
$ref: "#/components/responses/500"
/teams/{teamID}:
patch:
summary: Update team
tags: [teams]
security:
- Supabase1TokenAuth: []
Supabase2TeamAuth: []
parameters:
- $ref: "#/components/parameters/teamID"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateTeamRequest"
responses:
"200":
description: Successfully updated team.
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateTeamResponse"
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"500":
$ref: "#/components/responses/500"
/teams/{teamID}/members:
get:
summary: List team members
tags: [teams]
security:
- Supabase1TokenAuth: []
Supabase2TeamAuth: []
parameters:
- $ref: "#/components/parameters/teamID"
responses:
"200":
description: Successfully returned team members.
content:
application/json:
schema:
$ref: "#/components/schemas/TeamMembersResponse"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"500":
$ref: "#/components/responses/500"
post:
summary: Add team member
tags: [teams]
security:
- Supabase1TokenAuth: []
Supabase2TeamAuth: []
parameters:
- $ref: "#/components/parameters/teamID"
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AddTeamMemberRequest"
responses:
"201":
description: Successfully added team member.
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"404":
$ref: "#/components/responses/404"
"500":
$ref: "#/components/responses/500"
/teams/{teamID}/members/{userId}:
delete:
summary: Remove team member
tags: [teams]
security:
- Supabase1TokenAuth: []
Supabase2TeamAuth: []
parameters:
- $ref: "#/components/parameters/teamID"
- $ref: "#/components/parameters/userId"
responses:
"204":
description: Successfully removed team member.
"400":
$ref: "#/components/responses/400"
"401":
$ref: "#/components/responses/401"
"403":
$ref: "#/components/responses/403"
"500":
$ref: "#/components/responses/500"
/templates/defaults:
get:
summary: List default templates
description: Returns the list of default templates with their latest build info and aliases.
tags: [templates]
security:
- Supabase1TokenAuth: []
responses:
"200":
description: Successfully returned default templates.
content:
application/json:
schema:
$ref: "#/components/schemas/DefaultTemplatesResponse"
"401":
$ref: "#/components/responses/401"
"500":
$ref: "#/components/responses/500"