openapi: add recording secret parameter and fix some typos
This commit is contained in:
parent
437cd201e7
commit
09516d3042
@ -0,0 +1,6 @@
|
||||
name: secret
|
||||
in: query
|
||||
required: false
|
||||
description: The secret value used to access the recording when sharing a recording link.
|
||||
schema:
|
||||
type: string
|
||||
@ -1,10 +1,11 @@
|
||||
description: New password
|
||||
description: New password request
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
secret:
|
||||
type: newPassword
|
||||
newPassword:
|
||||
type: string
|
||||
description: The new password for the user.
|
||||
example: "newSecurePassword123"
|
||||
|
||||
@ -2,7 +2,7 @@ description: Invalid recording secret
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../../schemas/error.yaml
|
||||
$ref: ../schemas/error.yaml
|
||||
example:
|
||||
error: 'Recording Error'
|
||||
message: 'Secret "123456" is not recognized for recording "room-123--EG_XYZ--XX445"'
|
||||
@ -19,7 +19,7 @@ paths:
|
||||
$ref: './paths/recordings.yaml#/~1recordings~1{recordingId}'
|
||||
/recordings/{recordingId}/media:
|
||||
$ref: './paths/recordings.yaml#/~1recordings~1{recordingId}~1media'
|
||||
/recordings/{recordingId/url:
|
||||
/recordings/{recordingId}/url:
|
||||
$ref: './paths/recordings.yaml#/~1recordings~1{recordingId}~1url'
|
||||
components:
|
||||
securitySchemes:
|
||||
|
||||
@ -156,6 +156,7 @@
|
||||
- recordingTokenCookie: []
|
||||
parameters:
|
||||
- $ref: '../components/parameters/recording-id.yaml'
|
||||
- $ref: '../components/parameters/recording-secret.yaml'
|
||||
- $ref: '../components/parameters/recording-range.yaml'
|
||||
responses:
|
||||
'200':
|
||||
@ -189,7 +190,7 @@
|
||||
type: string
|
||||
format: binary
|
||||
'400':
|
||||
$ref: '../components/responses/invalid-recording-secret.yaml'
|
||||
$ref: '../components/responses/error-invalid-recording-secret.yaml'
|
||||
'401':
|
||||
$ref: '../components/responses/unauthorized-error.yaml'
|
||||
'403':
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user