282 lines
7.3 KiB
YAML
282 lines
7.3 KiB
YAML
/users:
|
|
get:
|
|
summary: lists all users
|
|
description: 'Auth: basic, levels: admin'
|
|
tags:
|
|
- /user
|
|
security:
|
|
- BasicAuth: []
|
|
responses:
|
|
200:
|
|
description: user API key
|
|
content:
|
|
application/json:
|
|
schema:
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- $ref: 'api.yaml#/components/schemas/User'
|
|
properties:
|
|
status:
|
|
type: string
|
|
description: can be deleted/new
|
|
example: new
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
403:
|
|
$ref: 'api.yaml#/components/responses/403'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
/user:
|
|
get:
|
|
summary: list own user details
|
|
description: 'Auth: basic, levels: predict, read, write, dev, admin'
|
|
tags:
|
|
- /user
|
|
security:
|
|
- BasicAuth: []
|
|
responses:
|
|
200:
|
|
description: user details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/User'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
403:
|
|
$ref: 'api.yaml#/components/responses/403'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
put:
|
|
summary: change user details
|
|
description: 'Auth: basic, levels: predict, read, write, dev, admin'
|
|
tags:
|
|
- /user
|
|
security:
|
|
- BasicAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: 'api.yaml#/components/schemas/_Id'
|
|
- $ref: 'api.yaml#/components/schemas/UserName'
|
|
- $ref: 'api.yaml#/components/schemas/Email'
|
|
properties:
|
|
pass:
|
|
type: string
|
|
writeOnly: true
|
|
example: Abc123!#
|
|
location:
|
|
type: string
|
|
example: Rng
|
|
devices:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example: Alpha II
|
|
responses:
|
|
200:
|
|
description: user details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/User'
|
|
400:
|
|
$ref: 'api.yaml#/components/responses/400'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
403:
|
|
$ref: 'api.yaml#/components/responses/403'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
delete:
|
|
summary: delete user
|
|
description: 'Auth: basic, levels: predict, read, write, dev, admin'
|
|
tags:
|
|
- /user
|
|
security:
|
|
- BasicAuth: []
|
|
responses:
|
|
200:
|
|
$ref: 'api.yaml#/components/responses/Ok'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
/user/{name}:
|
|
parameters:
|
|
- $ref: 'api.yaml#/components/parameters/Name'
|
|
get:
|
|
summary: list user details
|
|
description: 'Auth: basic, levels: admin'
|
|
tags:
|
|
- /user
|
|
security:
|
|
- BasicAuth: []
|
|
responses:
|
|
200:
|
|
description: user details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/User'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
403:
|
|
$ref: 'api.yaml#/components/responses/403'
|
|
404:
|
|
$ref: 'api.yaml#/components/responses/404'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
put:
|
|
summary: change user details
|
|
description: 'Auth: basic, levels: admin'
|
|
tags:
|
|
- /user
|
|
security:
|
|
- BasicAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/User'
|
|
responses:
|
|
200:
|
|
description: user details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/User'
|
|
400:
|
|
$ref: 'api.yaml#/components/responses/400'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
403:
|
|
$ref: 'api.yaml#/components/responses/403'
|
|
404:
|
|
$ref: 'api.yaml#/components/responses/404'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
delete:
|
|
summary: delete user
|
|
description: 'Auth: basic, levels: admin'
|
|
tags:
|
|
- /user
|
|
security:
|
|
- BasicAuth: []
|
|
responses:
|
|
200:
|
|
$ref: 'api.yaml#/components/responses/Ok'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
403:
|
|
$ref: 'api.yaml#/components/responses/403'
|
|
404:
|
|
$ref: 'api.yaml#/components/responses/404'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
/user/restore/{name}:
|
|
put:
|
|
summary: restore deleted user
|
|
description: 'Auth: basic, levels: admin'
|
|
tags:
|
|
- /user
|
|
security:
|
|
- BasicAuth: []
|
|
responses:
|
|
200:
|
|
$ref: 'api.yaml#/components/responses/Ok'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
403:
|
|
$ref: 'api.yaml#/components/responses/403'
|
|
404:
|
|
$ref: 'api.yaml#/components/responses/404'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
/user/key:
|
|
get:
|
|
summary: get API key for the user
|
|
description: 'Auth: basic, levels: read, write, dev, admin'
|
|
tags:
|
|
- /user
|
|
security:
|
|
- BasicAuth: []
|
|
responses:
|
|
200:
|
|
description: user details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
key:
|
|
type: string
|
|
example: 5ea0450ed851c30a90e70899
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
/user/new:
|
|
post:
|
|
summary: add new user
|
|
description: 'Auth: basic, levels: admin'
|
|
tags:
|
|
- /user
|
|
security:
|
|
- BasicAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
required:
|
|
- email
|
|
- name
|
|
- pass
|
|
- level
|
|
- location
|
|
- devices
|
|
allOf:
|
|
- $ref: 'api.yaml#/components/schemas/User'
|
|
responses:
|
|
200:
|
|
description: user details
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: 'api.yaml#/components/schemas/User'
|
|
400:
|
|
$ref: 'api.yaml#/components/responses/400'
|
|
401:
|
|
$ref: 'api.yaml#/components/responses/401'
|
|
403:
|
|
$ref: 'api.yaml#/components/responses/403'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500'
|
|
/user/passreset:
|
|
post:
|
|
summary: reset password and send mail to restore
|
|
description: 'Auth: none'
|
|
tags:
|
|
- /user
|
|
security: []
|
|
requestBody:
|
|
required: true
|
|
description: mail saved in user profile to provide authentication
|
|
content:
|
|
application/json:
|
|
schema:
|
|
allOf:
|
|
- $ref: 'api.yaml#/components/schemas/UserName'
|
|
- $ref: 'api.yaml#/components/schemas/Email'
|
|
responses:
|
|
200:
|
|
$ref: 'api.yaml#/components/responses/Ok'
|
|
404:
|
|
$ref: 'api.yaml#/components/responses/404'
|
|
500:
|
|
$ref: 'api.yaml#/components/responses/500' |