76 lines
3.1 KiB
YAML
76 lines
3.1 KiB
YAML
/participants/token:
|
|
post:
|
|
operationId: generateParticipantToken
|
|
summary: Generate a token for a participant
|
|
description: >
|
|
Generates a token for a participant to join an OpenVidu Meet room.
|
|
tags:
|
|
- Internal API - Participant
|
|
security:
|
|
- accessTokenCookie: []
|
|
requestBody:
|
|
$ref: '../../components/requestBodies/internal/participant-token-request.yaml'
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-generate-participant-token.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'404':
|
|
$ref: '../../components/responses/error-room-not-found.yaml'
|
|
'409':
|
|
$ref: '../../components/responses/internal/error-participant-already-exists.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|
|
|
|
/participants/token/refresh:
|
|
post:
|
|
operationId: refreshParticipantToken
|
|
summary: Refresh a token for a participant
|
|
description: >
|
|
Refresh a token for a participant in an OpenVidu Meet room.
|
|
tags:
|
|
- Internal API - Participant
|
|
security:
|
|
- accessTokenCookie: []
|
|
requestBody:
|
|
$ref: '../../components/requestBodies/internal/participant-token-request.yaml'
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-generate-participant-token.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'404':
|
|
$ref: '../../components/responses/error-room-not-found.yaml'
|
|
'409':
|
|
$ref: '../../components/responses/internal/error-participant-token-still-valid.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|
|
/participants/{participantName}:
|
|
delete:
|
|
operationId: disconnectParticipant
|
|
summary: Delete a participant from a room
|
|
description: >
|
|
Deletes a participant from an OpenVidu Meet room.
|
|
tags:
|
|
- Internal API - Participant
|
|
security:
|
|
- participantTokenCookie: []
|
|
parameters:
|
|
- $ref: '../../components/parameters/room-id.yaml'
|
|
- $ref: '../../components/parameters/internal/participant-name.yaml'
|
|
responses:
|
|
'200':
|
|
$ref: '../../components/responses/internal/success-delete-participant.yaml'
|
|
'401':
|
|
$ref: '../../components/responses/unauthorized-error.yaml'
|
|
'403':
|
|
$ref: '../../components/responses/forbidden-error.yaml'
|
|
'404':
|
|
$ref: '../../components/responses/internal/error-participant-not-found.yaml'
|
|
'500':
|
|
$ref: '../../components/responses/internal-server-error.yaml'
|