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

backend: Update createRoom to return 201 status on successful room creation

Browse Source
This commit is contained in:
Carlos Santos 2025-04-15 12:01:34 +02:00
parent 5c67f2a370
commit a65018072a
4 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
backend/openapi/components/responses/success-create-room.yaml
View File

@ -1,5 +1,12 @@
description: Success response for creating a room description: Room created successfully
content: content:
application/json: application/json:
schema: schema:
$ref: '../schemas/meet-room.yaml' $ref: '../schemas/meet-room.yaml'
headers:
Location:
description: URL of the newly created room
schema:
type: string
format: uri
example: https://your-api.com/meet/api/v1/rooms/room-id-123

2
backend/openapi/paths/rooms.yaml
View File

@ -13,7 +13,7 @@
requestBody: requestBody:
$ref: '../components/requestBodies/create-room-request.yaml' $ref: '../components/requestBodies/create-room-request.yaml'
responses: responses:
'200': '201':
$ref: '../components/responses/success-create-room.yaml' $ref: '../components/responses/success-create-room.yaml'
'401': '401':
$ref: '../components/responses/unauthorized-error.yaml' $ref: '../components/responses/unauthorized-error.yaml'

4
backend/src/controllers/room.controller.ts
View File

@ -4,6 +4,7 @@ import { LoggerService } from '../services/logger.service.js';
import { OpenViduMeetError } from '../models/error.model.js'; import { OpenViduMeetError } from '../models/error.model.js';
import { RoomService, ParticipantService } from '../services/index.js'; import { RoomService, ParticipantService } from '../services/index.js';
import { MeetRoomFilters, MeetRoomOptions, MeetRoomRoleAndPermissions, ParticipantRole } from '@typings-ce'; import { MeetRoomFilters, MeetRoomOptions, MeetRoomRoleAndPermissions, ParticipantRole } from '@typings-ce';
import INTERNAL_CONFIG from '../config/internal-config.js';
export const createRoom = async (req: Request, res: Response) => { export const createRoom = async (req: Request, res: Response) => {
const logger = container.get(LoggerService); const logger = container.get(LoggerService);
@ -15,7 +16,8 @@ export const createRoom = async (req: Request, res: Response) => {
const baseUrl = `${req.protocol}://${req.get('host')}`; const baseUrl = `${req.protocol}://${req.get('host')}`;
const room = await roomService.createMeetRoom(baseUrl, options); const room = await roomService.createMeetRoom(baseUrl, options);
return res.status(200).json(room); res.set('Location', `${baseUrl}${INTERNAL_CONFIG.API_BASE_PATH_V1}/rooms/${room.roomId}`);
return res.status(201).json(room);
} catch (error) { } catch (error) {
logger.error(`Error creating room with options '${JSON.stringify(options)}'`); logger.error(`Error creating room with options '${JSON.stringify(options)}'`);
handleError(res, error); handleError(res, error);

2
backend/tests/utils/helpers.ts
View File

@ -154,7 +154,7 @@ export const createRoom = async (options: MeetRoomOptions = {}): Promise<MeetRoo
.post(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/rooms`) .post(`${INTERNAL_CONFIG.API_BASE_PATH_V1}/rooms`)
.set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_API_KEY) .set(INTERNAL_CONFIG.API_KEY_HEADER, MEET_API_KEY)
.send(options) .send(options)
.expect(200); .expect(201);
return response.body; return response.body;
}; };