Skip to content

Commit 532fc19

Browse files
docs(rest-api): correct medical technology mapping request body and update ids in examples with valid ones
1 parent 9c55801 commit 532fc19

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

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

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -250,9 +250,9 @@ paths:
250250
schema:
251251
type: object
252252
properties:
253-
room-id:
253+
roomId:
254254
type: string
255-
example: Room-#2
255+
example: Room-2
256256
description: room to specify a new mapping, null if you want to delete mapping
257257
description: the new mapping
258258
responses:
@@ -277,13 +277,13 @@ components:
277277
properties:
278278
id:
279279
type: string
280-
example: Room-#1
280+
example: Room-1
281281
name:
282282
type: string
283283
example: Mario Rossi's Operating Room - Bufalini Hospital
284284
zoneId:
285285
type: string
286-
example: Zone-#1
286+
example: Zone-1
287287
type:
288288
$ref: '#/components/schemas/RoomType'
289289

@@ -301,7 +301,7 @@ components:
301301
url:
302302
type: string
303303
format: uri
304-
example: 'http://localhost:3000/api/v1/rooms/Room-#1'
304+
example: 'http://localhost:3000/api/v1/rooms/Room-1'
305305
total:
306306
type: integer
307307
description: the total number of room entries
@@ -312,13 +312,13 @@ components:
312312
properties:
313313
id:
314314
type: string
315-
example: Room-#1
315+
example: Room-1
316316
name:
317317
type: string
318318
example: Mario Rossi's Operating Room - Bufalini Hospital
319319
zoneId:
320320
type: string
321-
example: Zone-#1
321+
example: Zone-1
322322
type:
323323
$ref: '#/components/schemas/RoomType'
324324
environmentalData:
@@ -359,7 +359,7 @@ components:
359359
properties:
360360
entries:
361361
type: array
362-
description: room's environemtal data entries
362+
description: room's environmental data entries
363363
items:
364364
type: object
365365
properties:
@@ -398,7 +398,7 @@ components:
398398
properties:
399399
id:
400400
type: string
401-
example: mt-#1
401+
example: mt-1
402402
name:
403403
type: string
404404
example: Endoscope
@@ -408,6 +408,6 @@ components:
408408
type: boolean
409409
roomId:
410410
type: string
411-
example: Room-#1
411+
example: Room-1
412412
type:
413413
$ref: '#/components/schemas/MedicalTechnologyType'

0 commit comments

Comments
 (0)