neoris/openvidu
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

backend: Update response examples in success-get-room and success-get-rooms YAML files for clarity and consistency

Browse Source
This commit is contained in:
Carlos Santos 2025-04-15 12:07:47 +02:00
parent a65018072a
commit bc01ef1caf
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
backend/openapi/components/responses/success-get-room.yaml
View File

@ -21,13 +21,13 @@ content:
moderatorURL: 'http://localhost:6080/room/room-123/?secret=123456' moderatorURL: 'http://localhost:6080/room/room-123/?secret=123456'
publisherURL: 'http://localhost:6080/room/room-123/?secret=654321' publisherURL: 'http://localhost:6080/room/room-123/?secret=654321'
roomId_fields_only: fields=roomId:
summary: Response with only the roomId summary: Response with only the roomId
value: value:
roomId: 'room-123' roomId: 'room-123'
no_urls: fields=roomId,roomIdPrefix,creationDate,autoDeletionDate,preferences:
summary: Room details including preferences but no URLs summary: Room details with roomId, roomIdPrefix, creationDate, autoDeletionDate, and preferences
value: value:
roomId: 'room-123' roomId: 'room-123'
roomIdPrefix: 'room' roomIdPrefix: 'room'
@ -41,7 +41,7 @@ content:
virtualBackgroundPreferences: virtualBackgroundPreferences:
enabled: true enabled: true
urls_only: fields=moderatorURL,publisherURL:
summary: Response containing only moderator and publisher URLs summary: Response containing only moderator and publisher URLs
value: value:
moderatorURL: 'http://localhost:6080/room/room-123/?secret=123456' moderatorURL: 'http://localhost:6080/room/room-123/?secret=123456'

6
backend/openapi/components/responses/success-get-rooms.yaml
View File

@ -57,7 +57,7 @@ content:
pagination: pagination:
isTruncated: false isTruncated: false
maxItems: 10 maxItems: 10
roomId_fields_only: fields=roomId:
summary: Response with only roomId for each room summary: Response with only roomId for each room
value: value:
rooms: rooms:
@ -67,7 +67,7 @@ content:
isTruncated: false isTruncated: false
maxItems: 10 maxItems: 10
no_urls: fields=roomId,roomIdPrefix,creationDate,autoDeletionDate,preferences:
summary: Room details including preferences but no URLs summary: Room details including preferences but no URLs
value: value:
rooms: rooms:
@ -98,7 +98,7 @@ content:
nextPageToken: 'abc123' nextPageToken: 'abc123'
maxItems: 10 maxItems: 10
urls_only: fields=moderatorURL,publisherURL:
summary: Response containing only moderator and publisher URLs summary: Response containing only moderator and publisher URLs
value: value:
rooms: rooms: