mirror of
https://github.com/NodeBB/NodeBB.git
synced 2026-05-07 15:35:45 +02:00
docs: openapi schema updates for chat marking
This commit is contained in:
@@ -150,6 +150,8 @@ paths:
|
||||
$ref: 'write/chats.yaml'
|
||||
/chats/{roomId}:
|
||||
$ref: 'write/chats/roomId.yaml'
|
||||
/chats/{roomId}/state:
|
||||
$ref: 'write/chats/roomId/state.yaml'
|
||||
/chats/{roomId}/users:
|
||||
$ref: 'write/chats/roomId/users.yaml'
|
||||
/chats/{roomId}/users/{uid}:
|
||||
|
||||
50
public/openapi/write/chats/roomId/state.yaml
Normal file
50
public/openapi/write/chats/roomId/state.yaml
Normal file
@@ -0,0 +1,50 @@
|
||||
put:
|
||||
tags:
|
||||
- chats
|
||||
summary: mark chat room as unread
|
||||
description: This operation marks a chat room as unread.
|
||||
parameters:
|
||||
- in: path
|
||||
name: roomId
|
||||
schema:
|
||||
type: number
|
||||
required: true
|
||||
description: a valid room id
|
||||
example: 1
|
||||
responses:
|
||||
'200':
|
||||
description: Chat room marked
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
$ref: ../../../components/schemas/Status.yaml#/Status
|
||||
response:
|
||||
$ref: ../../../components/schemas/Chats.yaml#/RoomObjectFull
|
||||
delete:
|
||||
tags:
|
||||
- chats
|
||||
summary: mark chat room as read
|
||||
description: This operation marks a chat room as read.
|
||||
parameters:
|
||||
- in: path
|
||||
name: roomId
|
||||
schema:
|
||||
type: number
|
||||
required: true
|
||||
description: a valid room id
|
||||
example: 1
|
||||
responses:
|
||||
'200':
|
||||
description: Chat room marked
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
status:
|
||||
$ref: ../../../components/schemas/Status.yaml#/Status
|
||||
response:
|
||||
$ref: ../../../components/schemas/Chats.yaml#/RoomObjectFull
|
||||
Reference in New Issue
Block a user