From 92b99764b984518f00fba2914da31e3358d3134a Mon Sep 17 00:00:00 2001 From: juancarmore Date: Wed, 7 Jan 2026 12:30:09 +0100 Subject: [PATCH] openapi: update users and room members get enpoints to include sorting options --- meet-ce/backend/openapi/paths/internal/users.yaml | 6 +++++- meet-ce/backend/openapi/paths/room-members.yaml | 8 ++++++-- meet-ce/backend/openapi/paths/rooms.yaml | 2 +- 3 files changed, 12 insertions(+), 4 deletions(-) diff --git a/meet-ce/backend/openapi/paths/internal/users.yaml b/meet-ce/backend/openapi/paths/internal/users.yaml index 8c144775..fcc49db9 100644 --- a/meet-ce/backend/openapi/paths/internal/users.yaml +++ b/meet-ce/backend/openapi/paths/internal/users.yaml @@ -29,8 +29,10 @@ get: operationId: getUsers summary: Get all users - description: > + description: | Retrieves a paginated list of all users in the system. + + By default, the users are sorted by registration date in descending order (newest first). tags: - Internal API - Users security: @@ -41,6 +43,8 @@ - $ref: '../../components/parameters/internal/user-role.yaml' - $ref: '../../components/parameters/max-items.yaml' - $ref: '../../components/parameters/next-page-token.yaml' + - $ref: '../../components/parameters/sort-field.yaml' + - $ref: '../../components/parameters/sort-order.yaml' responses: '200': $ref: '../../components/responses/internal/success-get-users.yaml' diff --git a/meet-ce/backend/openapi/paths/room-members.yaml b/meet-ce/backend/openapi/paths/room-members.yaml index 9f4c7053..e2cfed3e 100644 --- a/meet-ce/backend/openapi/paths/room-members.yaml +++ b/meet-ce/backend/openapi/paths/room-members.yaml @@ -33,9 +33,11 @@ get: operationId: getRoomMembers summary: Get all members of a room - description: > + description: | Retrieves a paginated list of all members in the specified room. - Each member has custom access URLs and permissions that can differ from the default moderator and speaker roles. + Each member has their own access URL and custom permissions that can differ from the default moderator and speaker roles. + + By default, the room members are sorted by membership date in descending order (newest first). tags: - OpenVidu Meet - Room Members security: @@ -46,6 +48,8 @@ - $ref: '../components/parameters/room-member-fields.yaml' - $ref: '../components/parameters/max-items.yaml' - $ref: '../components/parameters/next-page-token.yaml' + - $ref: '../components/parameters/sort-field.yaml' + - $ref: '../components/parameters/sort-order.yaml' responses: '200': $ref: '../components/responses/success-get-room-members.yaml' diff --git a/meet-ce/backend/openapi/paths/rooms.yaml b/meet-ce/backend/openapi/paths/rooms.yaml index 628c24b3..84db6dd2 100644 --- a/meet-ce/backend/openapi/paths/rooms.yaml +++ b/meet-ce/backend/openapi/paths/rooms.yaml @@ -26,7 +26,7 @@ get: operationId: getRooms summary: Get all rooms - description: > + description: | Retrieves a paginated list of all rooms available in the system. You can apply filters to narrow down the results based on specific criteria.