From f970191bcafb873922b12bd7c8e2301a7a0e13fb Mon Sep 17 00:00:00 2001 From: Benjamin Frost Date: Sun, 19 May 2024 12:48:55 +0200 Subject: [PATCH] docs: clean up --- DOCS.md | 30 ++++++++---------------------- 1 file changed, 8 insertions(+), 22 deletions(-) diff --git a/DOCS.md b/DOCS.md index fc69054..d8c16de 100644 --- a/DOCS.md +++ b/DOCS.md @@ -15,13 +15,11 @@ The API uses a simple authentication mechanism. The user must provide a valid us
View details -#### Endpoint - ``` POST /auth/login ``` -#### Request Body +Request Body ``` { @@ -29,7 +27,7 @@ POST /auth/login } ``` -#### Example Response +Example Response ```json { @@ -48,13 +46,11 @@ The API provides endpoints to get a user's profile and their posts. Furthermore,
View details -#### Endpoint - ``` GET /users/:id ``` -#### Example Response +Example Response ```json { @@ -129,13 +125,11 @@ GET /users/:id
View details -#### Endpoint - ``` PATCH /users/:id ``` -#### Request Body +Request Body ``` { @@ -155,13 +149,11 @@ The API provides endpoints to get all posts, like a post, unlike a post, comment
View details -#### Endpoint - ``` GET /posts ``` -#### Example Response +Example Response ```json [ @@ -257,7 +249,7 @@ GET /posts
View details -#### Endpoint +Endpoint ``` POST /posts/:id/likes @@ -270,8 +262,6 @@ POST /posts/:id/likes
View details -#### Endpoint - ``` DELETE /posts/:id/likes ``` @@ -283,13 +273,11 @@ DELETE /posts/:id/likes
View details -#### Endpoint - ``` POST /posts/:id/comments ``` -#### Request Body +Request Body ``` { @@ -304,13 +292,11 @@ POST /posts/:id/comments
View details -#### Endpoint - ``` POST /posts ``` -#### Request Body +Request Body ``` {