-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
1469 lines (1468 loc) · 44.8 KB
/
openapi.yaml
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: MIRACUM Mapping Tool Backend
# summary: A MIRACUM Mapping Tool Backend
description: This is the backend for the MIRACUM Mapping Tool. It provides an API to manage projects with their corresponding mappings. Code Systems can be managed as well. The API uses Keycloak for authentication and authorization.
# termsOfService: "https://miracum.org"
# contact:
# name: API Support
# url: "https://miracum.org"
# email: [email protected]
license:
name: GPL-3.0 License
# identifier: GPL-3.0-or-later
url: "https://www.gnu.org/licenses/gpl-3.0.html"
version: "1.0.0"
# servers:
# - url: http://localhost:8080
# description: Development server
# - url: https://api.miracum.org
# description: Production server
# externalDocs:
# description: Find out more about Swagger
# url: http://swagger.io
tags:
- name: status
description: Status about the server
# externalDocs:
# description: Find out more
# url: http://swagger.io
- name: project
description: Operations about projects
- name: project-permission
description: Operations about project permissions
- name: project-codesystem-roles
description: Operations about the defined systems of a project
- name: mapping
description: Operations about mappings
- name: user
description: Operations about users
- name: code-system
description: Operations about code systems
- name: concept
description: Operations about concepts
paths:
/ping:
get:
tags:
- status
summary: Check if the server is running
description: This endpoint can be used to check if the server is running. It returns a simple pong message.
operationId: ping
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: "pong"
security: []
/projects:
get:
tags:
- project
summary: Get all projects
description: Get all projects with pagination. Sorting can also be specified by query parameters.
operationId: getAllProjects
parameters:
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/pageSize"
- name: sortBy
in: query
description: Field to sort sortBy
required: false
schema:
type: string
default: id
enum: [name, dateCreated, id]
- $ref: "#/components/parameters/sortOrder"
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/Project"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"404":
description: Page not found (e.g., page number too high)
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
post:
tags:
- project
summary: Create a new project
description: Create a new project with permissions and code system roles (the columns in the mapping table). Code system roles can not be changed after creation.
parameters: []
operationId: createProject
requestBody:
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/CreateProjectDetails" # id prohibited/ignored, CodeSystemRoles required, Permissions optional
responses:
"200":
description: Success
content:
application/json:
schema:
$ref: "#/components/schemas/ProjectDetails" # id required
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"422":
description: Validation Exception
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
security:
- OAuth2: [admin]
- BearerAuth: [admin]
put:
tags:
- project
summary: Update the project information
description: Update the project information. Does not update the permissions for the users or the code system roles (the columns in the mapping table).
operationId: updateProject
requestBody:
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/UpdateProject"
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/Project"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"422":
description: Validation Exception # validate if id is provided in requestBody, it matches with the id in the path
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
/projects/{project_id}:
get:
tags:
- project
summary: Get project details
description: Get the project details by ID including the list of project permissions and code system roles (the columns in the mapping table)
parameters:
- $ref: "#/components/parameters/project_id"
operationId: getProject
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/ProjectDetails" # project id optional, permissions required
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
delete:
tags:
- project
summary: Delete a project
description: Delete a project by ID. This will also delete all mappings and elements of the project as well as the permissions for the project and the code system roles.
parameters:
- $ref: "#/components/parameters/project_id"
operationId: deleteProject
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/Project"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"404":
description: Project not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
security:
- OAuth2: [admin]
- BearerAuth: [admin]
/projects/{project_id}/permissions:
get:
tags:
- project-permission
summary: Get permissions for a project
description: Get all permissions for a project by project ID.
parameters:
- $ref: "#/components/parameters/project_id"
operationId: getAllPermissions
responses:
"200":
description: Success
content:
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/ProjectPermission"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
post:
tags:
- project-permission
summary: Create a new project permission for user
description: Create a new project permission for a user by the user ID.
parameters:
- $ref: "#/components/parameters/project_id"
operationId: createPermission
requestBody:
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/SendProjectPermission"
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/ProjectPermission"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project or user not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"422":
description: Validation Exception # e.g if trying to create a permission for a user that already has a permission for the project, or and invalid permission role
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
put:
tags:
- project-permission
summary: Update a project permission for a user
description: Update a project permission for a user by the user ID
parameters:
- $ref: "#/components/parameters/project_id"
operationId: updatePermission
requestBody:
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/SendProjectPermission"
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/ProjectPermission"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project or user not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"422":
description: Validation Exception
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
/projects/{project_id}/permissions/{user_id}:
get:
tags:
- project-permission
summary: Get project permission for a specific user
description: Get the project permission for a specific user by the user ID.
parameters:
- $ref: "#/components/parameters/project_id"
- $ref: "#/components/parameters/user_id"
operationId: getPermission
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/ProjectPermission"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project or user not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
delete:
tags:
- project-permission
summary: Delete a project permission for a user
description: Delete a project permission for a user by the user ID
parameters:
- $ref: "#/components/parameters/project_id"
- $ref: "#/components/parameters/user_id"
operationId: deletePermission
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/ProjectPermission"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project or user not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
/projects/{project_id}/codesystem-roles:
get:
tags:
- project-codesystem-roles
summary: Get all code system roles for a project
description: Get all code system roles (columns in the mapping table) for a project by project ID
parameters:
- $ref: "#/components/parameters/project_id"
operationId: getAllCodeSystemRoles
responses:
"200":
description: Success
content:
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/CodeSystemRole"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
put:
tags:
- project-codesystem-roles
summary: Update a code system role by ID
description: Update name or type from a code system role (column in the mapping table) by ID
parameters:
- $ref: "#/components/parameters/project_id"
operationId: updateCodeSystemRole
requestBody:
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/UpdateCodeSystemRole" # id optional
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/CodeSystemRole" # id optional
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project or codesystem-role not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"422":
description:
Validation Error # if trying to change the system of the codesystem-role. only name or type of the codesystem-role can be changed
# if codesystem-role id is provided in the request body and doesn't match the codesystem-role id in the path
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
/projects/{project_id}/codesystem-roles/{codesystem-role_id}:
get:
tags:
- project-codesystem-roles
summary: Get a code system role by ID
description: Get a code system role (column in the mapping table) by ID
parameters:
- $ref: "#/components/parameters/project_id"
- $ref: "#/components/parameters/codesystem-role_id"
operationId: getCodeSystemRole
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/CodeSystemRole" # id required
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project or codesystem-role not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
/projects/{project_id}/mappings:
get:
tags:
- mapping
summary: Get all mappings for a project by project ID
description: Get all mappings for a project by project ID. The mappings include all elements with concepts. Paging and sorting can be specified by query parameters.
parameters:
- $ref: "#/components/parameters/project_id"
- $ref: "#/components/parameters/page"
- $ref: "#/components/parameters/pageSize"
- name: sortBy
in: query
description: Field to sort by
required: false
schema:
type: string
default: id
enum: [id, equivalence, status, comment, created, modified]
- $ref: "#/components/parameters/sortOrder"
operationId: getAllMappings
responses:
"200":
description: Success
content:
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/Mapping" # id required
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Page not found (e.g., page number too high)
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
post:
tags:
- mapping
summary: Create a new mapping for a project
description: Create a new mapping for a project by project ID including all needed elements (specified by code_system_roles from the corresponding project)
parameters:
- $ref: "#/components/parameters/project_id"
operationId: createMapping
requestBody:
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/CreateMapping" # id prohibited/ignored
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/Mapping" # id optional
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"422":
description: Validation Exception
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
put:
tags:
- mapping
summary: Update a mapping and its elements by their concept IDs
description: Update a mapping by ID and all included elements by using the corresponding concept IDs.
parameters:
- $ref: "#/components/parameters/project_id"
operationId: updateMapping
requestBody:
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/UpdateMapping" # id required
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/Mapping" # id optional
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project or Mapping not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"422":
description: Validation Error # if trying to change the project of the mapping
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
patch:
tags:
- mapping
summary: Update a mapping and its elements by their concept IDs
description: Update a mapping by ID and all included elements by using the corresponding concept IDs. Missing elements are deleted.
parameters:
- $ref: "#/components/parameters/project_id"
operationId: patchMapping
requestBody:
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/UpdateMapping"
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/Mapping"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project or Mapping not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"422":
description: Validation Error # if trying to change the project of the mapping
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
/projects/{project_id}/mappings/{mapping_id}:
get:
tags:
- mapping
summary: Get a mapping with its elements by ID
description: Get a mapping by ID and all included elements. The elements include the concept with the system-id.
parameters:
- $ref: "#/components/parameters/project_id"
- $ref: "#/components/parameters/mapping_id"
operationId: getMapping
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/Mapping" # id required
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project or Mapping not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
delete:
tags:
- mapping
summary: Delete a mapping and its elements by ID
description: Delete a mapping by ID and all included elements.
parameters:
- $ref: "#/components/parameters/project_id"
- $ref: "#/components/parameters/mapping_id"
operationId: deleteMapping
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/Mapping" # id optional
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"403":
"$ref": "#/components/responses/ForbiddenError"
"404":
description: Project or Mapping not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
/users:
get:
tags:
- user
summary: Get all users
description: Get all users.
operationId: getAllUsers
responses:
"200":
description: Successful operation
content:
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/User"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"500":
"$ref": "#/components/responses/InternalServerError"
/users/{user_id}:
delete:
tags:
- user
summary: Delete a user
description: Delete a user by ID. This will also delete all the permissions, the user has for the project.
parameters:
- $ref: "#/components/parameters/user_id"
operationId: deleteUser
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/User"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"404":
description: User not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
security:
- OAuth2: [admin]
- BearerAuth: [admin]
/users/login:
post:
tags:
- user
summary: Updates user-database with information from Access-Token
operationId: login
responses:
"200":
description: Successful operation
content:
application/json:
schema:
"$ref": "#/components/schemas/User"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"500":
"$ref": "#/components/responses/InternalServerError"
/codesystems:
get:
tags:
- code-system
summary: Get all code systems
description: Get all code systems.
operationId: getAllCodeSystems
responses:
"200":
description: Success
content:
application/json:
schema:
type: array
items:
"$ref": "#/components/schemas/CodeSystem"
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"500":
"$ref": "#/components/responses/InternalServerError"
post:
tags:
- code-system
summary: Create a new code system
description: Create a new code system. Only admins can create code systems.
operationId: createCodeSystem
requestBody:
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/CreateCodeSystem" # id prohibited/ignored
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/CodeSystem" # id optional
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"404":
description: CodeSystem not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"422":
description: Validation Exception
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
security:
- OAuth2: [admin]
- BearerAuth: [admin]
put:
tags:
- code-system
summary: Update a code system by ID
description: Update a code system by ID. Only admins can update code systems.
operationId: updateCodeSystem
requestBody:
required: true
content:
application/json:
schema:
"$ref": "#/components/schemas/CodeSystem" # id optional
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/CodeSystem" # id optional
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"404":
description: Codesystem not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"422":
description: Validation Error # if id is provided in the request body it must match the id in the path
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
security:
- OAuth2: [admin]
- BearerAuth: [admin]
/codesystems/{codesystem_id}:
get:
tags:
- code-system
summary: Get a code system by ID
description: Get a code system by ID.
parameters:
- $ref: "#/components/parameters/codesystem_id"
operationId: getCodeSystem
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/CodeSystem" # id required
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"404":
description: CodeSystem not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
delete:
tags:
- code-system
summary: Delete a code system by ID
description: Delete a code system by ID. Only admins can delete code systems.
parameters:
- $ref: "#/components/parameters/codesystem_id"
operationId: deleteCodeSystem
responses:
"200":
description: Success
content:
application/json:
schema:
"$ref": "#/components/schemas/CodeSystem" # id optional
"400":
"$ref": "#/components/responses/BadRequestError"
"401":
"$ref": "#/components/responses/UnauthorizedError"
"404":
description: Codesystem not found
content:
application/json:
schema:
"$ref": "#/components/schemas/ErrorResponse"
"500":
"$ref": "#/components/responses/InternalServerError"
security:
- OAuth2: [admin]
- BearerAuth: [admin]
/codesystems/{codesystem_id}/import:
post:
tags:
- code-system
summary: Import concepts for a code system by ID
description: Import concepts for a code system by ID. The concepts are imported from a CSV file. The format of the CSV must be "code,meaning"
parameters:
- $ref: "#/components/parameters/codesystem_id"
operationId: importCodeSystem
requestBody:
required: true
content:
text/csv:
schema:
type: string
example: |
code,meaning
123,test meaning 1
456,another meaning
789,third meaning
responses:
"202":