-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
4000 lines (3829 loc) · 103 KB
/
openapi.yaml
File metadata and controls
4000 lines (3829 loc) · 103 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.0.0
info:
title: Mitosis API
description: |
Mitosis is a unified distributed transport evaluation framework that provides REST API endpoints
for managing users, groups, workers, and tasks in a distributed computing environment.
## Authentication
Most endpoints require JWT bearer token authentication. Get a token by calling `/login` with
valid credentials.
## API Structure
- `/auth` - User authentication status
- `/login` - User login
- `/users` - User management
- `/groups` - Group management and file attachments
- `/workers` - Worker registration and management
- `/tasks` - Task submission and monitoring
- `/admin` - Administrative operations (admin users only)
- `/health` - Service health check
- `/redis` - Redis connection information
version: 0.6.0
contact:
name: Mitosis
url: https://github.com/stack-rs/mitosis
license:
name: Apache 2.0
url: https://github.com/stack-rs/mitosis/blob/main/LICENSE
servers:
- url: http://localhost:5000
description: Local development server
- url: https://api.mitosis.example.com
description: Production server
paths:
/health:
get:
summary: Health check
description: Check if the Mitosis coordinator is running and healthy
operationId: healthCheck
tags:
- Health
responses:
"200":
description: Service is healthy
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: ok
/login:
post:
summary: User login
description: Authenticate user and receive JWT token
operationId: userLogin
tags:
- Authentication
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UserLoginReq"
responses:
"200":
description: Login successful
content:
application/json:
schema:
$ref: "#/components/schemas/UserLoginResp"
"401":
$ref: "#/components/responses/Unauthorized"
"400":
$ref: "#/components/responses/BadRequest"
/auth:
get:
summary: Get current user
description: Get the username of the currently authenticated user
operationId: userAuth
tags:
- Authentication
security:
- bearerAuth: []
responses:
"200":
description: Username of authenticated user
content:
text/plain:
schema:
type: string
"401":
$ref: "#/components/responses/Unauthorized"
/redis:
get:
summary: Get Redis connection info
description: Get Redis connection URL for real-time task monitoring
operationId: getRedisConnectionInfo
tags:
- Pubsub
security:
- bearerAuth: []
responses:
"200":
description: Redis connection information
content:
application/json:
schema:
$ref: "#/components/schemas/RedisConnectionInfo"
"401":
$ref: "#/components/responses/Unauthorized"
/users/{username}/password:
post:
summary: Change user password
description: Change the password for a user (own account only unless admin)
operationId: changePassword
tags:
- Users
security:
- bearerAuth: []
parameters:
- name: username
in: path
required: true
schema:
type: string
example: johndoe
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UserChangePasswordReq"
responses:
"200":
description: Password changed successfully
content:
application/json:
schema:
$ref: "#/components/schemas/UserChangePasswordResp"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
/users/groups:
get:
summary: Query user groups
description: Get all groups the authenticated user has access to
operationId: queryUserGroups
tags:
- Users
security:
- bearerAuth: []
responses:
"200":
description: User groups with roles
content:
application/json:
schema:
$ref: "#/components/schemas/GroupsQueryResp"
"401":
$ref: "#/components/responses/Unauthorized"
/groups:
post:
summary: Create group
description: Create a new group (user becomes admin of the group)
operationId: createGroup
tags:
- Groups
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateGroupReq"
responses:
"200":
description: Group created successfully
"401":
$ref: "#/components/responses/Unauthorized"
"409":
$ref: "#/components/responses/Conflict"
/groups/{group_name}:
get:
summary: Get group information
description: Get detailed information about a specific group
operationId: getGroup
tags:
- Groups
security:
- bearerAuth: []
parameters:
- name: group_name
in: path
required: true
schema:
type: string
example: research-team
responses:
"200":
description: Group information
content:
application/json:
schema:
$ref: "#/components/schemas/GroupQueryInfo"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
/groups/{group_name}/users:
put:
summary: Update user group roles
description: Add users to group or update their roles
operationId: updateUserGroup
tags:
- Groups
security:
- bearerAuth: []
parameters:
- name: group_name
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateUserGroupRoleReq"
responses:
"200":
description: User roles updated successfully
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
delete:
summary: Remove users from group (query params)
description: Remove users from the group using query parameters
operationId: removeUserGroupParams
tags:
- Groups
security:
- bearerAuth: []
parameters:
- name: group_name
in: path
required: true
schema:
type: string
- name: users
in: query
required: false
style: form
explode: false
schema:
type: array
items:
type: string
description: Comma-separated list of usernames to remove
responses:
"200":
description: Users removed successfully
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
# /groups/{group_name}/users/remove:
# post:
# summary: Remove users from group (JSON body)
# description: Remove users from the group using JSON request body
# operationId: removeUserGroup
# tags:
# - Groups
# security:
# - bearerAuth: []
# parameters:
# - name: group_name
# in: path
# required: true
# schema:
# type: string
# requestBody:
# required: true
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/RemoveUserGroupRoleReq"
# responses:
# "200":
# description: Users removed successfully
# "401":
# $ref: "#/components/responses/Unauthorized"
# "403":
# $ref: "#/components/responses/Forbidden"
# "404":
# $ref: "#/components/responses/NotFound"
/groups/{group_name}/attachments:
post:
summary: Upload group attachment
description: Upload a file to the group's shared storage
operationId: uploadAttachment
tags:
- Groups
security:
- bearerAuth: []
parameters:
- name: group_name
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UploadAttachmentReq"
responses:
"200":
description: Upload URL generated
content:
application/json:
schema:
$ref: "#/components/schemas/UploadAttachmentResp"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
/groups/{group_name}/attachments/query:
post:
summary: Query group attachments
description: List attachments in the group with optional filtering
operationId: queryAttachments
tags:
- Groups
security:
- bearerAuth: []
parameters:
- name: group_name
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AttachmentsQueryReq"
responses:
"200":
description: List of attachments
content:
application/json:
schema:
$ref: "#/components/schemas/AttachmentsQueryResp"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
/groups/{group_name}/attachments/{key}:
get:
summary: Get attachment metadata
description: Get metadata for a specific attachment
operationId: queryAttachment
tags:
- Groups
security:
- bearerAuth: []
parameters:
- name: group_name
in: path
required: true
schema:
type: string
- name: key
in: path
required: true
schema:
type: string
style: simple
explode: false
responses:
"200":
description: Attachment metadata
content:
application/json:
schema:
$ref: "#/components/schemas/AttachmentMetadata"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
delete:
summary: Delete attachment
description: Delete a file from group's shared storage
operationId: deleteAttachment
tags:
- Groups
security:
- bearerAuth: []
parameters:
- name: group_name
in: path
required: true
schema:
type: string
- name: key
in: path
required: true
schema:
type: string
style: simple
explode: false
responses:
"200":
description: Attachment deleted successfully
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
/groups/{group_name}/download/attachments/{key}:
get:
summary: Download attachment
description: Get download URL for an attachment
operationId: downloadAttachment
tags:
- Groups
security:
- bearerAuth: []
parameters:
- name: group_name
in: path
required: true
schema:
type: string
- name: key
in: path
required: true
schema:
type: string
style: simple
explode: false
responses:
"302":
description: Redirect to download URL
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
/groups/{group_name}/download/attachments:
post:
summary: Batch download attachments by filter
description: Get download URLs for group attachments matching filter criteria
operationId: batchDownloadAttachmentsByFilter
tags:
- Groups
security:
- bearerAuth: []
parameters:
- name: group_name
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AttachmentsDownloadByFilterReq"
responses:
"200":
description: List of attachment download URLs
content:
application/json:
schema:
$ref: "#/components/schemas/AttachmentsDownloadListResp"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
/groups/{group_name}/download/attachments/list:
post:
summary: Batch download attachments by keys
description: Get download URLs for group attachments by specific keys
operationId: batchDownloadAttachmentsByKeys
tags:
- Groups
security:
- bearerAuth: []
parameters:
- name: group_name
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AttachmentsDownloadByKeysReq"
responses:
"200":
description: List of attachment download URLs
content:
application/json:
schema:
$ref: "#/components/schemas/AttachmentsDownloadListResp"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
/groups/{group_name}/delete/attachments:
post:
summary: Batch delete attachments by filter
description: Delete group attachments matching filter criteria
operationId: batchDeleteAttachmentsByFilter
tags:
- Groups
security:
- bearerAuth: []
parameters:
- name: group_name
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AttachmentsDeleteByFilterReq"
responses:
"200":
description: Attachment deletion results
content:
application/json:
schema:
$ref: "#/components/schemas/AttachmentsDeleteByFilterResp"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
/groups/{group_name}/delete/attachments/list:
post:
summary: Batch delete attachments by keys
description: Delete group attachments by specific keys
operationId: batchDeleteAttachmentsByKeys
tags:
- Groups
security:
- bearerAuth: []
parameters:
- name: group_name
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/AttachmentsDeleteByKeysReq"
responses:
"200":
description: Attachment deletion results
content:
application/json:
schema:
$ref: "#/components/schemas/AttachmentsDeleteByKeysResp"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
/workers:
post:
summary: Register worker
description: Register a new worker with the coordinator
operationId: registerWorker
tags:
- Workers
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/RegisterWorkerReq"
responses:
"200":
description: Worker registered successfully
content:
application/json:
schema:
$ref: "#/components/schemas/RegisterWorkerResp"
"401":
$ref: "#/components/responses/Unauthorized"
delete:
summary: Unregister worker
description: Unregister worker (worker auth required)
operationId: unregisterWorker
tags:
- Workers
security:
- workerAuth: []
responses:
"200":
description: Worker unregistered successfully
"401":
$ref: "#/components/responses/Unauthorized"
/workers/query:
post:
summary: Query workers
description: List workers with optional filtering
operationId: queryWorkers
tags:
- Workers
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/WorkersQueryReq"
responses:
"200":
description: List of workers
content:
application/json:
schema:
$ref: "#/components/schemas/WorkersQueryResp"
"401":
$ref: "#/components/responses/Unauthorized"
/workers/shutdown:
post:
summary: Batch shutdown workers
description: Shutdown multiple workers by filter criteria
operationId: shutdownWorkersByFilter
tags:
- Workers
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/WorkersShutdownByFilterReq"
responses:
"200":
description: Workers shutdown successfully
content:
application/json:
schema:
$ref: "#/components/schemas/WorkersShutdownByFilterResp"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
/workers/shutdown/list:
post:
summary: Batch shutdown workers by UUIDs
description: Shutdown multiple workers by specific UUIDs
operationId: shutdownWorkersByUuids
tags:
- Workers
security:
- bearerAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/WorkersShutdownByUuidsReq"
responses:
"200":
description: Workers shutdown successfully
content:
application/json:
schema:
$ref: "#/components/schemas/WorkersShutdownByUuidsResp"
"400":
$ref: "#/components/responses/BadRequest"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
/workers/{uuid}:
get:
summary: Get worker information
description: Get detailed information about a specific worker
operationId: getWorker
tags:
- Workers
security:
- bearerAuth: []
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
responses:
"200":
description: Worker information
content:
application/json:
schema:
$ref: "#/components/schemas/WorkerQueryResp"
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
delete:
summary: Shutdown worker
description: Request worker shutdown
operationId: shutdownWorker
tags:
- Workers
security:
- bearerAuth: []
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
- name: op
in: query
required: false
schema:
type: string
enum:
- graceful
- force
description: |
Worker shutdown operation:
- Graceful: Wait for current task to complete
- Force: Stop immediately
responses:
"200":
description: Shutdown request sent
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
/workers/{uuid}/tags:
put:
summary: Update worker tags
description: Replace worker's tags
operationId: updateWorkerTags
tags:
- Workers
security:
- bearerAuth: []
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ReplaceWorkerTagsReq"
responses:
"200":
description: Tags updated successfully
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
/workers/{uuid}/labels:
put:
summary: Update worker labels
description: Replace worker's labels
operationId: updateWorkerLabels
tags:
- Workers
security:
- bearerAuth: []
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/ReplaceWorkerLabelsReq"
responses:
"200":
description: Tags updated successfully
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
/workers/{uuid}/groups:
put:
summary: Update worker group roles
description: Add groups to worker or update their roles
operationId: updateWorkerGroups
tags:
- Workers
security:
- bearerAuth: []
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/UpdateGroupWorkerRoleReq"
responses:
"200":
description: Group roles updated successfully
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
delete:
summary: Remove worker group roles (query params)
description: Remove groups from worker using query parameters
operationId: removeWorkerGroupsParams
tags:
- Workers
security:
- bearerAuth: []
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
- name: groups
in: query
required: false
style: form
explode: false
schema:
type: array
items:
type: string
description: Comma-separated list of group names to remove
responses:
"200":
description: Groups removed successfully
"401":
$ref: "#/components/responses/Unauthorized"
"403":
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
# /workers/{uuid}/groups/remove:
# post:
# summary: Remove worker group roles (JSON body)
# description: Remove groups from worker using JSON request body
# operationId: removeWorkerGroups
# tags:
# - Workers
# security:
# - bearerAuth: []
# parameters:
# - name: uuid
# in: path
# required: true
# schema:
# type: string
# format: uuid
# requestBody:
# required: true
# content:
# application/json:
# schema:
# $ref: "#/components/schemas/RemoveGroupWorkerRoleReq"
# responses:
# "200":
# description: Groups removed successfully
# "401":
# $ref: "#/components/responses/Unauthorized"
# "403":
# $ref: "#/components/responses/Forbidden"
# "404":
# $ref: "#/components/responses/NotFound"
/workers/heartbeat:
post:
summary: Worker heartbeat
description: Worker sends heartbeat to coordinator
operationId: workerHeartbeat
tags:
- Workers
security:
- workerAuth: []
responses:
"200":
description: Heartbeat received
"401":
$ref: "#/components/responses/Unauthorized"
/workers/tasks:
get:
summary: Fetch task for worker
description: Worker fetches next available task
operationId: fetchTask
tags:
- Workers
security:
- workerAuth: []
responses:
"200":
description: Task assigned to worker