nyanimedb/api/paths/users.yaml

46 lines
1.1 KiB
YAML

get:
summary: Search user by nickname or dispname (both in one param), response is always sorted by id
parameters:
- in: query
name: word
schema:
type: string
- in: query
name: limit
schema:
type: integer
format: int32
default: 10
- in: query
name: cursor_id
description: pass cursor naked
schema:
type: integer
format: int32
default: 1
responses:
'200':
description: List of users with cursor
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '../schemas/User.yaml'
description: List of users
cursor:
type: integer
format: int64
default: 1
required:
- data
- cursor
'204':
description: No users found
'400':
description: Request params are not correct
'500':
description: Unknown server error