-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathopenapi.yaml
More file actions
2634 lines (2502 loc) · 62 KB
/
openapi.yaml
File metadata and controls
2634 lines (2502 loc) · 62 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
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
openapi: 3.1.0
info:
title: Jet Admin Backend API
version: 1.0.0
description: |
REST API for Jet Admin backend.
## Authentication
Most endpoints require authentication using a Firebase Bearer token.
Some endpoints may also be accessed via API Key.
## Authorization
Permissions are handled via the `authMiddleware`.
servers:
- url: http://localhost:3000
description: Local Development Server
tags:
- name: Authentication
description: User authentication and configuration
- name: Tenants
description: Tenant management
- name: Database
description: Database schema and raw SQL execution
- name: Database Tables
description: Table management and row operations
- name: Database Triggers
description: Database trigger management
- name: Datasources
description: Datasource connection management
- name: Data Queries
description: Data query execution and management
- name: Workflows
description: Workflow design and execution
- name: Widgets
description: Widget configuration and data
- name: Dashboards
description: Dashboard management
- name: User Management
description: Tenant user management
- name: Roles
description: Role and permission management
- name: API Keys
description: API Key management
- name: Cron Jobs
description: Cron job management and history
- name: Audit Logs
description: System audit logs
- name: AI
description: AI features
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: Firebase ID Token
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: Tenant API Key
schemas:
# Common Schemas
UUID:
type: string
format: uuid
example: "123e4567-e89b-12d3-a456-426614174000"
ErrorResponse:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: "INVALID_REQUEST"
message:
type: string
example: "Invalid request parameters"
# Auth Schemas
UserConfigUpdate:
type: object
properties:
config:
type: object
additionalProperties: true
description: "Arbitrary JSON configuration for the user"
required:
- config
# Tenant Schemas
TenantCreate:
type: object
properties:
tenantTitle:
type: string
maxLength: 255
description: "Name of the tenant"
tenantDescription:
type: string
description: "Description of the tenant"
tenantDBURL:
type: string
description: "Database connection URL"
required:
- tenantTitle
- tenantDBURL
TenantUpdate:
type: object
properties:
tenantTitle:
type: string
tenantDescription:
type: string
tenantDBURL:
type: string
Tenant:
allOf:
- $ref: '#/components/schemas/TenantCreate'
- type: object
properties:
id:
$ref: '#/components/schemas/UUID'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
# Database Schemas
DatabaseSchemaCreate:
type: object
properties:
schemaName:
type: string
minLength: 1
maxLength: 255
required:
- schemaName
RawSqlExecute:
type: object
properties:
sql:
type: string
minLength: 1
required:
- sql
# Table Schemas
DatabaseTableCreate:
type: object
properties:
databaseTableName:
type: string
minLength: 1
maxLength: 255
columns:
type: array
items:
type: object
additionalProperties: true
required:
- databaseTableName
DatabaseTableUpdate:
type: object
properties:
columns:
type: array
items:
type: object
additionalProperties: true
constraints:
type: array
items:
type: object
additionalProperties: true
BulkRowOperation:
type: object
properties:
databaseTableRowData:
type: array
items:
type: object
additionalProperties: true
required:
- databaseTableRowData
# Trigger Schemas
DatabaseTriggerCreate:
type: object
properties:
databaseTableName:
type: string
databaseTriggerName:
type: string
triggerTiming:
type: string
triggerEvents:
type: string
triggerFunction:
type: string
triggerCondition:
type: string
required:
- databaseTableName
- databaseTriggerName
- triggerTiming
- triggerEvents
# Datasource Schemas
DatasourceCreate:
type: object
properties:
datasourceTitle:
type: string
minLength: 1
maxLength: 255
datasourceType:
type: string
minLength: 1
datasourceOptions:
type: object
additionalProperties: true
required:
- datasourceTitle
- datasourceType
- datasourceOptions
DatasourceUpdate:
type: object
properties:
datasourceTitle:
type: string
minLength: 1
maxLength: 255
datasourceType:
type: string
minLength: 1
datasourceOptions:
type: object
additionalProperties: true
Datasource:
allOf:
- $ref: '#/components/schemas/DatasourceCreate'
- type: object
properties:
id:
$ref: '#/components/schemas/UUID'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
# Data Query Schemas
DataQueryCreate:
type: object
properties:
dataQueryTitle:
type: string
minLength: 1
maxLength: 255
dataQueryOptions:
type: object
additionalProperties: true
runOnLoad:
type: boolean
required:
- dataQueryTitle
- dataQueryOptions
DataQueryUpdate:
type: object
properties:
dataQueryTitle:
type: string
minLength: 1
maxLength: 255
dataQueryOptions:
type: object
additionalProperties: true
runOnLoad:
type: boolean
DataQuery:
allOf:
- $ref: '#/components/schemas/DataQueryCreate'
- type: object
properties:
id:
$ref: '#/components/schemas/UUID'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
TestDataQuery:
type: object
properties:
dataQuery:
type: object
additionalProperties: true
required:
- dataQuery
AIGenerateQuery:
type: object
properties:
aiPrompt:
type: string
minLength: 1
required:
- aiPrompt
# Workflow Schemas
WorkflowCreate:
type: object
properties:
title:
type: string
minLength: 1
maxLength: 255
workflowDescription:
type: string
workflowNodes:
type: array
items:
type: object
workflowEdges:
type: array
items:
type: object
workflowOptions:
type: object
required:
- title
WorkflowUpdate:
type: object
properties:
workflowTitle:
type: string
minLength: 1
maxLength: 255
workflowDescription:
type: string
workflowNodes:
type: array
items:
type: object
workflowEdges:
type: array
items:
type: object
workflowOptions:
type: object
WorkflowExecute:
type: object
properties:
args:
type: object
TestWorkflow:
type: object
properties:
nodes:
type: array
items:
type: object
edges:
type: array
items:
type: object
workflowOptions:
type: object
args:
type: object
required:
- nodes
- edges
Workflow:
type: object
allOf:
- $ref: '#/components/schemas/WorkflowCreate'
- type: object
properties:
id:
$ref: '#/components/schemas/UUID'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
# Widget Schemas
WidgetCreate:
type: object
properties:
widgetTitle:
type: string
minLength: 1
maxLength: 255
widgetDescription:
type: string
widgetType:
type: string
minLength: 1
widgetConfig:
type: object
required:
- widgetTitle
- widgetType
- widgetConfig
WidgetUpdate:
type: object
properties:
widgetTitle:
type: string
minLength: 1
maxLength: 255
widgetDescription:
type: string
widgetType:
type: string
minLength: 1
widgetConfig:
type: object
TestWidgetData:
type: object
properties:
widgetTitle:
type: string
widgetType:
type: string
widgetConfig:
type: object
Widget:
allOf:
- $ref: '#/components/schemas/WidgetCreate'
- type: object
properties:
id:
$ref: '#/components/schemas/UUID'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
# Dashboard Schemas
DashboardCreate:
type: object
properties:
dashboardTitle:
type: string
minLength: 1
maxLength: 255
dashboardDescription:
type: string
dashboardConfig:
type: object
required:
- dashboardTitle
- dashboardConfig
DashboardUpdate:
type: object
properties:
dashboardTitle:
type: string
minLength: 1
maxLength: 255
dashboardDescription:
type: string
dashboardConfig:
type: object
Dashboard:
allOf:
- $ref: '#/components/schemas/DashboardCreate'
- type: object
properties:
id:
$ref: '#/components/schemas/UUID'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
# User Management Schemas
AddUserToTenant:
type: object
properties:
userEmail:
type: string
format: email
roleIDs:
type: array
items:
$ref: '#/components/schemas/UUID'
required:
- userEmail
UpdateUserRoles:
type: object
properties:
roleIDs:
type: array
items:
$ref: '#/components/schemas/UUID'
required:
- roleIDs
# Role Schemas
RoleCreate:
type: object
properties:
roleName:
type: string
minLength: 1
maxLength: 255
roleDescription:
type: string
rolePermissions:
type: array
items:
type: string
required:
- roleName
- rolePermissions
RoleUpdate:
type: object
properties:
roleName:
type: string
minLength: 1
maxLength: 255
roleDescription:
type: string
rolePermissions:
type: array
items:
type: string
Role:
allOf:
- $ref: '#/components/schemas/RoleCreate'
- type: object
properties:
id:
$ref: '#/components/schemas/UUID'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
# API Key Schemas
ApiKeyCreate:
type: object
properties:
apiKeyName:
type: string
minLength: 1
maxLength: 255
apiKeyDescription:
type: string
apiKeyPermissions:
type: array
items:
type: string
apiKeyExpiry:
type: string
format: date-time
required:
- apiKeyName
ApiKeyUpdate:
type: object
properties:
apiKeyName:
type: string
minLength: 1
maxLength: 255
apiKeyDescription:
type: string
apiKeyPermissions:
type: array
items:
type: string
apiKeyExpiry:
type: string
format: date-time
ApiKey:
allOf:
- $ref: '#/components/schemas/ApiKeyCreate'
- type: object
properties:
id:
$ref: '#/components/schemas/UUID'
key:
type: string
description: "The API key string (only returned on creation usually, depends on implementation)"
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
# Cron Job Schemas
CronJobCreate:
type: object
properties:
cronJobTitle:
type: string
minLength: 1
maxLength: 255
cronJobDescription:
type: string
cronJobSchedule:
type: string
example: "0 0 * * *"
cronJobEnabled:
type: boolean
default: true
cronJobType:
type: string
minLength: 1
cronJobConfig:
type: object
required:
- cronJobTitle
- cronJobSchedule
- cronJobType
- cronJobConfig
CronJobUpdate:
type: object
properties:
cronJobTitle:
type: string
minLength: 1
maxLength: 255
cronJobDescription:
type: string
cronJobSchedule:
type: string
cronJobEnabled:
type: boolean
cronJobType:
type: string
minLength: 1
cronJobConfig:
type: object
CronJob:
allOf:
- $ref: '#/components/schemas/CronJobCreate'
- type: object
properties:
id:
$ref: '#/components/schemas/UUID'
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
security:
- BearerAuth: []
paths:
# Authentication Routes
/api/v1/auth:
get:
tags:
- Authentication
summary: Get User Info
description: Retrieves information about the currently authenticated user.
responses:
'200':
description: User information retrieved successfully
content:
application/json:
schema:
type: object
additionalProperties: true
'401':
description: Unauthorized
/api/v1/auth/config/{tenantID}:
get:
tags:
- Authentication
summary: Get User Config
description: Retrieves user configuration for a specific tenant.
parameters:
- name: tenantID
in: path
required: true
schema:
$ref: '#/components/schemas/UUID'
responses:
'200':
description: User configuration retrieved successfully
'404':
description: Tenant not found
post:
tags:
- Authentication
summary: Update User Config
description: Updates user configuration for a specific tenant.
parameters:
- name: tenantID
in: path
required: true
schema:
$ref: '#/components/schemas/UUID'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UserConfigUpdate'
responses:
'200':
description: Configuration updated successfully
# Tenant Routes
/api/v1/tenants:
get:
tags:
- Tenants
summary: Get All User Tenants
description: Retrieves all tenants the user belongs to.
responses:
'200':
description: List of tenants
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Tenant'
post:
tags:
- Tenants
summary: Create New Tenant
description: Creates a new tenant.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TenantCreate'
responses:
'201':
description: Tenant created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Tenant'
/api/v1/tenants/{tenantID}:
get:
tags:
- Tenants
summary: Get Tenant by ID
parameters:
- name: tenantID
in: path
required: true
schema:
$ref: '#/components/schemas/UUID'
responses:
'200':
description: Tenant details
content:
application/json:
schema:
$ref: '#/components/schemas/Tenant'
patch:
tags:
- Tenants
summary: Update Tenant
parameters:
- name: tenantID
in: path
required: true
schema:
$ref: '#/components/schemas/UUID'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TenantUpdate'
responses:
'200':
description: Tenant updated successfully
delete:
tags:
- Tenants
summary: Delete Tenant
parameters:
- name: tenantID
in: path
required: true
schema:
$ref: '#/components/schemas/UUID'
responses:
'200':
description: Tenant deleted successfully
/api/v1/tenants/dbtest:
patch:
tags:
- Tenants
summary: Test Database Connection
description: Tests the database connection string.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
tenantDBURL:
type: string
required:
- tenantDBURL
responses:
'200':
description: Connection successful
# Database Routes
/api/v1/tenants/{tenantID}/database/metadata:
get:
tags:
- Database
summary: Get Database Metadata
parameters:
- name: tenantID
in: path
required: true
schema:
$ref: '#/components/schemas/UUID'
responses:
'200':
description: Database metadata
/api/v1/tenants/{tenantID}/database/schemas:
post:
tags:
- Database
summary: Create Database Schema
parameters:
- name: tenantID
in: path
required: true
schema:
$ref: '#/components/schemas/UUID'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseSchemaCreate'
responses:
'201':
description: Schema created successfully
/api/v1/tenants/{tenantID}/database/execute-raw-sql:
post:
tags:
- Database
summary: Execute Raw SQL
parameters:
- name: tenantID
in: path
required: true
schema:
$ref: '#/components/schemas/UUID'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RawSqlExecute'
responses:
'200':
description: Query executed successfully
# Database Table Routes
/api/v1/tenants/{tenantID}/database/schemas/{databaseSchemaName}/tables:
get:
tags:
- Database Tables
summary: Get All Tables
parameters:
- name: tenantID
in: path
required: true
schema:
$ref: '#/components/schemas/UUID'
- name: databaseSchemaName
in: path
required: true
schema:
type: string
responses:
'200':
description: List of tables
content:
application/json:
schema:
type: array
items:
type: object
post:
tags:
- Database Tables
summary: Create Table
parameters:
- name: tenantID
in: path
required: true
schema:
$ref: '#/components/schemas/UUID'
- name: databaseSchemaName
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DatabaseTableCreate'
responses:
'201':
description: Table created successfully
/api/v1/tenants/{tenantID}/database/schemas/{databaseSchemaName}/tables/{databaseTableName}:
get:
tags:
- Database Tables
summary: Get Table Details
parameters:
- name: tenantID
in: path
required: true
schema:
$ref: '#/components/schemas/UUID'
- name: databaseSchemaName
in: path
required: true
schema:
type: string
- name: databaseTableName
in: path
required: true
schema:
type: string
responses:
'200':