openvidu/backend/openapi/components/responses/success-get-room.yaml

49 lines
2.0 KiB
YAML

description: Success response for retrieving a room
content:
application/json:
schema:
$ref: '../schemas/meet-room.yaml'
examples:
complete_room_details:
summary: Full room details response
value:
roomId: 'room-123'
roomIdPrefix: 'room'
creationDate: 1620000000000
autoDeletionDate: 1620000800000
preferences:
chatPreferences:
enabled: true
recordingPreferences:
enabled: false
virtualBackgroundPreferences:
enabled: true
moderatorURL: 'http://localhost:6080/room/room-123/?secret=123456'
publisherURL: 'http://localhost:6080/room/room-123/?secret=654321'
fields=roomId:
summary: Response with only the roomId
value:
roomId: 'room-123'
fields=roomId,roomIdPrefix,creationDate,autoDeletionDate,preferences:
summary: Room details with roomId, roomIdPrefix, creationDate, autoDeletionDate, and preferences
value:
roomId: 'room-123'
roomIdPrefix: 'room'
creationDate: 1620000000000
autoDeletionDate: 1620000800000
preferences:
chatPreferences:
enabled: true
recordingPreferences:
enabled: false
virtualBackgroundPreferences:
enabled: true
fields=moderatorURL,publisherURL:
summary: Response containing only moderator and publisher URLs
value:
moderatorURL: 'http://localhost:6080/room/room-123/?secret=123456'
publisherURL: 'http://localhost:6080/room/room-123/?secret=654321'