backend: Update openapi spec roomId parameter references to use path and query definitions

This commit is contained in:
Carlos Santos 2025-04-25 12:44:19 +02:00
parent 338eb5a90e
commit 02e16f85ee
6 changed files with 15 additions and 8 deletions

View File

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

View File

@ -11,7 +11,7 @@
security: security:
- participantTokenCookie: [] - participantTokenCookie: []
parameters: parameters:
- $ref: '../../components/parameters/room-id.yaml' - $ref: '../../components/parameters/room-id-path.yaml'
responses: responses:
'200': '200':
$ref: '../../components/responses/internal/success-end-meeting.yaml' $ref: '../../components/responses/internal/success-end-meeting.yaml'
@ -34,7 +34,7 @@
security: security:
- participantTokenCookie: [] - participantTokenCookie: []
parameters: parameters:
- $ref: '../../components/parameters/room-id.yaml' - $ref: '../../components/parameters/room-id-path.yaml'
- $ref: '../../components/parameters/internal/participant-name.yaml' - $ref: '../../components/parameters/internal/participant-name.yaml'
responses: responses:
'200': '200':

View File

@ -9,7 +9,7 @@
security: security:
- accessTokenCookie: [] - accessTokenCookie: []
parameters: parameters:
- $ref: '../../components/parameters/room-id.yaml' - $ref: '../../components/parameters/room-id-path.yaml'
requestBody: requestBody:
$ref: '../../components/requestBodies/internal/update-room-request.yaml' $ref: '../../components/requestBodies/internal/update-room-request.yaml'
responses: responses:
@ -34,7 +34,7 @@
tags: tags:
- Internal API - Rooms - Internal API - Rooms
parameters: parameters:
- $ref: '../../components/parameters/room-id.yaml' - $ref: '../../components/parameters/room-id-path.yaml'
responses: responses:
'200': '200':
$ref: '../../components/responses/internal/success-get-room-roles.yaml' $ref: '../../components/responses/internal/success-get-room-roles.yaml'
@ -53,7 +53,7 @@
tags: tags:
- Internal API - Rooms - Internal API - Rooms
parameters: parameters:
- $ref: '../../components/parameters/room-id.yaml' - $ref: '../../components/parameters/room-id-path.yaml'
- $ref: '../../components/parameters/internal/secret.yaml' - $ref: '../../components/parameters/internal/secret.yaml'
responses: responses:
'200': '200':

View File

@ -33,7 +33,7 @@
# schema: # schema:
# type: string # type: string
- $ref: '../components/parameters/recording-fields.yaml' - $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/max-items.yaml'
- $ref: '../components/parameters/next-page-token.yaml' - $ref: '../components/parameters/next-page-token.yaml'
responses: responses:

View File

@ -103,7 +103,7 @@
- accessTokenCookie: [] - accessTokenCookie: []
- participantTokenCookie: [] - participantTokenCookie: []
parameters: parameters:
- $ref: '../components/parameters/room-id.yaml' - $ref: '../components/parameters/room-id-path.yaml'
- $ref: '../components/parameters/room-fields.yaml' - $ref: '../components/parameters/room-fields.yaml'
responses: responses:
'200': '200':
@ -133,7 +133,7 @@
- apiKeyInHeader: [] - apiKeyInHeader: []
- accessTokenCookie: [] - accessTokenCookie: []
parameters: parameters:
- $ref: '../components/parameters/room-id.yaml' - $ref: '../components/parameters/room-id-path.yaml'
responses: responses:
'202': '202':
description: > description: >