Skip to content

Commit 7e6c673

Browse files
dobracgithub-actions[bot]
authored andcommitted
chore: sync infra OpenAPI specs
1 parent 9eecf53 commit 7e6c673

4 files changed

Lines changed: 4616 additions & 4190 deletions

File tree

spec/openapi.dashboard-api.yaml

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ components:
1010
type: apiKey
1111
in: header
1212
name: X-Admin-Token
13+
# Generated code uses security schemas in the alphabetical order.
14+
# In order to check first the token, and then the team (so we can already use the user),
15+
# there is a 1 and 2 present in the names of the security schemas.
1316
Supabase1TokenAuth:
1417
type: apiKey
1518
in: header
@@ -18,6 +21,16 @@ components:
1821
type: apiKey
1922
in: header
2023
name: X-Supabase-Team
24+
# AuthProviderBearerAuth / AuthProviderTeamAuth: B before T in the name
25+
# so Bearer is validated before Team (same reason as Supabase1/2 above).
26+
AuthProviderBearerAuth:
27+
type: http
28+
scheme: bearer
29+
bearerFormat: access_token
30+
AuthProviderTeamAuth:
31+
type: apiKey
32+
in: header
33+
name: X-Team-ID
2134

2235
parameters:
2336
build_id:
@@ -156,6 +169,54 @@ components:
156169
type: string
157170
description: Error message.
158171

172+
AdminAuthProviderProfile:
173+
type: object
174+
required:
175+
- userId
176+
- email
177+
properties:
178+
userId:
179+
type: string
180+
format: uuid
181+
description: Internal E2B user identifier.
182+
email:
183+
type: string
184+
nullable: true
185+
description: Email address from the configured auth provider.
186+
187+
AdminAuthProviderProfilesResponse:
188+
type: object
189+
required:
190+
- profiles
191+
properties:
192+
profiles:
193+
type: array
194+
items:
195+
$ref: "#/components/schemas/AdminAuthProviderProfile"
196+
197+
AdminAuthProviderProfilesResolveRequest:
198+
type: object
199+
required:
200+
- userIds
201+
properties:
202+
userIds:
203+
type: array
204+
minItems: 1
205+
maxItems: 100
206+
uniqueItems: true
207+
items:
208+
type: string
209+
format: uuid
210+
211+
AdminAuthProviderProfilesLookupEmailRequest:
212+
type: object
213+
required:
214+
- email
215+
properties:
216+
email:
217+
type: string
218+
format: email
219+
159220
BuildStatus:
160221
type: string
161222
description: Build status mapped for dashboard clients.
@@ -617,6 +678,8 @@ paths:
617678
security:
618679
- Supabase1TokenAuth: []
619680
Supabase2TeamAuth: []
681+
- AuthProviderBearerAuth: []
682+
AuthProviderTeamAuth: []
620683
parameters:
621684
- $ref: "#/components/parameters/build_id_or_template"
622685
- $ref: "#/components/parameters/build_statuses"
@@ -645,6 +708,8 @@ paths:
645708
security:
646709
- Supabase1TokenAuth: []
647710
Supabase2TeamAuth: []
711+
- AuthProviderBearerAuth: []
712+
AuthProviderTeamAuth: []
648713
parameters:
649714
- $ref: "#/components/parameters/build_ids"
650715

@@ -671,6 +736,8 @@ paths:
671736
security:
672737
- Supabase1TokenAuth: []
673738
Supabase2TeamAuth: []
739+
- AuthProviderBearerAuth: []
740+
AuthProviderTeamAuth: []
674741
parameters:
675742
- $ref: "#/components/parameters/build_id"
676743
responses:
@@ -696,6 +763,8 @@ paths:
696763
security:
697764
- Supabase1TokenAuth: []
698765
Supabase2TeamAuth: []
766+
- AuthProviderBearerAuth: []
767+
AuthProviderTeamAuth: []
699768
parameters:
700769
- $ref: "#/components/parameters/sandboxID"
701770
responses:
@@ -721,6 +790,7 @@ paths:
721790
tags: [teams]
722791
security:
723792
- Supabase1TokenAuth: []
793+
- AuthProviderBearerAuth: []
724794
responses:
725795
"200":
726796
description: Successfully returned user teams.
@@ -737,6 +807,7 @@ paths:
737807
tags: [teams]
738808
security:
739809
- Supabase1TokenAuth: []
810+
- AuthProviderBearerAuth: []
740811
requestBody:
741812
required: true
742813
content:
@@ -777,13 +848,88 @@ paths:
777848
"500":
778849
$ref: "#/components/responses/500"
779850

