Pagination on the list, optional auth
This commit is contained in:
+227
-55
@@ -10,7 +10,7 @@ paths:
|
||||
/login:
|
||||
post:
|
||||
summary: Login
|
||||
description: Log in user
|
||||
description: Log in user.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
@@ -19,7 +19,7 @@ paths:
|
||||
$ref: "#/components/schemas/LoginRequest"
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
description: Success.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -28,7 +28,7 @@ paths:
|
||||
Success:
|
||||
value: true
|
||||
400:
|
||||
description: Missing fields
|
||||
description: Missing fields.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -37,7 +37,7 @@ paths:
|
||||
Missing fields:
|
||||
value: { "message": "Missing email" }
|
||||
401:
|
||||
description: Invalid credentials
|
||||
description: Invalid credentials.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -46,7 +46,7 @@ paths:
|
||||
Invalid username or password:
|
||||
value: { "message": "Invalid username or password" }
|
||||
404:
|
||||
description: User not found
|
||||
description: User not found.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -55,7 +55,7 @@ paths:
|
||||
User not found:
|
||||
value: { "message": "User not found" }
|
||||
500:
|
||||
description: Failed
|
||||
description: Failed.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -68,12 +68,12 @@ paths:
|
||||
/logout:
|
||||
post:
|
||||
summary: Logout
|
||||
description: Log out user
|
||||
description: Log out user.
|
||||
security:
|
||||
- BasicAuth: []
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
description: Success.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -161,10 +161,25 @@ paths:
|
||||
/users:
|
||||
get:
|
||||
summary: List users
|
||||
description: List all users. <br>
|
||||
Requires logged in user to have admin permissions.
|
||||
description: List all users.
|
||||
security:
|
||||
- BasicAuth: []
|
||||
parameters:
|
||||
- in: query
|
||||
name: p
|
||||
schema:
|
||||
type: integer
|
||||
minimum: 0
|
||||
default: 0
|
||||
description: Current page.
|
||||
- in: query
|
||||
name: l
|
||||
schema:
|
||||
type: integer
|
||||
minimum: 0
|
||||
maximum: 30
|
||||
default: 10
|
||||
description: The number of items to return.
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
@@ -175,46 +190,50 @@ paths:
|
||||
examples:
|
||||
Success:
|
||||
value:
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"username": "Admin",
|
||||
"status": 1,
|
||||
"email": "marvin@zedat.fu-berlin.de",
|
||||
"image": "669d41fbdb56b.png",
|
||||
"isAdmin": true,
|
||||
"memberSince":
|
||||
{
|
||||
"pages": 1,
|
||||
"data":
|
||||
[
|
||||
{
|
||||
"date": "2024-07-22 14:02:49.000000",
|
||||
"timezone_type": 3,
|
||||
"timezone": "Europe/Berlin",
|
||||
"id": 1,
|
||||
"username": "Admin",
|
||||
"status": 1,
|
||||
"email": "marvin@zedat.fu-berlin.de",
|
||||
"image": "669d41fbdb56b.png",
|
||||
"isAdmin": true,
|
||||
"memberSince":
|
||||
{
|
||||
"date": "2024-07-22 14:02:49.000000",
|
||||
"timezone_type": 3,
|
||||
"timezone": "Europe/Berlin",
|
||||
},
|
||||
"postCount": 3,
|
||||
},
|
||||
"postCount": 3,
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"username": "Max",
|
||||
"status": 1,
|
||||
"email": "max@moritz.net",
|
||||
"image": "profilbilder/max.svg",
|
||||
"isAdmin": false,
|
||||
"memberSince":
|
||||
{
|
||||
"date": "2024-07-22 03:07:41.000000",
|
||||
"timezone_type": 3,
|
||||
"timezone": "Europe/Berlin",
|
||||
"id": 2,
|
||||
"username": "Max",
|
||||
"status": 1,
|
||||
"email": "max@moritz.net",
|
||||
"image": "profilbilder/max.svg",
|
||||
"isAdmin": false,
|
||||
"memberSince":
|
||||
{
|
||||
"date": "2024-07-22 03:07:41.000000",
|
||||
"timezone_type": 3,
|
||||
"timezone": "Europe/Berlin",
|
||||
},
|
||||
"postCount": 2,
|
||||
},
|
||||
"postCount": 2,
|
||||
},
|
||||
]
|
||||
],
|
||||
}
|
||||
tags:
|
||||
- User
|
||||
/user{id}:
|
||||
get:
|
||||
summary: Get user
|
||||
description: Get user by ID
|
||||
description: Get user by ID.
|
||||
security:
|
||||
- BasicAuth: []
|
||||
- BasicAuth: [isAdmin]
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
@@ -225,7 +244,7 @@ paths:
|
||||
format: int14
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
description: Success.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -249,7 +268,7 @@ paths:
|
||||
"postCount": 3,
|
||||
}
|
||||
404:
|
||||
description: User not found
|
||||
description: User not found.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -266,7 +285,7 @@ paths:
|
||||
Use special ID <code>self</code> to update logged in user. <br>
|
||||
Requires logged in user to have admin permissions for any ID other than <code>self</code>.
|
||||
security:
|
||||
- BasicAuth: []
|
||||
- BasicAuth: [isAdmin]
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
@@ -282,7 +301,7 @@ paths:
|
||||
$ref: "#/components/schemas/UserUpdateRequest"
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
description: Success.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -291,7 +310,7 @@ paths:
|
||||
Success:
|
||||
value: true
|
||||
404:
|
||||
description: User not found
|
||||
description: User not found.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -300,7 +319,7 @@ paths:
|
||||
User not found:
|
||||
value: { "message": "User not found" }
|
||||
500:
|
||||
description: Update failed
|
||||
description: Update failed.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -312,10 +331,9 @@ paths:
|
||||
- User
|
||||
delete:
|
||||
summary: Delete user
|
||||
description: Delete user with ID. <br>
|
||||
Requires logged in user to have admin permissions.
|
||||
description: Delete user with ID.
|
||||
security:
|
||||
- BasicAuth: []
|
||||
- BasicAuth: [isAdmin]
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
@@ -326,7 +344,7 @@ paths:
|
||||
format: int14
|
||||
responses:
|
||||
200:
|
||||
description: Success
|
||||
description: Success.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -335,7 +353,7 @@ paths:
|
||||
Success:
|
||||
value: true
|
||||
404:
|
||||
description: User not found
|
||||
description: User not found.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
@@ -345,7 +363,129 @@ paths:
|
||||
value: { "message": "User not found" }
|
||||
tags:
|
||||
- User
|
||||
|
||||
/posts:
|
||||
get:
|
||||
summary: List posts
|
||||
description: List all posts, return full user data if authenticated.
|
||||
security:
|
||||
- {}
|
||||
- BasicAuth: []
|
||||
parameters:
|
||||
- in: query
|
||||
name: p
|
||||
schema:
|
||||
type: integer
|
||||
minimum: 0
|
||||
default: 0
|
||||
description: Current page.
|
||||
- in: query
|
||||
name: l
|
||||
schema:
|
||||
type: integer
|
||||
minimum: 0
|
||||
maximum: 30
|
||||
default: 10
|
||||
description: The number of items to return.
|
||||
responses:
|
||||
200:
|
||||
description: Success.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/PostListResponse"
|
||||
examples:
|
||||
Not authenticated:
|
||||
value:
|
||||
{
|
||||
"pages": 1,
|
||||
"data":
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"user": { "username": "Admin" },
|
||||
"content": "Hey,\r\nGästebucher sind cool…\r\nDas Gästebuch ist freigegeben.\r\nIch hoffe auf viele Beiträge!",
|
||||
"postedAt":
|
||||
{
|
||||
"date": "2020-03-03 09:03:00.000000",
|
||||
"timezone_type": 3,
|
||||
"timezone": "Europe/Berlin",
|
||||
},
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"user": { "username": "Max" },
|
||||
"content": "Bin über Google auf deine Seite gestoßen, danke für das geniale Gästebuch. Werde in Zukunft des Öftern vorbeischaun…\r\n\r\nLiebe Grüsse, Max",
|
||||
"postedAt":
|
||||
{
|
||||
"date": "2020-03-04 12:26:40.000000",
|
||||
"timezone_type": 3,
|
||||
"timezone": "Europe/Berlin",
|
||||
},
|
||||
},
|
||||
],
|
||||
}
|
||||
Authenticated:
|
||||
value:
|
||||
{
|
||||
"pages": 1,
|
||||
"data":
|
||||
[
|
||||
{
|
||||
"id": 1,
|
||||
"user":
|
||||
{
|
||||
"id": 1,
|
||||
"username": "Admin",
|
||||
"status": 1,
|
||||
"email": "marvin@zedat.fu-berlin.de",
|
||||
"image": "669d41fbdb56b.png",
|
||||
"isAdmin": true,
|
||||
"memberSince":
|
||||
{
|
||||
"date": "2024-07-22 14:02:49.000000",
|
||||
"timezone_type": 3,
|
||||
"timezone": "Europe/Berlin",
|
||||
},
|
||||
"postCount": 3,
|
||||
},
|
||||
"content": "Hey,\r\nGästebucher sind cool…\r\nDas Gästebuch ist freigegeben.\r\nIch hoffe auf viele Beiträge!",
|
||||
"postedAt":
|
||||
{
|
||||
"date": "2020-03-03 09:03:00.000000",
|
||||
"timezone_type": 3,
|
||||
"timezone": "Europe/Berlin",
|
||||
},
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"user":
|
||||
{
|
||||
"id": 2,
|
||||
"username": "Max",
|
||||
"status": 1,
|
||||
"email": "max@moritz.net",
|
||||
"image": "profilbilder/max.svg",
|
||||
"isAdmin": false,
|
||||
"memberSince":
|
||||
{
|
||||
"date": "2024-07-22 03:07:41.000000",
|
||||
"timezone_type": 3,
|
||||
"timezone": "Europe/Berlin",
|
||||
},
|
||||
"postCount": 2,
|
||||
},
|
||||
"content": "Bin über Google auf deine Seite gestoßen, danke für das geniale Gästebuch. Werde in Zukunft des Öftern vorbeischaun…\r\n\r\nLiebe Grüsse, Max",
|
||||
"postedAt":
|
||||
{
|
||||
"date": "2020-03-04 12:26:40.000000",
|
||||
"timezone_type": 3,
|
||||
"timezone": "Europe/Berlin",
|
||||
},
|
||||
},
|
||||
],
|
||||
}
|
||||
tags:
|
||||
- Post
|
||||
externalDocs:
|
||||
url: https://khofmann.userpage.fu-berlin.de/phpCourse/exam/api/docs/
|
||||
security: []
|
||||
@@ -430,9 +570,40 @@ components:
|
||||
type: string
|
||||
format: uuid4
|
||||
UserListResponse:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/UserResponse"
|
||||
type: object
|
||||
properties:
|
||||
pages:
|
||||
type: number
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/UserResponse"
|
||||
PostResponse:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: number
|
||||
user:
|
||||
$ref: "#/components/schemas/UserResponse"
|
||||
postedAt:
|
||||
type: object
|
||||
properties:
|
||||
date:
|
||||
type: string
|
||||
format: date-time
|
||||
timezone_type:
|
||||
type: number
|
||||
timezone:
|
||||
type: string
|
||||
PostListResponse:
|
||||
type: object
|
||||
properties:
|
||||
pages:
|
||||
type: number
|
||||
data:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/PostResponse"
|
||||
securitySchemes:
|
||||
BasicAuth:
|
||||
type: apiKey
|
||||
@@ -442,3 +613,4 @@ tags:
|
||||
- name: Login/Logout
|
||||
- name: Register
|
||||
- name: User
|
||||
- name: Post
|
||||
|
||||
+74
-44
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user