mirror of
https://github.com/NodeBB/NodeBB.git
synced 2026-07-01 00:08:53 +02:00
refactor(socket.io): deprecate SocketModules.sortPublicRooms in favour of api.chats.sortPublicRooms
This commit is contained in:
33
public/openapi/write/chats/sort.yaml
Normal file
33
public/openapi/write/chats/sort.yaml
Normal 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: {}
|
||||
Reference in New Issue
Block a user