marcorealacci/WASAPhoto
1
0
Fork 0
mirror of https://github.com/notherealmarco/WASAPhoto.git synced 2025-03-14 14:16:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

OPENAPI: Add followed and banned status in search result

Browse source
This commit is contained in:
Marco Realacci 2022-12-10 01:05:44 +01:00
parent 740aaef0ea
commit 931bf8b79f
1 changed files with 20 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
doc/api.yaml
View file

@ -490,12 +490,16 @@ paths:
maxItems: 100 maxItems: 100
description: An array of users whose username contains the given string. description: An array of users whose username contains the given string.
items: items:
$ref: "#/components/schemas/uid_name" $ref: "#/components/schemas/search_result"
example: example:
- user_id: "123e4567-e89b-12d3-a456-426655440000" - user_id: "123e4567-e89b-12d3-a456-426655440000"
name: "Maria" name: "Maria"
followed: false
banned: false
- user_id: "123e4567-e89b-12d3-a456-426655440001" - user_id: "123e4567-e89b-12d3-a456-426655440001"
name: "Filippo" name: "Filippo"
followed: true
banned: false
'404': '404':
description: No user found. description: No user found.
content: content:
@ -974,10 +978,25 @@ components:
type: boolean type: boolean
example: false example: false
description: Whether the user follows the other user. description: Whether the user follows the other user.
ban_status:
type: boolean
example: false
description: Whether the user banned the other user.
photos_n: photos_n:
type: integer type: integer
example: 90 example: 90
description: Number of photos. description: Number of photos.
search_result:
type: object
properties:
user_id:
$ref: "#/components/schemas/uid"
name:
$ref: "#/components/schemas/name"
followed:
$ref: "#/components/schemas/follow_status"
banned:
$ref: "#/components/schemas/ban_status"
user_profile: user_profile:
type: object type: object
description: The profile of the user. description: The profile of the user.