diff --git a/backend/openapi/components/parameters/room-id.yaml b/backend/openapi/components/parameters/room-id-path.yaml similarity index 100% rename from backend/openapi/components/parameters/room-id.yaml rename to backend/openapi/components/parameters/room-id-path.yaml diff --git a/backend/openapi/components/parameters/room-id-query.yaml b/backend/openapi/components/parameters/room-id-query.yaml new file mode 100644 index 0000000..f110244 --- /dev/null +++ b/backend/openapi/components/parameters/room-id-query.yaml @@ -0,0 +1,7 @@ +name: roomId +in: query +required: false +description: The unique identifier of the room. Specify the room ID to filter recordings by their associated room. +schema: + type: string + example: 'room-123' diff --git a/backend/openapi/paths/internal/meetings.yaml b/backend/openapi/paths/internal/meetings.yaml index 360fc69..f07b37b 100644 --- a/backend/openapi/paths/internal/meetings.yaml +++ b/backend/openapi/paths/internal/meetings.yaml @@ -11,7 +11,7 @@ security: - participantTokenCookie: [] parameters: - - $ref: '../../components/parameters/room-id.yaml' + - $ref: '../../components/parameters/room-id-path.yaml' responses: '200': $ref: '../../components/responses/internal/success-end-meeting.yaml' @@ -34,7 +34,7 @@ security: - participantTokenCookie: [] parameters: - - $ref: '../../components/parameters/room-id.yaml' + - $ref: '../../components/parameters/room-id-path.yaml' - $ref: '../../components/parameters/internal/participant-name.yaml' responses: '200': diff --git a/backend/openapi/paths/internal/rooms.yaml b/backend/openapi/paths/internal/rooms.yaml index 7b6c341..674965a 100644 --- a/backend/openapi/paths/internal/rooms.yaml +++ b/backend/openapi/paths/internal/rooms.yaml @@ -9,7 +9,7 @@ security: - accessTokenCookie: [] parameters: - - $ref: '../../components/parameters/room-id.yaml' + - $ref: '../../components/parameters/room-id-path.yaml' requestBody: $ref: '../../components/requestBodies/internal/update-room-request.yaml' responses: @@ -34,7 +34,7 @@ tags: - Internal API - Rooms parameters: - - $ref: '../../components/parameters/room-id.yaml' + - $ref: '../../components/parameters/room-id-path.yaml' responses: '200': $ref: '../../components/responses/internal/success-get-room-roles.yaml' @@ -53,7 +53,7 @@ tags: - Internal API - Rooms parameters: - - $ref: '../../components/parameters/room-id.yaml' + - $ref: '../../components/parameters/room-id-path.yaml' - $ref: '../../components/parameters/internal/secret.yaml' responses: '200': diff --git a/backend/openapi/paths/recordings.yaml b/backend/openapi/paths/recordings.yaml index 2d1f2ac..c50ffab 100644 --- a/backend/openapi/paths/recordings.yaml +++ b/backend/openapi/paths/recordings.yaml @@ -33,7 +33,7 @@ # schema: # type: string - $ref: '../components/parameters/recording-fields.yaml' - - $ref: '../components/parameters/room-id.yaml' + - $ref: '../components/parameters/room-id-query.yaml' - $ref: '../components/parameters/max-items.yaml' - $ref: '../components/parameters/next-page-token.yaml' responses: diff --git a/backend/openapi/paths/rooms.yaml b/backend/openapi/paths/rooms.yaml index c7db7f0..fd7cc1b 100644 --- a/backend/openapi/paths/rooms.yaml +++ b/backend/openapi/paths/rooms.yaml @@ -103,7 +103,7 @@ - accessTokenCookie: [] - participantTokenCookie: [] parameters: - - $ref: '../components/parameters/room-id.yaml' + - $ref: '../components/parameters/room-id-path.yaml' - $ref: '../components/parameters/room-fields.yaml' responses: '200': @@ -133,7 +133,7 @@ - apiKeyInHeader: [] - accessTokenCookie: [] parameters: - - $ref: '../components/parameters/room-id.yaml' + - $ref: '../components/parameters/room-id-path.yaml' responses: '202': description: >