-
Notifications
You must be signed in to change notification settings - Fork 18
/
modalities.raml
77 lines (76 loc) · 1.89 KB
/
modalities.raml
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
description: Utility functions for modalities and their acceptable classifications.
get:
description: |
List all modalities and their classifications.
Requires login.
responses:
200:
body:
application/json:
example: !include ../examples/output/modality-list.json
schema: !include ../schemas/output/modality-list.json
post:
description: |
Insert a modality type and its classifications map.
Requires admin.
body:
application/json:
example: !include ../examples/input/modality-new.json
schema: !include ../schemas/input/modality.json
responses:
200:
body:
application/json:
example: |
{
"inserted": "1"
}
/{ModalityName}:
description: Perform actions with a specific modality
uriParameters:
ModalityName:
type: string
get:
description: |
Get modality details.
Requires login.
responses:
200:
body:
application/json:
example: !include ../examples/output/modality.json
schema: !include ../schemas/output/modality.json
404:
description: Modality not found
put:
description: |
Replace a modality's classifications map.
Requires admin.
body:
application/json:
example: !include ../examples/input/modality-update.json
schema: !include ../schemas/input/modality.json
responses:
200:
body:
application/json:
example: |
{
"modified": "1"
}
404:
description: Modality not found
delete:
description: |
Remove a modality.
Requires admin.
responses:
200:
body:
application/json:
example: |
{
"modified": "1"
}
404:
description: Modality not found