Skip to content

Commit 41269bd

Browse files
docs: add web socket asyncapi documentation
1 parent a544751 commit 41269bd

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/openapi/openapi.yml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ tags:
3030
description: This is the available API to manage and obtain information about automantion scenarios.
3131
- name: Tracking API
3232
description: This is the available API to manage and obtain information about health professionals tracking data.
33-
33+
- name: WebSocket API
34+
description: This is the available API to connect to the Operating Room Dashboard WebSocket.
3435
paths:
3536
/auth:
3637
post:
@@ -359,6 +360,19 @@ paths:
359360
schema:
360361
$ref: '#/components/schemas/TrackingData'
361362

363+
/socket-connection:
364+
get:
365+
servers:
366+
- url: http://localhost:<port>/api/v1/ord/
367+
tags:
368+
- WebSocket API
369+
summary: connect to web socket
370+
operationId: connectToWebSocket
371+
description: Connect to ORD Web Socket
372+
responses:
373+
'200':
374+
description: connection ok
375+
362376
components:
363377
schemas:
364378

0 commit comments

Comments
 (0)