Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2025-10-26 08:36:12 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: openAPI documentation for routes

Browse Source
This commit is contained in:
Julian Lam
2021-12-13 14:42:30 -05:00
parent 40b4544e70
commit 55e68e2fd5
3 changed files with 185 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
public/openapi/write.yaml
View File

@@ -136,6 +136,10 @@ paths:
$ref: 'write/posts/pid/diffs/since.yaml'
/posts/{pid}/diffs/{timestamp}:
$ref: 'write/posts/pid/diffs/timestamp.yaml'
/chats/:
$ref: 'write/chats.yaml'
/chats/{roomId}:
$ref: 'write/chats/roomId.yaml'
/flags/:
$ref: 'write/flags.yaml'
/flags/{flagId}:

165
public/openapi/write/chats.yaml
View File

@@ -1,3 +1,166 @@
get:
tags:
- chats
summary: list recent chat rooms
description: This operation lists recently used chat rooms that the calling user is a part of
parameters:
- in: query
name: perPage
schema:
type: number
description: The number of chat rooms displayed per page
example: 20
- in: query
name: page
schema:
type: number
description: The page number
example: 1
responses:
'200':
description: chat rooms successfully listed
content:
application/json:
schema:
type: object
properties:
status:
$ref: ../components/schemas/Status.yaml#/Status
response:
allOf:
- $ref: ../components/schemas/Chats.yaml#/RoomObject
- type: object
properties:
unread:
type: boolean
description: Whether or not the chat has unread messages within
teaser:
type: object
nullable: true
properties:
fromuid:
type: number
content:
type: string
timestamp:
type: number
timestampISO:
type: string
user:
type: object
properties:
uid:
type: number
description: A user identifier
username:
type: string
description: A friendly name for a given user account
displayname:
type: string
description: This is either username or fullname depending on forum and user settings
userslug:
type: string
description: An URL-safe variant of the username (i.e. lower-cased, spaces
removed, etc.)
picture:
nullable: true
type: string
status:
type: string
lastonline:
type: number
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"
lastonlineISO:
type: string
users:
type: array
items:
type: object
properties:
uid:
type: number
description: A user identifier
username:
type: string
description: A friendly name for a given user account
displayname:
type: string
description: This is either username or fullname depending on forum and user settings
userslug:
type: string
description: An URL-safe variant of the username (i.e. lower-cased, spaces
removed, etc.)
picture:
nullable: true
type: string
status:
type: string
lastonline:
type: number
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"
lastonlineISO:
type: string
lastUser:
type: object
properties:
uid:
type: number
description: A user identifier
username:
type: string
description: A friendly name for a given user account
displayname:
type: string
description: This is either username or fullname depending on forum and user settings
userslug:
type: string
description: An URL-safe variant of the username (i.e. lower-cased, spaces
removed, etc.)
picture:
nullable: true
type: string
status:
type: string
lastonline:
type: number
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"
lastonlineISO:
type: string
usernames:
type: string
post:
tags:
- chats
@@ -12,7 +175,7 @@ post:
properties:
uids:
type: array
example: [2, 3]
example: [2]
required:
- uids
responses:

17
public/openapi/write/chats/roomId.yaml Normal file
View File

@@ -0,0 +1,17 @@
head:
tags:
- chats
summary: check if a chat room exists
parameters:
- in: path
name: roomId
schema:
type: number
required: true
description: room ID to check
example: 1
responses:
'200':
description: chat room found
'404':
description: chat room not found