openapi: add query parameters for status, sort field, and sort order in get all endpoints

This commit is contained in:
juancarmore 2025-12-22 16:08:15 +01:00
parent f6d685a158
commit 113dbe4f88
5 changed files with 36 additions and 2 deletions

View File

@ -0,0 +1,10 @@
name: status
in: query
required: false
description: Filter rooms by their status.
schema:
type: string
enum:
- open
- active_meeting
- closed

View File

@ -0,0 +1,6 @@
name: sortField
in: query
required: false
description: The field by which to sort the results.
schema:
type: string

View File

@ -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

View File

@ -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'

View File

@ -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'