-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
682 lines (655 loc) · 19.5 KB
/
openapi.yaml
File metadata and controls
682 lines (655 loc) · 19.5 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
openapi: 3.0.3
info:
title: SQLution API
description: |
SQLution API provides endpoints for managing SQL databases, executing queries,
uploading/downloading database files, and managing database diagrams.
## Authentication
Most endpoints require authentication using Django session-based authentication.
Users must log in through the web interface before accessing API endpoints.
## Authorization
- **db_admin**: Database administrators can manage their own databases
- **global_admin**: Global administrators have access to system-wide settings
version: 1.0.0
contact:
name: SQLution Support
license:
name: License Information
url: https://github.com/ValentinHerrmann/SQLution/blob/main/LICENSE
servers:
- url: http://localhost:8000
description: Local development server
- url: https://sqlution.de
description: Production server
tags:
- name: API Discovery
description: Endpoints for discovering available API routes
- name: SQL Files
description: Manage SQL query files
- name: SQL Execution
description: Execute SQL queries
- name: Database Management
description: Upload and download database files
- name: Diagrams
description: Manage database and editor diagrams
- name: System Administration
description: System monitoring and administration
security:
- sessionAuth: []
paths:
/api/:
get:
tags:
- API Discovery
summary: List all API endpoints
description: Returns a JSON list of all available API endpoints with their paths and names
operationId: listEndpoints
responses:
'200':
description: Successful response with list of endpoints
content:
application/json:
schema:
type: object
properties:
endpoints:
type: array
items:
type: object
properties:
path:
type: string
example: "/api/sql/list"
name:
type: string
example: "api_sql_list"
count:
type: integer
example: 10
'500':
description: Internal server error
content:
text/plain:
schema:
type: string
example: "Could not get endpoints"
/api/sql/{filename}.sql:
get:
tags:
- SQL Files
summary: Get SQL file content
description: Retrieve the content of a specific SQL file for the authenticated user
operationId: getSqlFile
security:
- sessionAuth: []
parameters:
- name: filename
in: path
required: true
description: Name of the SQL file (with or without .sql extension)
schema:
type: string
example: "my_query"
responses:
'200':
description: SQL file content
content:
text/sql:
schema:
type: string
example: "SELECT * FROM users WHERE id = 1;"
'500':
description: Error reading file
content:
text/plain:
schema:
type: string
post:
tags:
- SQL Files
summary: Create or update SQL file
description: Create a new SQL file or update an existing one
operationId: createSqlFile
security:
- sessionAuth: []
parameters:
- name: filename
in: path
required: true
description: Name of the SQL file
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- sql
properties:
sql:
type: string
example: "SELECT * FROM users;"
responses:
'200':
description: File saved successfully
content:
text/plain:
schema:
type: string
example: "File saved successfully"
'500':
description: Error saving file
put:
tags:
- SQL Files
summary: Update SQL file
description: Update an existing SQL file (same as POST)
operationId: updateSqlFile
security:
- sessionAuth: []
parameters:
- name: filename
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- sql
properties:
sql:
type: string
responses:
'200':
description: File saved successfully
'500':
description: Error saving file
delete:
tags:
- SQL Files
summary: Delete SQL file
description: Delete a specific SQL file
operationId: deleteSqlFile
security:
- sessionAuth: []
parameters:
- name: filename
in: path
required: true
schema:
type: string
responses:
'200':
description: File deleted successfully
content:
text/plain:
schema:
type: string
example: "File deleted successfully"
'500':
description: Error deleting file
/api/sql/list:
get:
tags:
- SQL Files
summary: List all SQL files
description: Get a list of all SQL files in the user's directory
operationId: listSqlFiles
security:
- sessionAuth: []
responses:
'200':
description: List of SQL files
content:
application/json:
schema:
type: object
properties:
files:
type: array
items:
type: string
example: ["query1.sql", "query2.sql", "test.sql"]
'405':
description: Method not allowed
'500':
description: Internal error
/api/sql/all:
post:
tags:
- SQL Files
summary: Replace all SQL files
description: Delete all existing SQL files and create new ones from the provided list
operationId: replaceAllSqlFiles
security:
- sessionAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- files
properties:
files:
type: array
items:
type: object
required:
- filename
- sql
properties:
filename:
type: string
example: "my_query.sql"
sql:
type: string
example: "SELECT * FROM users;"
responses:
'200':
description: Files saved successfully
content:
text/plain:
schema:
type: string
example: "Files saved successfully"
'404':
description: Unknown request
'500':
description: Internal error while saving SQL files
/api/sql/run:
post:
tags:
- SQL Execution
summary: Execute SQL query
description: Execute a SQL query and return the results with columns and rows
operationId: executeSql
security:
- sessionAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- sql
properties:
sql:
type: string
example: "SELECT * FROM users LIMIT 10;"
responses:
'200':
description: Query executed successfully
content:
application/json:
schema:
type: object
properties:
columns:
type: array
items:
type: string
example: ["id", "name", "email"]
result:
type: array
items:
type: array
items: {}
example: [[1, "John Doe", "[email protected]"], [2, "Jane Smith", "[email protected]"]]
error:
type: string
nullable: true
example: null
'400':
description: Bad request or SQL error
content:
application/json:
schema:
type: object
properties:
columns:
type: array
items: {}
result:
type: array
items: {}
error:
type: string
example: "near \"SELEC\": syntax error"
'405':
description: Method not allowed
'500':
description: Internal server error
/api/upload_db/:
post:
tags:
- Database Management
summary: Upload database file
description: Upload a SQLite database file (binary data in request body)
operationId: uploadDatabase
security:
- sessionAuth: []
requestBody:
required: true
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
'201':
description: File saved successfully
content:
text/plain:
schema:
type: string
example: "File saved successfully"
'405':
description: Method not allowed
'500':
description: Internal error while uploading database
/api/db_diagram.json:
get:
tags:
- Diagrams
summary: Get database diagram
description: Retrieve the database diagram JSON (model.json) for the current user
operationId: getDatabaseDiagram
security:
- sessionAuth: []
responses:
'200':
description: Database diagram JSON
content:
application/json:
schema:
type: object
description: Apollon diagram model
'500':
description: Internal error while handling database diagram JSON
post:
tags:
- Diagrams
summary: Update database diagram
description: Update the database diagram and generate SQL from it
operationId: updateDatabaseDiagram
security:
- sessionAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
description: Apollon diagram model
responses:
'200':
description: Diagram saved and SQL generated successfully
'405':
description: Method not allowed
'500':
description: Internal error while handling database diagram JSON
/api/editor_diagram.json:
get:
tags:
- Diagrams
summary: Get editor diagram
description: Retrieve the editor diagram JSON (editor_model.json) for the current user
operationId: getEditorDiagram
security:
- sessionAuth: []
responses:
'200':
description: Editor diagram JSON
content:
application/json:
schema:
type: object
description: Editor diagram model
'500':
description: Internal error while handling editor diagram JSON
post:
tags:
- Diagrams
summary: Update editor diagram
description: Update the editor diagram JSON
operationId: updateEditorDiagram
security:
- sessionAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
description: Editor diagram model
responses:
'200':
description: Editor diagram saved successfully
'405':
description: Method not allowed
'500':
description: Internal error while handling editor diagram JSON
/api/system-data/:
get:
tags:
- System Administration
summary: Get system data
description: |
Retrieve comprehensive system information including:
- User database directory structure and sizes
- Disk usage (total, used, free)
- RAM usage
- CPU usage
- Logged-in users count and session details
- Recent audit logs
**Requires global admin privileges**
operationId: getSystemData
security:
- sessionAuth: []
responses:
'200':
description: System data retrieved successfully
content:
application/json:
schema:
type: object
properties:
directories:
type: array
items:
type: object
description: User database directory tree with sizes
fullness_percentage:
type: integer
example: 65
description: Disk usage percentage
total_gb:
type: string
example: "500.00"
description: Total disk space in GB
used_gb:
type: string
example: "325.00"
description: Used disk space in GB
free_gb:
type: string
example: "175.00"
description: Free disk space in GB
ram_total:
type: string
example: "16.00"
description: Total RAM in GB
ram_used:
type: string
example: "8.50"
description: Used RAM in GB
ram_free:
type: string
example: "7.50"
description: Available RAM in GB
ram_percentage:
type: integer
example: 53
description: RAM usage percentage
cpu_percentage:
type: integer
example: 25
description: CPU usage percentage
logged_in_users:
type: integer
example: 5
description: Number of currently logged-in users
session_info:
type: array
items:
type: object
description: Detailed session information for each user
recent_audit_logs:
type: array
items:
type: object
properties:
timestamp:
type: string
example: "2026-01-21 14:30:00"
username:
type: string
example: "john_doe"
action:
type: string
example: "LOGIN"
action_display:
type: string
example: "Login"
ip_address:
type: string
example: "192.168.1.100"
operating_system:
type: string
example: "Windows 10"
location:
type: string
example: "New York, US"
session_id:
type: string
example: "abc123xyz"
'403':
description: Forbidden - requires global admin privileges
'500':
description: Internal server error
/actuator/gateway/routes:
get:
tags:
- System Administration
summary: Gateway routes actuator endpoint
description: Compatibility endpoint for platform probes expecting Spring Boot actuator
operationId: actuatorGatewayRoutes
responses:
'200':
description: Actuator response
content:
application/json:
schema:
type: object
properties:
application:
type: string
example: "sqlution"
component:
type: string
example: "gateway"
routes:
type: array
items: {}
status:
type: string
example: "ok"
'405':
description: Method not allowed
components:
securitySchemes:
sessionAuth:
type: apiKey
in: cookie
name: sessionid
description: Django session-based authentication
schemas:
Error:
type: object
properties:
detail:
type: string
description: Error message
status:
type: integer
description: HTTP status code
SqlFile:
type: object
required:
- filename
- sql
properties:
filename:
type: string
description: Name of the SQL file
example: "my_query.sql"
sql:
type: string
description: SQL query content
example: "SELECT * FROM users WHERE active = 1;"
QueryResult:
type: object
properties:
columns:
type: array
items:
type: string
description: Column names from the query result
result:
type: array
items:
type: array
items: {}
description: Result rows, each row is an array of values
error:
type: string
nullable: true
description: Error message if query failed, null otherwise
AuditLog:
type: object
properties:
timestamp:
type: string
format: date-time
description: When the action occurred
username:
type: string
description: User who performed the action
action:
type: string
description: Action code (LOGIN, LOGOUT, etc.)
action_display:
type: string
description: Human-readable action description
ip_address:
type: string
description: IP address of the user
operating_system:
type: string
description: User's operating system
location:
type: string
description: Geographic location
session_id:
type: string
description: Session identifier