851+
/admin/user-profiles/resolve:
852+
post:
853+
summary: Resolve user profiles
854+
tags: [admin]
855+
security:
856+
- AdminTokenAuth: []
857+
requestBody:
858+
required: true
859+
content:
860+
application/json:
861+
schema:
862+
$ref: "#/components/schemas/AdminAuthProviderProfilesResolveRequest"
863+
responses:
864+
"200":
865+
description: Successfully resolved profiles.
866+
content:
867+
application/json:
868+
schema:
869+
$ref: "#/components/schemas/AdminAuthProviderProfilesResponse"
870+
"400":
871+
$ref: "#/components/responses/400"
872+
"401":
873+
$ref: "#/components/responses/401"
874+
"500":
875+
$ref: "#/components/responses/500"
876+
877+
/admin/user-profiles/by-email:
878+
post:
879+
summary: Lookup user profiles by email
880+
tags: [admin]
881+
security:
882+
- AdminTokenAuth: []
883+
requestBody:
884+
required: true
885+
content:
886+
application/json:
887+
schema:
888+
$ref: "#/components/schemas/AdminAuthProviderProfilesLookupEmailRequest"
889+
responses:
890+
"200":
891+
description: Successfully found matching profiles.
892+
content:
893+
application/json:
894+
schema:
895+
$ref: "#/components/schemas/AdminAuthProviderProfilesResponse"
896+
"400":
897+
$ref: "#/components/responses/400"
898+
"401":
899+
$ref: "#/components/responses/401"
900+
"500":
901+
$ref: "#/components/responses/500"
902+
903+
/admin/user-profiles/{userId}:
904+
get:
905+
summary: Get user profile
906+
tags: [admin]
907+
security:
908+
- AdminTokenAuth: []
909+
parameters:
910+
- $ref: "#/components/parameters/userId"
911+
responses:
912+
"200":
913+
description: Successfully found profile.
914+
content:
915+
application/json:
916+
schema:
917+
$ref: "#/components/schemas/AdminAuthProviderProfilesResponse"
918+
"400":
919+
$ref: "#/components/responses/400"
920+
"401":
921+
$ref: "#/components/responses/401"
922+
"500":
923+
$ref: "#/components/responses/500"
924+
780925
/teams/resolve:
781926
get:
782927
summary: Resolve team identity
783928
description: Resolves a team slug to the team's identity, validating the user is a member.
784929
tags: [teams]
785930
security:
786931
- Supabase1TokenAuth: []
932+
- AuthProviderBearerAuth: []
787933
parameters:
788934
- $ref: "#/components/parameters/teamSlug"
789935
responses:
@@ -809,6 +955,8 @@ paths:
809955
security:
810956
- Supabase1TokenAuth: []
811957
Supabase2TeamAuth: []
958+
- AuthProviderBearerAuth: []
959+
AuthProviderTeamAuth: []
812960
parameters:
813961
- $ref: "#/components/parameters/teamID"
814962
requestBody:
@@ -840,6 +988,8 @@ paths:
840988
security:
841989
- Supabase1TokenAuth: []
842990
Supabase2TeamAuth: []
991+
- AuthProviderBearerAuth: []
992+
AuthProviderTeamAuth: []
843993
parameters:
844994
- $ref: "#/components/parameters/teamID"
845995
responses:
@@ -861,6 +1011,8 @@ paths:
8611011
security:
8621012
- Supabase1TokenAuth: []
8631013
Supabase2TeamAuth: []
1014+
- AuthProviderBearerAuth: []
1015+
AuthProviderTeamAuth: []
8641016
parameters:
8651017
- $ref: "#/components/parameters/teamID"
8661018
requestBody:
@@ -890,6 +1042,8 @@ paths:
8901042
security:
8911043
- Supabase1TokenAuth: []
8921044
Supabase2TeamAuth: []
1045+
- AuthProviderBearerAuth: []
1046+
AuthProviderTeamAuth: []
8931047
parameters:
8941048
- $ref: "#/components/parameters/teamID"
8951049
- $ref: "#/components/parameters/userId"
@@ -912,6 +1066,7 @@ paths:
9121066
tags: [templates]
9131067
security:
9141068
- Supabase1TokenAuth: []
1069+
- AuthProviderBearerAuth: []
9151070
responses:
9161071
"200":
9171072
description: Successfully returned default templates.

0 commit comments

Comments
 (0)