Skip to content

Commit

Permalink
docs: clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
Benjamin-Frost committed May 19, 2024
1 parent ed85108 commit f970191
Showing 1 changed file with 8 additions and 22 deletions.
30 changes: 8 additions & 22 deletions DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,21 +15,19 @@ The API uses a simple authentication mechanism. The user must provide a valid us
<details>
<summary>View details</summary>

#### Endpoint

```
POST /auth/login
```

#### Request Body
Request Body

```
{
username: string
}
```

#### Example Response
Example Response

```json
{
Expand All @@ -48,13 +46,11 @@ The API provides endpoints to get a user's profile and their posts. Furthermore,
<details>
<summary>View details</summary>

#### Endpoint

```
GET /users/:id
```

#### Example Response
Example Response

```json
{
Expand Down Expand Up @@ -129,13 +125,11 @@ GET /users/:id
<details>
<summary>View details</summary>

#### Endpoint

```
PATCH /users/:id
```

#### Request Body
Request Body

```
{
Expand All @@ -155,13 +149,11 @@ The API provides endpoints to get all posts, like a post, unlike a post, comment
<details>
<summary>View details</summary>

#### Endpoint

```
GET /posts
```

#### Example Response
Example Response

```json
[
Expand Down Expand Up @@ -257,7 +249,7 @@ GET /posts
<details>
<summary>View details</summary>

#### Endpoint
Endpoint

```
POST /posts/:id/likes
Expand All @@ -270,8 +262,6 @@ POST /posts/:id/likes
<details>
<summary>View details</summary>

#### Endpoint

```
DELETE /posts/:id/likes
```
Expand All @@ -283,13 +273,11 @@ DELETE /posts/:id/likes
<details>
<summary>View details</summary>

#### Endpoint

```
POST /posts/:id/comments
```

#### Request Body
Request Body

```
{
Expand All @@ -304,13 +292,11 @@ POST /posts/:id/comments
<details>
<summary>View details</summary>

#### Endpoint

```
POST /posts
```

#### Request Body
Request Body

```
{
Expand Down

0 comments on commit f970191

Please sign in to comment.