openapi: update users and room members get enpoints to include sorting options
This commit is contained in:
parent
577c48fe1b
commit
92b99764b9
@ -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'
|
||||
|
||||
@ -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'
|
||||
|
||||
@ -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.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user