forked from AOT-Technologies/m8flow
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.yml
More file actions
1312 lines (1272 loc) · 38.2 KB
/
api.yml
File metadata and controls
1312 lines (1272 loc) · 38.2 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.2"
info:
version: 1.0.0
title: m8flow-backend-extension
paths:
/health:
get:
summary: Health check for load balancers and monitoring
description: Returns 200 when the process is up. Public, no authentication required.
operationId: m8flow_backend.tenancy.health_check
tags:
- Health
security: []
responses:
"200":
description: The server is running.
content:
application/json:
schema:
$ref: "#/components/schemas/HealthResponse"
/tenant-login-url:
get:
summary: Get Keycloak login URL for a tenant realm (unauthenticated)
description: Checks Keycloak for the tenant realm; if it exists returns the authorization URL for that realm.
operationId: m8flow_backend.routes.keycloak_controller.get_tenant_login_url
tags:
- Keycloak
security: []
parameters:
- name: tenant
in: query
required: true
schema:
type: string
description: Tenant (realm) name to look up in Keycloak
responses:
"200":
description: Tenant realm exists; login URL returned
content:
application/json:
schema:
type: object
required:
- login_url
properties:
login_url:
type: string
description: Keycloak authorization (login) base URL for the tenant realm
realm:
type: string
description: Realm name
"400":
description: Bad request - tenant missing
content:
application/json:
schema:
type: object
properties:
detail:
type: string
"404":
description: Tenant realm not found in Keycloak
content:
application/json:
schema:
type: object
properties:
detail:
type: string
/tenant-realms:
post:
summary: Create a spoke realm from the SpiffWorkflow template
description: Creates a Keycloak realm from the template and ensures a tenant record exists. Does not require tenant context (bootstrap/admin). Redirect URIs for the new realm are derived from M8FLOW_APP_PUBLIC_BASE_URL or KEYCLOAK_HOSTNAME (frontend at /, backend at /api).
operationId: m8flow_backend.routes.keycloak_controller.create_realm
tags:
- Keycloak
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- realm_id
properties:
realm_id:
type: string
description: Keycloak realm id (required)
display_name:
type: string
description: Optional display name for the realm
responses:
"201":
description: Realm created successfully
content:
application/json:
schema:
type: object
properties:
realm:
type: string
description: Realm name (slug)
displayName:
type: string
keycloak_realm_id:
type: string
description: Keycloak realm UUID (stored as M8flowTenantModel.id)
id:
type: string
description: Same as keycloak_realm_id (Keycloak realm UUID)
"400":
description: Bad request - realm_id missing or invalid
content:
application/json:
schema:
type: object
properties:
detail:
type: string
"409":
description: Realm already exists or conflict
content:
application/json:
schema:
type: object
properties:
detail:
type: string
"500":
description: Keycloak or server error
content:
application/json:
schema:
type: object
properties:
detail:
type: string
/tenant-realms/{realm_id}:
delete:
summary: Delete a Keycloak realm and its associated tenant
description: Removes the realm from Keycloak and the tenant record from Postgres. Requires a valid master admin token. The path parameter is the realm name (slug), not the Keycloak realm UUID.
operationId: m8flow_backend.routes.keycloak_controller.delete_tenant_realm
tags:
- Keycloak
parameters:
- name: realm_id
in: path
required: true
schema:
type: string
description: The realm name (slug) of the realm to delete, not the Keycloak UUID
responses:
"200":
description: Tenant deleted successfully
content:
application/json:
schema:
type: object
properties:
message:
type: string
"401":
description: Unauthorized - missing or invalid admin token
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"404":
description: Realm not found in Keycloak
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/tenants/check:
get:
summary: Check if tenant exists by slug or id (unauthenticated)
description: For pre-login tenant selection. Only considers ACTIVE tenants.
operationId: m8flow_backend.routes.tenant_controller.check_tenant_exists
tags:
- Tenant
security: []
parameters:
- name: identifier
in: query
required: true
schema:
type: string
description: Tenant slug or id to look up
responses:
"200":
description: Check result
content:
application/json:
schema:
$ref: "#/components/schemas/TenantExistsResponse"
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/tenants/slug/{slug}:
get:
summary: Get tenant by slug
operationId: m8flow_backend.routes.tenant_controller.get_tenant_by_slug
tags:
- Tenant
parameters:
- name: slug
in: path
required: true
schema:
type: string
description: Human-readable slug identifier of the tenant
responses:
"200":
description: Tenant retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/TenantResponse"
"401":
description: Unauthorized - user not authenticated
"403":
description: Forbidden - cannot access default tenant
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"404":
description: Tenant not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/tenants:
get:
summary: Get all tenants
operationId: m8flow_backend.routes.tenant_controller.get_all_tenants
tags:
- Tenant
responses:
"200":
description: List of all tenants
content:
application/json:
schema:
$ref: "#/components/schemas/TenantListResponse"
"401":
description: Unauthorized - user not authenticated
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/tenants/{tenant_id}:
get:
summary: Get tenant by ID
operationId: m8flow_backend.routes.tenant_controller.get_tenant_by_id
tags:
- Tenant
parameters:
- name: tenant_id
in: path
required: true
schema:
type: string
description: Unique identifier of the tenant
responses:
"200":
description: Tenant retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/TenantResponse"
"401":
description: Unauthorized - user not authenticated
"403":
description: Forbidden - cannot access default tenant
"404":
description: Tenant not found
put:
summary: Update tenant display name
description: Updates the tenant's human-readable name in both the local database and the Keycloak realm (displayName). The slug and ID are immutable and cannot be changed.
operationId: m8flow_backend.routes.keycloak_controller.update_tenant_name
tags:
- Tenant
parameters:
- name: tenant_id
in: path
required: true
schema:
type: string
description: Unique identifier (UUID) of the tenant to update
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- name
properties:
name:
type: string
description: New display name for the tenant
example:
name: "Updated Tenant Name"
responses:
"200":
description: Tenant updated successfully
content:
application/json:
schema:
$ref: "#/components/schemas/MessageResponse"
"400":
description: Bad request - no fields to update, slug update attempted, tenant is deleted, or invalid status
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"401":
description: Unauthorized - user not authenticated
"403":
description: Forbidden - cannot update default tenant
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"404":
description: Tenant not found
"500":
description: Internal server error
/templates:
get:
summary: List templates
description: Retrieves a list of templates with optional filtering by latest version, category, tag, owner, visibility, and search query
operationId: m8flow_backend.routes.templates_controller.template_list
tags:
- Template
parameters:
- name: latest_only
in: query
schema:
type: boolean
description: Filter to show only the latest version of each template
- name: category
in: query
schema:
type: string
description: Filter templates by category
- name: tag
in: query
schema:
type: string
description: Filter templates by tag
- name: owner
in: query
schema:
type: string
description: Filter templates by owner
- name: visibility
in: query
schema:
type: string
enum: [PRIVATE, TENANT, PUBLIC]
description: Filter templates by visibility level
- name: search
in: query
schema:
type: string
description: Search templates by name or description
- name: template_key
in: query
schema:
type: string
description: Filter to this template key (returns all versions if latest_only=false)
- name: published_only
in: query
schema:
type: boolean
description: When true, return only published templates
- name: sort_by
in: query
schema:
type: string
enum: [created, name]
description: Sort results by created date or name
- name: order
in: query
schema:
type: string
enum: [asc, desc]
default: desc
description: Sort order (asc or desc)
- name: page
in: query
schema:
type: integer
default: 1
description: Page number (1-indexed)
- name: per_page
in: query
schema:
type: integer
default: 10
description: Items per page (max 100)
responses:
"200":
description: List of templates retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/TemplateListResponse"
"401":
description: Unauthorized - user not authenticated
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
post:
summary: Create template
description: Creates a new template using BPMN XML content with metadata provided via X-Template-* headers.
operationId: m8flow_backend.routes.templates_controller.template_create
tags:
- Template
parameters:
- name: X-Template-Key
in: header
required: true
schema:
type: string
description: Unique key for the template.
- name: X-Template-Name
in: header
required: true
schema:
type: string
description: Human-readable name of the template.
- name: X-Template-Description
in: header
required: false
schema:
type: string
description: Optional description of the template.
- name: X-Template-Category
in: header
required: false
schema:
type: string
description: Optional category for grouping templates.
- name: X-Template-Tags
in: header
required: false
schema:
type: string
description: JSON array string or comma-separated list of tags.
- name: X-Template-Visibility
in: header
required: false
schema:
type: string
enum: [PRIVATE, TENANT, PUBLIC]
description: Visibility level of the template. Defaults to PRIVATE.
- name: X-Template-Status
in: header
required: false
schema:
type: string
description: Status of the template. Defaults to draft.
- name: X-Template-Is-Published
in: header
required: false
schema:
type: string
enum: ["true", "false"]
description: Whether the template is published. Defaults to false.
- name: X-Template-Version
in: header
required: false
schema:
type: string
description: Optional explicit version identifier (e.g., V1). If omitted, the next version will be generated automatically.
requestBody:
required: true
content:
application/xml:
schema:
type: string
description: BPMN XML content (single file)
multipart/form-data:
schema:
type: object
properties:
files:
type: array
items:
type: string
format: binary
description: Multiple files (.bpmn, .json, .dmn, .md). At least one .bpmn required. Metadata via X-Template-* headers.
responses:
"201":
description: Template created successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Template"
"400":
description: Bad request - missing required fields or invalid data
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"401":
description: Unauthorized - user not authenticated
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"409":
description: Conflict - template with the same key and version already exists
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/templates/{id}:
get:
summary: Get template by ID
description: Retrieves a specific template by its unique identifier
operationId: m8flow_backend.routes.templates_controller.template_get_by_id
tags:
- Template
parameters:
- name: id
in: path
required: true
schema:
type: integer
description: Unique identifier of the template
- name: include_contents
in: query
required: false
schema:
type: boolean
default: true
description: Whether to include BPMN content in the response. Set to false for better performance when only metadata is needed.
responses:
"200":
description: Template retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Template"
"401":
description: Unauthorized - user not authenticated
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"404":
description: Template not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
put:
summary: Update template
description: Updates an existing template's metadata and optionally its BPMN content. Cannot update template_key or version
operationId: m8flow_backend.routes.templates_controller.template_update_by_id
tags:
- Template
parameters:
- name: id
in: path
required: true
schema:
type: integer
description: Unique identifier of the template to update
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/TemplateUpdateRequest"
application/xml:
schema:
type: string
description: Updated BPMN XML content
responses:
"200":
description: Template updated successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Template"
"400":
description: Bad request - no fields to update or invalid data
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"401":
description: Unauthorized - user not authenticated
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"404":
description: Template not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
delete:
summary: Soft delete template
description: Marks a template as deleted by setting is_deleted flag to true without removing from database
operationId: m8flow_backend.routes.templates_controller.template_delete_by_id
tags:
- Template
parameters:
- name: id
in: path
required: true
schema:
type: integer
description: Unique identifier of the template to delete
responses:
"200":
description: Template soft deleted successfully
content:
application/json:
schema:
$ref: "#/components/schemas/MessageResponse"
"400":
description: Bad request - published template cannot be deleted (immutable)
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"401":
description: Unauthorized - user not authenticated
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"403":
description: Forbidden - user not allowed to delete this template
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"404":
description: Template not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/templates/{id}/create-process-model:
post:
summary: Create a process model from a template
operationId: m8flow_backend.routes.templates_controller.template_create_process_model
tags:
- Template
parameters:
- name: id
in: path
required: true
schema:
type: integer
description: Template ID
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CreateProcessModelFromTemplateRequest"
responses:
"201":
description: Process model created successfully
content:
application/json:
schema:
$ref: "#/components/schemas/CreateProcessModelFromTemplateResponse"
"400":
description: Bad request - missing required fields
"401":
description: Unauthorized
"404":
description: Template not found
/templates/import:
post:
summary: Import template from zip
description: Creates a new template from an uploaded zip file. Metadata via X-Template-* headers. Zip must contain at least one .bpmn file.
operationId: m8flow_backend.routes.templates_controller.template_import
tags:
- Template
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
zip:
type: string
format: binary
application/zip:
schema:
type: string
format: binary
responses:
"201":
description: Template created successfully
content:
application/json:
schema:
$ref: "#/components/schemas/Template"
"400":
description: Bad request
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/templates/{id}/bpmn:
get:
summary: Get BPMN XML
description: Retrieves the BPMN XML content associated with a specific template
operationId: m8flow_backend.routes.templates_controller.template_get_bpmn
tags:
- Template
parameters:
- name: id
in: path
required: true
schema:
type: integer
description: Unique identifier of the template
responses:
"200":
description: BPMN XML retrieved successfully
content:
application/xml:
schema:
type: string
description: BPMN 2.0 XML content
"401":
description: Unauthorized - user not authenticated
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"404":
description: Template or BPMN content not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/templates/{id}/export:
get:
summary: Export template as zip
description: Returns a zip file containing all template files for this version
operationId: m8flow_backend.routes.templates_controller.template_export
tags:
- Template
parameters:
- name: id
in: path
required: true
schema:
type: integer
responses:
"200":
description: Zip file
content:
application/zip:
schema:
type: string
format: binary
"404":
description: Template not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
/templates/{id}/files/{file_name}:
get:
summary: Get a template file by name
description: Download a single file (BPMN, JSON, DMN, etc.) by filename
operationId: m8flow_backend.routes.templates_controller.template_get_file
tags:
- Template
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: file_name
in: path
required: true
schema:
type: string
responses:
"200":
description: File content
content:
application/xml:
schema:
type: string
application/json:
schema:
type: string
text/markdown:
schema:
type: string
"404":
description: Template or file not found
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
"500":
description: Internal server error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
put:
summary: Update a template file by name
description: Update content of a single file. Template must not be published.
operationId: m8flow_backend.routes.templates_controller.template_put_file
tags:
- Template
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: file_name
in: path
required: true
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
type: string
application/xml:
schema:
type: string
text/markdown:
schema:
type: string
text/plain:
schema:
type: string
responses:
"200":
description: File updated, returns the updated template
content:
application/json:
schema:
$ref: "#/components/schemas/Template"
"400":
description: Bad request
"403":
description: Template is published
"404":
description: Template or file not found
"500":
description: Internal server error
delete:
summary: Delete a template file by name
description: Remove a file from the template. Template must not be published. Cannot delete last file or only BPMN.
operationId: m8flow_backend.routes.templates_controller.template_delete_file
tags:
- Template
parameters:
- name: id
in: path
required: true
schema:
type: integer
- name: file_name
in: path
required: true
schema:
type: string
responses:
"204":
description: File deleted
"403":
description: Forbidden (published template or last file or only BPMN)
"404":
description: Template or file not found
"500":
description: Internal server error
/templates/process-models/{modified_process_model_identifier}/template-info:
get:
summary: Get template info for a process model
description: Returns the template provenance info if the process model was created from a template
operationId: m8flow_backend.routes.templates_controller.get_process_model_template_info
tags:
- Template
parameters:
- name: modified_process_model_identifier
in: path
required: true
schema:
type: string
description: Process model identifier with slashes replaced by colons
responses:
"200":
description: Template info retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/ProcessModelTemplateInfo"