keitaro-api-skill/references/paths/users_id_.yaml

97 lines
2.1 KiB
YAML

get:
tags:
- Users
security:
- ApiKeyAuth: []
parameters:
- name: id
in: path
description: User ID
required: true
schema:
type: integer
summary: Get user
description: Returns user details.
responses:
'200':
description: User details
content:
application/json:
schema:
$ref: ../schemas/User.yaml
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'404':
$ref: ../responses/NotFound.yaml
'500':
$ref: ../responses/InternalError.yaml
put:
tags:
- Users
security:
- ApiKeyAuth: []
parameters:
- name: id
in: path
description: User ID
required: true
schema:
type: integer
summary: Update user
description: Updates user.
requestBody:
description: User fields to update.
required: true
content:
application/json:
schema:
$ref: ../schemas/UserRequestUpdate.yaml
responses:
'200':
description: User details.
content:
application/json:
schema:
$ref: ../schemas/User.yaml
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'404':
$ref: ../responses/NotFound.yaml
'500':
$ref: ../responses/InternalError.yaml
delete:
tags:
- Users
security:
- ApiKeyAuth: []
parameters:
- name: id
in: path
description: User ID
required: true
schema:
type: integer
summary: Delete user
description: Deletes user. Cannot be reverted.
responses:
'201':
description: User successfully deleted
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'404':
$ref: ../responses/NotFound.yaml
'500':
$ref: ../responses/InternalError.yaml