openapi: adjust updateParticipantRole endpoint to use put method and /role in path

This commit is contained in:
juancarmore 2025-08-27 20:45:10 +02:00
parent e572f9feb5
commit 4f0927dfbc
4 changed files with 32 additions and 31 deletions

View File

@ -1,4 +1,4 @@
description: Successfully updated participant description: Successfully updated participant role
content: content:
application/json: application/json:
schema: schema:

View File

@ -46,6 +46,8 @@ paths:
$ref: './paths/internal/meetings.yaml#/~1meetings~1{roomId}' $ref: './paths/internal/meetings.yaml#/~1meetings~1{roomId}'
/meetings/{roomId}/participants/{participantIdentity}: /meetings/{roomId}/participants/{participantIdentity}:
$ref: './paths/internal/meetings.yaml#/~1meetings~1{roomId}~1participants~1{participantIdentity}' $ref: './paths/internal/meetings.yaml#/~1meetings~1{roomId}~1participants~1{participantIdentity}'
/meetings/{roomId}/participants/{participantIdentity}/role:
$ref: './paths/internal/meetings.yaml#/~1meetings~1{roomId}~1participants~1{participantIdentity}~1role'
components: components:
securitySchemes: securitySchemes:

View File

@ -27,35 +27,6 @@
'500': '500':
$ref: '../../components/responses/internal-server-error.yaml' $ref: '../../components/responses/internal-server-error.yaml'
/meetings/{roomId}/participants/{participantIdentity}: /meetings/{roomId}/participants/{participantIdentity}:
patch:
operationId: updateParticipant
summary: Update participant in a meeting
description: >
Updates the properties of a participant in the current meeting in an OpenVidu Meet room.
This can be used to change the participant role.
tags:
- Internal API - Meetings
security:
- participantTokenCookie: []
parameters:
- $ref: '../../components/parameters/room-id-path.yaml'
- $ref: '../../components/parameters/internal/participant-identity.yaml'
- $ref: '../../components/parameters/internal/x-participant-role.yaml'
requestBody:
$ref: '../../components/requestBodies/internal/update-participant-request.yaml'
responses:
'200':
$ref: '../../components/responses/internal/success-update-participant.yaml'
'400':
$ref: '../../components/responses/internal/error-invalid-participant-role.yaml'
'401':
$ref: '../../components/responses/unauthorized-error.yaml'
'403':
$ref: '../../components/responses/forbidden-error.yaml'
'404':
$ref: '../../components/responses/internal/error-room-participant-not-found.yaml'
'500':
$ref: '../../components/responses/internal-server-error.yaml'
delete: delete:
operationId: kickParticipant operationId: kickParticipant
summary: Kick a participant from a meeting summary: Kick a participant from a meeting
@ -82,4 +53,32 @@
$ref: '../../components/responses/internal/error-room-participant-not-found.yaml' $ref: '../../components/responses/internal/error-room-participant-not-found.yaml'
'500': '500':
$ref: '../../components/responses/internal-server-error.yaml' $ref: '../../components/responses/internal-server-error.yaml'
/meetings/{roomId}/participants/{participantIdentity}/role:
put:
operationId: updateParticipantRole
summary: Update participant role in a meeting
description: >
Updates the role of a participant in the current meeting in an OpenVidu Meet room.
tags:
- Internal API - Meetings
security:
- participantTokenCookie: []
parameters:
- $ref: '../../components/parameters/room-id-path.yaml'
- $ref: '../../components/parameters/internal/participant-identity.yaml'
- $ref: '../../components/parameters/internal/x-participant-role.yaml'
requestBody:
$ref: '../../components/requestBodies/internal/update-participant-role-request.yaml'
responses:
'200':
$ref: '../../components/responses/internal/success-update-participant-role.yaml'
'400':
$ref: '../../components/responses/internal/error-invalid-participant-role.yaml'
'401':
$ref: '../../components/responses/unauthorized-error.yaml'
'403':
$ref: '../../components/responses/forbidden-error.yaml'
'404':
$ref: '../../components/responses/internal/error-room-participant-not-found.yaml'
'500':
$ref: '../../components/responses/internal-server-error.yaml'