Skip to content

Commit 006d332

Browse files
docs: add return code to openapi doc
1 parent 0b86c23 commit 006d332

File tree

1 file changed

+16
-17
lines changed

1 file changed

+16
-17
lines changed

docs/openapi/openapi.yml

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ paths:
6666
responses:
6767
'200':
6868
description: search result
69+
'204':
70+
description: no content
6971
content:
7072
application/json:
7173
schema:
@@ -83,6 +85,8 @@ paths:
8385
responses:
8486
'200':
8587
description: search result
88+
'204':
89+
description: no content
8690
content:
8791
application/json:
8892
schema:
@@ -107,6 +111,8 @@ paths:
107111
responses:
108112
'200':
109113
description: search result
114+
'404':
115+
description: not found
110116
content:
111117
application/json:
112118
schema:
@@ -153,6 +159,8 @@ paths:
153159
responses:
154160
'200':
155161
description: search result
162+
'404':
163+
description: not found
156164
content:
157165
application/json:
158166
schema:
@@ -232,7 +240,7 @@ paths:
232240
schema:
233241
type: string
234242
responses:
235-
'200':
243+
'204':
236244
description: event received
237245

238246
/custom-automation-scenario:
@@ -264,7 +272,7 @@ paths:
264272
schema:
265273
type: integer
266274
responses:
267-
'200':
275+
'204':
268276
description: custom scenario received
269277

270278
/stop-custom-automation-scenario:
@@ -284,7 +292,7 @@ paths:
284292
schema:
285293
type: string
286294
responses:
287-
'200':
295+
'204':
288296
description: stop custom scenario received
289297

290298
/adapt-environment:
@@ -310,7 +318,7 @@ paths:
310318
schema:
311319
type: string
312320
responses:
313-
'200':
321+
'204':
314322
description: adapt environment received
315323

316324
/zone-hp-tracking-info:
@@ -338,6 +346,8 @@ paths:
338346
responses:
339347
'200':
340348
description: search result
349+
'204':
350+
description: no content
341351
content:
342352
application/json:
343353
schema:
@@ -355,24 +365,13 @@ paths:
355365
responses:
356366
'200':
357367
description: search result
368+
'204':
369+
description: no content
358370
content:
359371
application/json:
360372
schema:
361373
$ref: '#/components/schemas/TrackingData'
362374

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-
376375
components:
377376
schemas:
378377

0 commit comments

Comments
 (0)