diff --git a/meet-ce/backend/openapi/components/parameters/internal/secret.yaml b/meet-ce/backend/openapi/components/parameters/internal/secret.yaml deleted file mode 100644 index c5633f28..00000000 --- a/meet-ce/backend/openapi/components/parameters/internal/secret.yaml +++ /dev/null @@ -1,6 +0,0 @@ -name: secret -in: path -required: true -description: The secret value from the room URL used to access the room. -schema: - type: string diff --git a/meet-ce/backend/openapi/components/responses/internal/success-get-room-member-role.yaml b/meet-ce/backend/openapi/components/responses/internal/success-get-room-member-role.yaml deleted file mode 100644 index 19e125b9..00000000 --- a/meet-ce/backend/openapi/components/responses/internal/success-get-room-member-role.yaml +++ /dev/null @@ -1,5 +0,0 @@ -description: Successfully retrieved the room role and associated permissions -content: - application/json: - schema: - $ref: '../../schemas/internal/room-member-role-permissions.yaml' diff --git a/meet-ce/backend/openapi/components/responses/internal/success-get-room-member-roles.yaml b/meet-ce/backend/openapi/components/responses/internal/success-get-room-member-roles.yaml deleted file mode 100644 index eef4ea5e..00000000 --- a/meet-ce/backend/openapi/components/responses/internal/success-get-room-member-roles.yaml +++ /dev/null @@ -1,38 +0,0 @@ -description: Successfully retrieved all roles and associated permissions in a room -content: - application/json: - schema: - type: array - items: - $ref: '../../schemas/internal/room-member-role-permissions.yaml' - example: - - role: 'moderator' - permissions: - livekit: - roomJoin: true - room: 'room-123' - canPublish: true - canSubscribe: true - canPublishData: true - canUpdateOwnMetadata: true - openvidu: - canRecord: true - canRetrieveRecordings: true - canDeleteRecordings: true - canChat: true - canChangeVirtualBackground: true - - role: 'speaker' - permissions: - livekit: - roomJoin: true - room: 'room-123' - canPublish: true - canSubscribe: true - canPublishData: true - canUpdateOwnMetadata: true - openvidu: - canRecord: false - canRetrieveRecordings: true - canDeleteRecordings: false - canChat: true - canChangeVirtualBackground: true diff --git a/meet-ce/backend/openapi/components/schemas/internal/room-member-role-permissions.yaml b/meet-ce/backend/openapi/components/schemas/internal/room-member-role-permissions.yaml deleted file mode 100644 index 68032014..00000000 --- a/meet-ce/backend/openapi/components/schemas/internal/room-member-role-permissions.yaml +++ /dev/null @@ -1,74 +0,0 @@ -type: object -properties: - role: - type: string - enum: ['moderator', 'speaker'] - description: | - A role that a user can have as a member of a room. - The role determines the permissions of the user in the room. - - `moderator`: Can manage the room resources and meeting participants. - - `speaker`: Can publish media streams to the meeting. - example: 'moderator' - permissions: - type: object - properties: - livekit: - type: object - properties: - roomJoin: - type: boolean - description: > - Indicates whether the participant can join a room. - example: true - room: - type: string - description: > - Unique identifier of the room to which the participant is assigned. - canPublish: - type: boolean - description: > - Indicates whether the participant can publish media streams to the room. - example: true - canSubscribe: - type: boolean - description: > - Indicates whether the participant can subscribe to media streams in the room. - example: true - canPublishData: - type: boolean - description: > - Indicates whether the participant can publish data messages to the room. - example: true - canUpdateOwnMetadata: - type: boolean - description: > - Indicates whether the participant can update their own metadata. - example: true - openvidu: - type: object - properties: - canRecord: - type: boolean - description: > - Indicates whether the user can record a meeting in the room. - example: true - canRetrieveRecordings: - type: boolean - description: > - Indicates whether the user can retrieve and play recordings of meetings in the room. - example: true - canDeleteRecordings: - type: boolean - description: > - Indicates whether the user can delete recordings of meetings in the room. - example: true - canChat: - type: boolean - description: > - Indicates whether the user can send and receive chat messages in the room. - example: true - canChangeVirtualBackground: - type: boolean - description: > - Indicates whether the user can change their own virtual background. - example: true diff --git a/meet-ce/backend/openapi/openvidu-meet-internal-api.yaml b/meet-ce/backend/openapi/openvidu-meet-internal-api.yaml index bc70a08d..38201443 100644 --- a/meet-ce/backend/openapi/openvidu-meet-internal-api.yaml +++ b/meet-ce/backend/openapi/openvidu-meet-internal-api.yaml @@ -30,10 +30,6 @@ paths: $ref: './paths/internal/meet-global-config.yaml#/~1config~1rooms~1appearance' /rooms/{roomId}/token: $ref: './paths/internal/rooms.yaml#/~1rooms~1{roomId}~1token' - /rooms/{roomId}/roles: - $ref: './paths/internal/rooms.yaml#/~1rooms~1{roomId}~1roles' - /rooms/{roomId}/roles/{secret}: - $ref: './paths/internal/rooms.yaml#/~1rooms~1{roomId}~1roles~1{secret}' /recordings: $ref: './paths/internal/recordings.yaml#/~1recordings' /recordings/{recordingId}/stop: @@ -59,17 +55,13 @@ components: $ref: components/schemas/internal/webhooks-config.yaml SecurityConfig: $ref: components/schemas/internal/global-security-config.yaml + RoomsAppearanceConfig: + $ref: components/schemas/internal/rooms-appearance-config.yaml MeetRoom: $ref: components/schemas/meet-room.yaml - MeetRoomOptions: - $ref: components/schemas/meet-room-options.yaml - MeetRoomConfig: - $ref: components/schemas/meet-room-config.yaml#/MeetRoomConfig - MeetRoomMemberRoleAndPermissions: - $ref: components/schemas/internal/room-member-role-permissions.yaml - MeetAnalytics: - $ref: components/schemas/internal/meet-analytics.yaml MeetRecording: $ref: components/schemas/meet-recording.yaml + MeetAnalytics: + $ref: components/schemas/internal/meet-analytics.yaml Error: $ref: components/schemas/error.yaml diff --git a/meet-ce/backend/openapi/paths/internal/rooms.yaml b/meet-ce/backend/openapi/paths/internal/rooms.yaml index 2959e1d3..8a353ae7 100644 --- a/meet-ce/backend/openapi/paths/internal/rooms.yaml +++ b/meet-ce/backend/openapi/paths/internal/rooms.yaml @@ -29,47 +29,3 @@ $ref: '../../components/responses/validation-error.yaml' '500': $ref: '../../components/responses/internal-server-error.yaml' -/rooms/{roomId}/roles: - get: - operationId: getRoomMemberRolesAndPermissions - summary: Get room member roles and permissions - description: > - Retrieves the roles and associated permissions that a user can have as a member of a specified OpenVidu Meet room. - tags: - - Internal API - Rooms - parameters: - - $ref: '../../components/parameters/room-id-path.yaml' - responses: - '200': - $ref: '../../components/responses/internal/success-get-room-member-roles.yaml' - '404': - $ref: '../../components/responses/error-room-not-found.yaml' - '422': - $ref: '../../components/responses/validation-error.yaml' - '500': - $ref: '../../components/responses/internal-server-error.yaml' -/rooms/{roomId}/roles/{secret}: - get: - operationId: getRoomRoleAndPermissions - summary: Get room role and permissions - description: | - Retrieves the role and associated permissions that a user will have as a member of a specified OpenVidu Meet room - when using the URL that contains the given secret value. - - This endpoint is useful for checking the user's role and permissions before accessing the room. - tags: - - Internal API - Rooms - parameters: - - $ref: '../../components/parameters/room-id-path.yaml' - - $ref: '../../components/parameters/internal/secret.yaml' - responses: - '200': - $ref: '../../components/responses/internal/success-get-room-member-role.yaml' - '400': - $ref: '../../components/responses/internal/error-invalid-room-secret.yaml' - '404': - $ref: '../../components/responses/error-room-not-found.yaml' - '422': - $ref: '../../components/responses/validation-error.yaml' - '500': - $ref: '../../components/responses/internal-server-error.yaml'