Nemcio/NodeBB
1
0
Fork 0
mirror of https://github.com/NodeBB/NodeBB.git synced 2026-05-07 03:27:01 +02:00
Code Issues Packages Projects Releases Wiki Activity

fix(openapi): users.yaml

Browse Source
This commit is contained in:
psychobunny
2020-10-13 14:00:54 -04:00
parent 7b2301ff9c
commit 16873800a6
2 changed files with 81 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

82
public/openapi/write.yaml
View File

@@ -28,88 +28,6 @@ tags:
- name: categories - name: categories
description: Administrative calls to manage categories description: Administrative calls to manage categories
paths: paths:
/users/:
post:
tags:
- users
summary: create a user
description: This operation creates a new user account
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: 'If the username is taken, a number will be appended'
password:
type: string
email:
type: string
required:
- username
example:
username: Dragon Fruit
password: s3cre7password
email: dragonfruit@example.org
responses:
'200':
description: user successfully created
content:
application/json:
schema:
type: object
properties:
status:
$ref: components/schemas/Status.yaml#/Status
response:
$ref: components/schemas/UserObj.yaml#/UserObj
'400':
$ref: components/responses/400.yaml#/400
'401':
$ref: components/responses/401.yaml#/401
'403':
$ref: components/responses/403.yaml#/403
'426':
$ref: components/responses/426.yaml#/426
'500':
$ref: components/responses/500.yaml#/500
delete:
tags:
- users
summary: delete one or more users
description: This operation deletes one or many user accounts, including their contributions (posts, topics, etc.)
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
uids:
type: array
description: A collection of uids
items:
type: number
example:
uids:
- 1
- 2
- 3
responses:
'200':
description: user account(s) deleted
content:
application/json:
schema:
type: object
properties:
status:
$ref: components/schemas/Status.yaml#/Status
response:
type: object
'/users/{uid}': '/users/{uid}':
delete: delete:
tags: tags:

81
public/openapi/write/users.yaml
View File

@@ -0,0 +1,81 @@
post:
tags:
- users
summary: create a user
description: This operation creates a new user account
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: 'If the username is taken, a number will be appended'
password:
type: string
email:
type: string
required:
- username
example:
username: Dragon Fruit
password: s3cre7password
email: dragonfruit@example.org
responses:
'200':
description: user successfully created
content:
application/json:
schema:
type: object
properties:
status:
$ref: ../components/schemas/Status.yaml#/Status
response:
$ref: ../components/schemas/UserObj.yaml#/UserObj
'400':
$ref: ../components/responses/400.yaml#/400
'401':
$ref: ../components/responses/401.yaml#/401
'403':
$ref: ../components/responses/403.yaml#/403
'426':
$ref: ../components/responses/426.yaml#/426
'500':
$ref: ../components/responses/500.yaml#/500
delete:
tags:
- users
summary: delete one or more users
description: This operation deletes one or many user accounts, including their contributions (posts, topics, etc.)
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
uids:
type: array
description: A collection of uids
items:
type: number
example:
uids:
- 1
- 2
- 3
responses:
'200':
description: user account(s) deleted
content:
application/json:
schema:
type: object
properties:
status:
$ref: ../components/schemas/Status.yaml#/Status
response:
type: object