mirror of
https://github.com/NodeBB/NodeBB.git
synced 2026-02-02 12:50:00 +01:00
69 lines
1.8 KiB
YAML
69 lines
1.8 KiB
YAML
put:
|
|
tags:
|
|
- chats
|
|
summary: set chat room notification setting
|
|
description: >
|
|
This operation updates the chat room notification setting for the calling user.
|
|
|
|
N.B. The calling user must be in the chat room for this call to succeed.
|
|
parameters:
|
|
- in: path
|
|
name: roomId
|
|
schema:
|
|
type: number
|
|
required: true
|
|
description: a valid room id
|
|
example: 1
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
value:
|
|
type: number
|
|
example: 11
|
|
required:
|
|
- value
|
|
responses:
|
|
'200':
|
|
description: Chat room notification setting updated.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
status:
|
|
$ref: ../../../components/schemas/Status.yaml#/Status
|
|
response: {}
|
|
delete:
|
|
tags:
|
|
- chats
|
|
summary: restore default chat room notification setting
|
|
description: >
|
|
This operation restores the default value for notifications for the calling user.
|
|
|
|
You can also call the `PUT` variant of this route, and pass in `-1` for `value`.
|
|
That would accomplish the same thing.
|
|
|
|
N.B. The calling user must be in the chat room for this call to succeed.
|
|
parameters:
|
|
- in: path
|
|
name: roomId
|
|
schema:
|
|
type: number
|
|
required: true
|
|
description: a valid room id
|
|
example: 1
|
|
responses:
|
|
'200':
|
|
description: Chat room notification setting updated.
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: object
|
|
properties:
|
|
status:
|
|
$ref: ../../../components/schemas/Status.yaml#/Status
|
|
response: {} |