backend: Update OpenAPI spec to include 422 response and recording status parameter
This commit is contained in:
parent
b5b39ac560
commit
fee592cadf
@ -416,6 +416,36 @@ paths:
|
|||||||
example:
|
example:
|
||||||
code: 404
|
code: 404
|
||||||
message: 'Room not found'
|
message: 'Room not found'
|
||||||
|
'422':
|
||||||
|
description: Unprocessable Entity — The request body is invalid
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
error:
|
||||||
|
type: string
|
||||||
|
example: 'Unprocessable Entity'
|
||||||
|
message:
|
||||||
|
type: string
|
||||||
|
example: 'Invalid request body'
|
||||||
|
details:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
field:
|
||||||
|
type: string
|
||||||
|
example: 'roomName'
|
||||||
|
message:
|
||||||
|
type: string
|
||||||
|
example: 'Room not found'
|
||||||
|
example:
|
||||||
|
error: 'Unprocessable Entity'
|
||||||
|
message: 'Invalid request body'
|
||||||
|
details:
|
||||||
|
- field: 'roomName'
|
||||||
|
message: 'Room not found'
|
||||||
'500':
|
'500':
|
||||||
description: Internal server error
|
description: Internal server error
|
||||||
content:
|
content:
|
||||||
@ -429,11 +459,19 @@ paths:
|
|||||||
operationId: getRecordings
|
operationId: getRecordings
|
||||||
summary: Get a list of OpenVidu Meet recordings
|
summary: Get a list of OpenVidu Meet recordings
|
||||||
description: >
|
description: >
|
||||||
Retrieves a list of OpenVidu Meet recordings that are currently available.
|
Retrieves a list of OpenVidu Meet recordings.
|
||||||
tags:
|
tags:
|
||||||
- OpenVidu Meet - Recordings
|
- OpenVidu Meet - Recordings
|
||||||
security:
|
security:
|
||||||
- apiKeyInHeader: []
|
- apiKeyInHeader: []
|
||||||
|
parameters:
|
||||||
|
- name: status
|
||||||
|
in: query
|
||||||
|
required: false
|
||||||
|
description: |
|
||||||
|
The status of the recordings to retrieve. Possible values are "STARTING", "STARTED", "STOPPING", "STOPPED", "FAILED" and "READY".
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
responses:
|
responses:
|
||||||
'200':
|
'200':
|
||||||
description: Successfully retrieved the list of OpenVidu Meet recordings
|
description: Successfully retrieved the list of OpenVidu Meet recordings
|
||||||
@ -1026,7 +1064,7 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
example: 'READY'
|
example: 'READY'
|
||||||
description: >
|
description: >
|
||||||
The status of the recording. Possible values are "STARTING", "STARTED", "STOPPING", "STOPPED", "FAILED" and "RECORDING".
|
The status of the recording. Possible values are "STARTING", "STARTED", "STOPPING", "STOPPED", "FAILED" and "READY".
|
||||||
filename:
|
filename:
|
||||||
type: string
|
type: string
|
||||||
example: 'recording_123456.mp4'
|
example: 'recording_123456.mp4'
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user