mirror of
https://github.com/NodeBB/NodeBB.git
synced 2025-11-09 07:25:46 +01:00
feat: GET /api/v3/chats/:roomId
This commit is contained in:
@@ -11,4 +11,72 @@ RoomObject:
|
||||
type: string
|
||||
groupChat:
|
||||
type: boolean
|
||||
description: whether the chat room is a group chat or not
|
||||
description: whether the chat room is a group chat or not
|
||||
MessageObject:
|
||||
type: object
|
||||
properties:
|
||||
content:
|
||||
type: string
|
||||
description: A chat message's content, parsed like a post (so probably outputs html)
|
||||
timestamp:
|
||||
type: number
|
||||
fromuid:
|
||||
type: number
|
||||
roomId:
|
||||
type: number
|
||||
deleted:
|
||||
type: boolean
|
||||
system:
|
||||
type: boolean
|
||||
edited:
|
||||
type: number
|
||||
timestampISO:
|
||||
type: string
|
||||
editedISO:
|
||||
type: string
|
||||
messageId:
|
||||
type: number
|
||||
fromUser:
|
||||
type: object
|
||||
properties:
|
||||
uid:
|
||||
type: number
|
||||
description: A user identifier
|
||||
username:
|
||||
type: string
|
||||
description: A friendly name for a given user account
|
||||
example: Dragon Fruit
|
||||
userslug:
|
||||
type: string
|
||||
description: An URL-safe variant of the username (i.e. lower-cased, spaces removed, etc.)
|
||||
example: dragon-fruit
|
||||
picture:
|
||||
type: string
|
||||
description: A URL pointing to a picture to be used as the user's avatar
|
||||
example: 'https://images.unsplash.com/photo-1560070094-e1f2ddec4337?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=256&h=256&q=80'
|
||||
banned:
|
||||
type: boolean
|
||||
description: Whether a user is banned or not
|
||||
example: false
|
||||
displayname:
|
||||
type: string
|
||||
description: This is either username or fullname depending on forum and user settings
|
||||
example: Dragon Fruit
|
||||
icon:text:
|
||||
type: string
|
||||
description: A single-letter representation of a username. This is used in the
|
||||
auto-generated icon given to users
|
||||
without an avatar
|
||||
icon:bgColor:
|
||||
type: string
|
||||
description: A six-character hexadecimal colour code assigned to the user. This
|
||||
value is used in conjunction with
|
||||
`icon:text` for the user's
|
||||
auto-generated icon
|
||||
example: "#f44336"
|
||||
banned_until_readable:
|
||||
type: string
|
||||
description: An ISO 8601 formatted date string representing the moment a ban will be lifted, or the words "Not Banned"
|
||||
example: Not Banned
|
||||
deleted:
|
||||
type: boolean
|
||||
Reference in New Issue
Block a user