mirror of
https://github.com/notherealmarco/WASAPhoto.git
synced 2025-03-14 14:16:15 +01:00
Separated user profile and user photos
This commit is contained in:
parent
1e551885b9
commit
a5c2bb155c
1 changed files with 67 additions and 8 deletions
75
doc/api.yaml
75
doc/api.yaml
|
@ -479,13 +479,6 @@ paths:
|
||||||
error: "Resource not found"
|
error: "Resource not found"
|
||||||
|
|
||||||
/users/{user_id}/photos:
|
/users/{user_id}/photos:
|
||||||
post:
|
|
||||||
tags: ["photos"]
|
|
||||||
summary: Uploads a photo
|
|
||||||
description: Uploads a photo in the gallery of the authorized user.
|
|
||||||
operationId: uploadPhoto
|
|
||||||
security:
|
|
||||||
- BearerAuth: []
|
|
||||||
parameters:
|
parameters:
|
||||||
- name: user_id
|
- name: user_id
|
||||||
in: path
|
in: path
|
||||||
|
@ -493,6 +486,60 @@ paths:
|
||||||
$ref: "#/components/schemas/uid"
|
$ref: "#/components/schemas/uid"
|
||||||
required: true
|
required: true
|
||||||
description: The user ID of the user who uploads the photo.
|
description: The user ID of the user who uploads the photo.
|
||||||
|
|
||||||
|
get:
|
||||||
|
tags: ["photos"]
|
||||||
|
summary: Returns user photos
|
||||||
|
description: Returns the list of photos uploaded by a user.
|
||||||
|
operationId: getUserPhotos
|
||||||
|
security:
|
||||||
|
- BearerAuth: []
|
||||||
|
parameters:
|
||||||
|
- name: limit
|
||||||
|
in: query
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
default: 25
|
||||||
|
description: The number of elements to show.
|
||||||
|
required: false
|
||||||
|
- name: start_index
|
||||||
|
in: query
|
||||||
|
schema:
|
||||||
|
type: integer
|
||||||
|
default: 0
|
||||||
|
description: The starting offset.
|
||||||
|
required: false
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: Returns the user photos list
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/user_photo_stream"
|
||||||
|
'404':
|
||||||
|
description: User not found (or the authorized user is banned).
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/generic_response"
|
||||||
|
example:
|
||||||
|
error: "Resource not found"
|
||||||
|
'400':
|
||||||
|
description: Bad request, there is an error in one of the parameters.
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/generic_response"
|
||||||
|
example:
|
||||||
|
error: "Invalid limit or start_index"
|
||||||
|
|
||||||
|
post:
|
||||||
|
tags: ["photos"]
|
||||||
|
summary: Uploads a photo
|
||||||
|
description: Uploads a photo in the gallery of the authorized user.
|
||||||
|
operationId: uploadPhoto
|
||||||
|
security:
|
||||||
|
- BearerAuth: []
|
||||||
requestBody:
|
requestBody:
|
||||||
content:
|
content:
|
||||||
image/jpeg:
|
image/jpeg:
|
||||||
|
@ -823,6 +870,14 @@ components:
|
||||||
type: integer
|
type: integer
|
||||||
example: 69
|
example: 69
|
||||||
description: Number of following users.
|
description: Number of following users.
|
||||||
|
liked_boolean:
|
||||||
|
type: boolean
|
||||||
|
example: true
|
||||||
|
description: Whether the user liked the photo.
|
||||||
|
photos_n:
|
||||||
|
type: integer
|
||||||
|
example: 90
|
||||||
|
description: Number of photos.
|
||||||
user_profile:
|
user_profile:
|
||||||
type: object
|
type: object
|
||||||
description: The profile of the user.
|
description: The profile of the user.
|
||||||
|
@ -834,7 +889,7 @@ components:
|
||||||
following:
|
following:
|
||||||
$ref: "#/components/schemas/following_n"
|
$ref: "#/components/schemas/following_n"
|
||||||
photos:
|
photos:
|
||||||
$ref: "#/components/schemas/user_photo_stream"
|
$ref: "#/components/schemas/photos_n"
|
||||||
user_photo_stream:
|
user_photo_stream:
|
||||||
type: array
|
type: array
|
||||||
minItems: 0
|
minItems: 0
|
||||||
|
@ -850,6 +905,8 @@ components:
|
||||||
$ref: "#/components/schemas/upload_time"
|
$ref: "#/components/schemas/upload_time"
|
||||||
likes:
|
likes:
|
||||||
$ref: "#/components/schemas/likes"
|
$ref: "#/components/schemas/likes"
|
||||||
|
liked:
|
||||||
|
$ref: "#/components/schemas/liked_boolean"
|
||||||
photo_stream:
|
photo_stream:
|
||||||
type: array
|
type: array
|
||||||
minItems: 0
|
minItems: 0
|
||||||
|
@ -869,6 +926,8 @@ components:
|
||||||
$ref: "#/components/schemas/upload_time"
|
$ref: "#/components/schemas/upload_time"
|
||||||
likes:
|
likes:
|
||||||
$ref: "#/components/schemas/likes"
|
$ref: "#/components/schemas/likes"
|
||||||
|
liked:
|
||||||
|
$ref: "#/components/schemas/liked_boolean"
|
||||||
comments:
|
comments:
|
||||||
type: array
|
type: array
|
||||||
minItems: 0
|
minItems: 0
|
||||||
|
|
Loading…
Reference in a new issue