Skip to content

Commit 85d19b7

Browse files
docs(rest-api): add medical technology api documentation
1 parent facc278 commit 85d19b7

File tree

1 file changed

+102
-0
lines changed

1 file changed

+102
-0
lines changed

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

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,108 @@ paths:
8484
'500':
8585
description: server error occurred
8686

87+
/medicalTechnologies:
88+
post:
89+
summary: insert a new medical technology
90+
operationId: insertMedicalTechnology
91+
description: Add new medical technology to the operating block
92+
responses:
93+
'201':
94+
description: medical technology created
95+
'400':
96+
description: invalid input, object invalid
97+
'409':
98+
description: a medical technology with the same id already exists
99+
'500':
100+
description: server error occurred
101+
requestBody:
102+
content:
103+
application/json:
104+
schema:
105+
$ref: '#/components/schemas/MedicalTechnology'
106+
description: Medical Technology to add
107+
108+
/medicalTechnologies/{technology-id}:
109+
get:
110+
summary: get the medical technology information
111+
operationId: getMedicalTechnology
112+
description: Get medical technology information
113+
parameters:
114+
- in: path
115+
name: technology-id
116+
description: the medical technology's ID
117+
required: true
118+
schema:
119+
type: string
120+
- in: query
121+
name: dateTime
122+
required: false
123+
description: Specify a past date in order to obtain historical data
124+
schema:
125+
type: string
126+
format: date-time
127+
example: '2017-07-21T17:32:28Z'
128+
responses:
129+
'200':
130+
description: search result
131+
content:
132+
application/json:
133+
schema:
134+
$ref: '#/components/schemas/MedicalTechnology'
135+
'404':
136+
description: medical technology not found
137+
'500':
138+
description: server error occurred
139+
delete:
140+
summary: delete the medical technology
141+
operationId: deleteMedicalTechnology
142+
description: Delete a medical technology
143+
parameters:
144+
- in: path
145+
name: technology-id
146+
description: the medical technology's ID
147+
required: true
148+
schema:
149+
type: string
150+
responses:
151+
'204':
152+
description: medical technology deleted
153+
'404':
154+
description: medical technology not found
155+
'500':
156+
description: server error occurred
157+
patch:
158+
summary: update medical technology mapping
159+
operationId: updateMedicalTechnology
160+
description: Map the medical technology to a room inside the Operating Block
161+
parameters:
162+
- in: path
163+
name: technology-id
164+
description: the medical technology's ID
165+
required: true
166+
schema:
167+
type: string
168+
requestBody:
169+
content:
170+
application/merge-patch+json:
171+
schema:
172+
type: object
173+
properties:
174+
room-id:
175+
type: string
176+
example: Room-#2
177+
description: room to specify a new mapping, null if you want to delete mapping
178+
description: the new mapping
179+
responses:
180+
'204':
181+
description: medical technology updated
182+
'400':
183+
description: malformed merge patch file
184+
'404':
185+
description: medical technology not found
186+
'500':
187+
description: server error occurred
188+
87189
components:
88190
schemas:
89191
Room:

0 commit comments

Comments
 (0)