refactor(socket.io): deprecate SocketModules.sortPublicRooms in favour of api.chats.sortPublicRooms

This commit is contained in:
Julian Lam
2023-11-15 11:41:02 -05:00
parent 2de534fad8
commit 62b7dfd400
8 changed files with 65 additions and 9 deletions

View File

@@ -0,0 +1,33 @@
put:
tags:
- chats
summary: sort public chat rooms
description: This operation sorts the publicly available chat rooms. This is a privileged function; only superadmins can call it.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
roomIds:
type: array
description: A list of room ids.
example: [1]
scores:
type: array
description: A list of sort orders associated with the passed-in `roomIds`
example: [0]
responses:
'200':
description: Public chat rooms successfully re-ordered.
content:
application/json:
schema:
type: object
properties:
status:
$ref: ../../components/schemas/Status.yaml#/Status
response:
type: object
properties: {}