diff --git a/meet-ce/backend/openapi/components/parameters/room-status.yaml b/meet-ce/backend/openapi/components/parameters/room-status.yaml new file mode 100644 index 00000000..58487d53 --- /dev/null +++ b/meet-ce/backend/openapi/components/parameters/room-status.yaml @@ -0,0 +1,10 @@ +name: status +in: query +required: false +description: Filter rooms by their status. +schema: + type: string + enum: + - open + - active_meeting + - closed diff --git a/meet-ce/backend/openapi/components/parameters/sort-field.yaml b/meet-ce/backend/openapi/components/parameters/sort-field.yaml new file mode 100644 index 00000000..01361167 --- /dev/null +++ b/meet-ce/backend/openapi/components/parameters/sort-field.yaml @@ -0,0 +1,6 @@ +name: sortField +in: query +required: false +description: The field by which to sort the results. +schema: + type: string diff --git a/meet-ce/backend/openapi/components/parameters/sort-order.yaml b/meet-ce/backend/openapi/components/parameters/sort-order.yaml new file mode 100644 index 00000000..b3ce71a9 --- /dev/null +++ b/meet-ce/backend/openapi/components/parameters/sort-order.yaml @@ -0,0 +1,9 @@ +name: sortOrder +in: query +required: false +description: The order in which to sort the results. Use "asc" for ascending order and "desc" for descending order. +schema: + type: string + enum: + - asc + - desc diff --git a/meet-ce/backend/openapi/paths/recordings.yaml b/meet-ce/backend/openapi/paths/recordings.yaml index bd2fb88c..7d0e99b4 100644 --- a/meet-ce/backend/openapi/paths/recordings.yaml +++ b/meet-ce/backend/openapi/paths/recordings.yaml @@ -6,6 +6,8 @@ Retrieves a paginated list of all recordings available in the system. You can apply filters to narrow down the results based on specific criteria. + By default, the recordings are sorted by start date in descending order (newest first). + > **Note:** If this endpoint is called using the `roomMemberTokenHeader` authentication method, > the `roomId` filter will be ignored and only recordings associated with the room included in the token will be returned. tags: @@ -15,12 +17,14 @@ - accessTokenHeader: [] - roomMemberTokenHeader: [] parameters: - # - $ref: '../components/parameters/recording-status.yaml' - - $ref: '../components/parameters/recording-fields.yaml' - $ref: '../components/parameters/room-id-query.yaml' - $ref: '../components/parameters/room-name.yaml' + - $ref: '../components/parameters/recording-status.yaml' + - $ref: '../components/parameters/recording-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-recordings.yaml' diff --git a/meet-ce/backend/openapi/paths/rooms.yaml b/meet-ce/backend/openapi/paths/rooms.yaml index f428728b..dc14f829 100644 --- a/meet-ce/backend/openapi/paths/rooms.yaml +++ b/meet-ce/backend/openapi/paths/rooms.yaml @@ -29,6 +29,8 @@ 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. + + By default, the rooms are sorted by creation date in descending order (newest first). tags: - OpenVidu Meet - Rooms security: @@ -36,9 +38,12 @@ - accessTokenHeader: [] parameters: - $ref: '../components/parameters/room-name.yaml' + - $ref: '../components/parameters/room-status.yaml' - $ref: '../components/parameters/room-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-rooms.yaml'