Skip to content

Commit 37d4ab5

Browse files
docs(rest-api): add tags to documentation to separate apis
1 parent a0b03d7 commit 37d4ab5

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/rest-api/rest-api-docs.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,17 @@ info:
1212
name: MIT License
1313
url: 'https://opensource.org/license/mit/'
1414

15+
tags:
16+
- name: Room API
17+
description: This is the available API to manage and obtain information about rooms within the Operating Block.
18+
- name: Medical Technology API
19+
description: This is the available API to manage and obtain information about rooms within the Operating Block.
20+
1521
paths:
1622
/rooms:
1723
post:
24+
tags:
25+
- Room API
1826
summary: insert a new room
1927
operationId: insertRoom
2028
description: Add new room to the operating block
@@ -36,6 +44,8 @@ paths:
3644

3745
/rooms/{room-id}:
3846
get:
47+
tags:
48+
- Room API
3949
summary: get the room information
4050
operationId: getRoom
4151
description: Get room information
@@ -66,6 +76,8 @@ paths:
6676
'500':
6777
description: server error occurred
6878
delete:
79+
tags:
80+
- Room API
6981
summary: delete the room
7082
operationId: deleteRoom
7183
description: Delete a room
@@ -86,6 +98,8 @@ paths:
8698

8799
/medicalTechnologies:
88100
post:
101+
tags:
102+
- Medical Technology API
89103
summary: insert a new medical technology
90104
operationId: insertMedicalTechnology
91105
description: Add new medical technology to the operating block
@@ -107,6 +121,8 @@ paths:
107121

108122
/medicalTechnologies/{technology-id}:
109123
get:
124+
tags:
125+
- Medical Technology API
110126
summary: get the medical technology information
111127
operationId: getMedicalTechnology
112128
description: Get medical technology information
@@ -137,6 +153,8 @@ paths:
137153
'500':
138154
description: server error occurred
139155
delete:
156+
tags:
157+
- Medical Technology API
140158
summary: delete the medical technology
141159
operationId: deleteMedicalTechnology
142160
description: Delete a medical technology
@@ -155,6 +173,8 @@ paths:
155173
'500':
156174
description: server error occurred
157175
patch:
176+
tags:
177+
- Medical Technology API
158178
summary: update medical technology mapping
159179
operationId: updateMedicalTechnology
160180
description: Map the medical technology to a room inside the Operating Block

0 commit comments

Comments
 (0)