Endpoints
This commit is contained in:
+156
-132
@@ -23,10 +23,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BooleanResponse"
|
||||
examples:
|
||||
Success:
|
||||
value: true
|
||||
$ref: "#/components/schemas/LoginResponse"
|
||||
400:
|
||||
description: Missing fields.
|
||||
content:
|
||||
@@ -99,10 +96,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BooleanResponse"
|
||||
examples:
|
||||
Success:
|
||||
value: true
|
||||
$ref: "#/components/schemas/UserResponse"
|
||||
400:
|
||||
description: Missing fields or duplicate
|
||||
content:
|
||||
@@ -187,48 +181,9 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/UserListResponse"
|
||||
examples:
|
||||
Success:
|
||||
value:
|
||||
{
|
||||
"pages": 1,
|
||||
"data":
|
||||
[
|
||||
{
|
||||
"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,
|
||||
},
|
||||
{
|
||||
"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,
|
||||
},
|
||||
],
|
||||
}
|
||||
tags:
|
||||
- User
|
||||
/user{id}:
|
||||
/user/{id}:
|
||||
get:
|
||||
summary: Get user
|
||||
description: Get user by ID.
|
||||
@@ -249,24 +204,6 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/UserResponse"
|
||||
examples:
|
||||
Success:
|
||||
value:
|
||||
{
|
||||
"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,
|
||||
}
|
||||
404:
|
||||
description: User not found.
|
||||
content:
|
||||
@@ -285,6 +222,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
|
||||
@@ -305,10 +243,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BooleanResponse"
|
||||
examples:
|
||||
Success:
|
||||
value: true
|
||||
$ref: "#/components/schemas/UserResponse"
|
||||
404:
|
||||
description: User not found.
|
||||
content:
|
||||
@@ -325,7 +260,7 @@ paths:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorResponse"
|
||||
examples:
|
||||
User not found:
|
||||
Failed username:
|
||||
value: { "message": "Failed to update username" }
|
||||
tags:
|
||||
- User
|
||||
@@ -348,10 +283,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BooleanResponse"
|
||||
examples:
|
||||
Success:
|
||||
value: true
|
||||
$ref: "#/components/schemas/UserResponse"
|
||||
404:
|
||||
description: User not found.
|
||||
content:
|
||||
@@ -397,29 +329,18 @@ paths:
|
||||
Not authenticated:
|
||||
value:
|
||||
{
|
||||
"pages": 1,
|
||||
"pages": 0,
|
||||
"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!",
|
||||
"id": 0,
|
||||
"user": { "username": "string" },
|
||||
"content": "string",
|
||||
"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",
|
||||
"date": "2019-08-24T14:15:22Z",
|
||||
"timezone_type": 0,
|
||||
"timezone": "string",
|
||||
},
|
||||
},
|
||||
],
|
||||
@@ -434,58 +355,140 @@ paths:
|
||||
"id": 1,
|
||||
"user":
|
||||
{
|
||||
"id": 1,
|
||||
"username": "Admin",
|
||||
"status": 1,
|
||||
"email": "marvin@zedat.fu-berlin.de",
|
||||
"image": "669d41fbdb56b.png",
|
||||
"id": 0,
|
||||
"username": "string",
|
||||
"status": 0,
|
||||
"email": "string",
|
||||
"image": "string",
|
||||
"isAdmin": true,
|
||||
"memberSince":
|
||||
{
|
||||
"date": "2024-07-22 14:02:49.000000",
|
||||
"timezone_type": 3,
|
||||
"timezone": "Europe/Berlin",
|
||||
"date": "2019-08-24T14:15:22Z",
|
||||
"timezone_type": 0,
|
||||
"timezone": "string",
|
||||
},
|
||||
"postCount": 3,
|
||||
"postCount": 0,
|
||||
},
|
||||
"content": "Hey,\r\nGästebucher sind cool…\r\nDas Gästebuch ist freigegeben.\r\nIch hoffe auf viele Beiträge!",
|
||||
"content": "string",
|
||||
"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",
|
||||
"date": "2019-08-24T14:15:22Z",
|
||||
"timezone_type": 0,
|
||||
"timezone": "string",
|
||||
},
|
||||
},
|
||||
],
|
||||
}
|
||||
tags:
|
||||
- Post
|
||||
post:
|
||||
summary: New post
|
||||
description: Create a new post.
|
||||
security:
|
||||
- BasicAuth: []
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/PostCreateRequest"
|
||||
responses:
|
||||
200:
|
||||
description: Success.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/PostResponse"
|
||||
400:
|
||||
description: Missing fields.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorResponse"
|
||||
examples:
|
||||
Missing fields:
|
||||
value: { "message": "Missing content" }
|
||||
tags:
|
||||
- Post
|
||||
/post/{id}:
|
||||
patch:
|
||||
summary: Update post
|
||||
description: Update post with ID. <br>
|
||||
Requires logged in user to have admin permissions for posts not made by them.
|
||||
security:
|
||||
- BasicAuth: []
|
||||
- BasicAuth: [isAdmin]
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: Post ID
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int14
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/PostUpdateRequest"
|
||||
responses:
|
||||
200:
|
||||
description: Success.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/PostResponse"
|
||||
404:
|
||||
description: Post not found.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorResponse"
|
||||
examples:
|
||||
User not found:
|
||||
value: { "message": "Post not found" }
|
||||
500:
|
||||
description: Update failed.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorResponse"
|
||||
examples:
|
||||
Failed:
|
||||
value: { "message": "Failed to update post" }
|
||||
tags:
|
||||
- Post
|
||||
delete:
|
||||
summary: Delete post
|
||||
description: Delete post with ID.
|
||||
security:
|
||||
- BasicAuth: [isAdmin]
|
||||
parameters:
|
||||
- name: id
|
||||
in: path
|
||||
description: Post ID
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int14
|
||||
responses:
|
||||
200:
|
||||
description: Success.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/PostResponse"
|
||||
404:
|
||||
description: Post not found.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ErrorResponse"
|
||||
examples:
|
||||
Post not found:
|
||||
value: { "message": "Post not found" }
|
||||
tags:
|
||||
- Post
|
||||
externalDocs:
|
||||
url: https://khofmann.userpage.fu-berlin.de/phpCourse/exam/api/docs/
|
||||
security: []
|
||||
@@ -510,6 +513,13 @@ components:
|
||||
type: string
|
||||
password:
|
||||
type: string
|
||||
LoginResponse:
|
||||
type: object
|
||||
properties:
|
||||
user:
|
||||
$ref: "#/components/schemas/UserResponse"
|
||||
token:
|
||||
type: string
|
||||
UserResponse:
|
||||
type: object
|
||||
properties:
|
||||
@@ -585,6 +595,8 @@ components:
|
||||
type: number
|
||||
user:
|
||||
$ref: "#/components/schemas/UserResponse"
|
||||
content:
|
||||
type: string
|
||||
postedAt:
|
||||
type: object
|
||||
properties:
|
||||
@@ -604,6 +616,18 @@ components:
|
||||
type: array
|
||||
items:
|
||||
$ref: "#/components/schemas/PostResponse"
|
||||
PostUpdateRequest:
|
||||
type: object
|
||||
properties:
|
||||
content:
|
||||
type: string
|
||||
PostCreateRequest:
|
||||
type: object
|
||||
required:
|
||||
- content
|
||||
properties:
|
||||
content:
|
||||
type: string
|
||||
securitySchemes:
|
||||
BasicAuth:
|
||||
type: apiKey
|
||||
|
||||
+34
-10
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user