Node.js based forum software built for the modern web
docs: document missing chat room create and update fields (#14908)
palmoni577d9604a724c
diff --git a/public/openapi/write/chats.yaml b/public/openapi/write/chats.yamlindex 37204a9b5c..cae5ad2c09 100644--- a/public/openapi/write/chats.yaml+++ b/public/openapi/write/chats.yaml@@ -188,6 +188,22 @@ post:uids:type: arrayexample: [2]+ roomName:+ type: string+ description: the name of the room+ type:+ type: string+ enum: [public]+ description: pass `public` to create a public room (administrators only)+ groups:+ type: array+ items:+ type: string+ description: the groups allowed to join the room, required when `type` is `public`+ joinLeaveMessages:+ type: number+ enum: [0, 1]+ description: whether to post a system message when a user joins or leaves the roomrequired:- uidsresponses:diff --git a/public/openapi/write/chats/roomId.yaml b/public/openapi/write/chats/roomId.yamlindex 62ae9df2bd..f01c93fa32 100644--- a/public/openapi/write/chats/roomId.yaml+++ b/public/openapi/write/chats/roomId.yaml@@ -91,8 +91,8 @@ post:put:tags:- chats- summary: rename a chat room- description: This operation renames a chat room.+ summary: update a chat room+ description: This operation updates a chat room's name and, for administrators, its settings.parameters:- in: pathname: roomId@@ -112,9 +112,22 @@ put:type: stringdescription: the new name of the roomexample: 'casper the friendly room'+ groups:+ type: array+ items:+ type: string+ description: the groups allowed to join the room (public rooms and administrators only)+ notificationSetting:+ type: number+ enum: [1, 2, 3]+ description: the default notification setting for the room, `1` for none, `2` for mentions only, `3` for all messages (administrators only)+ joinLeaveMessages:+ type: number+ enum: [0, 1]+ description: whether to post a system message when a user joins or leaves the room (administrators only)responses:'200':- description: Chat room renamed+ description: Chat room updatedcontent:application/json:schema: