Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marchuk-engineer committed May 30, 2024
1 parent e7235ea commit c9f74f9
Showing 1 changed file with 0 additions and 81 deletions.
81 changes: 0 additions & 81 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,87 +94,6 @@ docker.exe compose -f compose.yaml up

</details>

<details lang="java">
<summary>

## Api controllers description 📋
</summary>

**Login Controller** - handle sign-in (jwt tokens).

| HTTP method | Endpoint | Description |
|:-----------:|:-----------------------------------------:|:-----------------------------------:|
| POST | `/oauth2/authorize/(google or facebook)*` | Third party service authentication |
| POST | `/login ` | Plain authentication. |

**Logout Controller** - handle sign-out.

| HTTP method | Endpoint | Description |
|:-----------:|:------------------------:|:----------------------------------:|
| GET | `/logout` | Logout a user |

**Registration Controller** - handle sign-up.

| HTTP method | Endpoint | Description |
|:-----------:|:------------------------:|:-------------------------:|
| POST | `/resend/confirm-token ` | Resend email confirmation |
| POST | `/register` | Register User |
| POST | `/confirm-email` | Email confirmation. |

**Notification Controller** - handle operations on notifications.

| HTTP method | Endpoint | Description |
|:-----------:|:------------------------:|:-------------------------:|
| GET | `/notifications/enable ` | Enable notifications |
| GET | `/notifications/disable` | Disable notifications |

**Reset Password Controller** - handle operations on password.

| HTTP method | Endpoint | Description |
|:-----------:|:------------------------:|:----------------------------------:|
| POST | `/update-password ` | Creates new password |
| POST | `/reset` | Request for new password |
| POST | `/resend/reset-token` | Resend password reset token |
| POST | `/new-password` | Confirmation reset password token. |

**Ticket Controller** - handle operations on tickets.

| HTTP method | Endpoint | Description |
|:-----------:|:------------------------:|:----------------------------------:|
| POST | `/sortedBy` | Sort tickets |
| POST | `/selectedTransport` | Select desired transport type |
| POST | `/searchTickets` | Search tickets |
| GET | `/get/ticket/{id}` | Get detailed info about ticket |

**Type Ahead Controller** - handle type-ahead functionality for city search.

| HTTP method | Endpoint | Description |
|:-----------:|:------------------------:|:----------------------------------:|
| POST | `/typeAhead` | Request cities |

**Delete User Controller** - handle user deletion.

| HTTP method | URL | Description |
|:-----------:|:------------------------:|:----------------------------------:|
| DELETE | `/delete-user` | Delete a user |

**Search History Controller** - user's history search.

| HTTP method | Endpoint | Description |
|:-----------:|:------------------------:|:----------------------------------:|
| GET | `/getHistory` | Request history |

**Review Controller** - handle reviews operations.

| HTTP method | Endpoint | Description |
|:-----------:|:------------------------:|:----------------------------------:|
| POST | `/saveReview` | Saves review |
| GET | `/getReviews` | Receive all reviews |
| DELETE | `/deleteReview` | Delete review |
| GET | `/getUserReview` | Get authorized user review |

</details>

## Authors 🙋‍♂️

👤 **Aleksandra Poichenko** - *Project Manager* [[LinkedIn](https://www.linkedin.com/in/aleksandra-poichenko/)]
Expand Down

0 comments on commit c9f74f9

Please sign in to comment.