Files
NodeBB/public/openapi/write/users/uid/ban.yaml

61 lines
1.4 KiB
YAML
Raw Normal View History

2020-10-13 14:22:00 -04:00
put:
tags:
- users
summary: ban a user
parameters:
- in: path
name: uid
schema:
type: integer
required: true
description: uid of the user to ban
2020-10-26 21:51:25 -04:00
example: 2
2020-10-13 14:22:00 -04:00
requestBody:
content:
application/json:
schema:
type: object
properties:
until:
type: number
description: UNIX timestamp of the ban expiry
example: 1585775608076
reason:
type: string
example: the reason for the ban
responses:
'200':
description: successfully banned user
content:
application/json:
schema:
type: object
properties:
status:
$ref: ../../../components/schemas/Status.yaml#/Status
response:
type: object
delete:
tags:
- users
summary: unbans a user
parameters:
- in: path
name: uid
schema:
type: integer
required: true
description: uid of the user to unban
2020-10-26 21:51:25 -04:00
example: 2
2020-10-13 14:22:00 -04:00
responses:
'200':
description: successfully unbanned user
content:
application/json:
schema:
type: object
properties:
status:
$ref: ../../../components/schemas/Status.yaml#/Status
response:
type: object