Skip to content

Commit 6a882d6

Browse files
committed
task feature
1 parent 9b0b7d5 commit 6a882d6

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11

22
# API DOCUMENTATION
33
![download](https://github.com/devsylva/TaskFlow-API/assets/67736638/08e112b2-6fb4-4f54-9d05-e9c003ebd5b7)
4-
[Postman Collection](https://www.postman.com/universal-firefly-869928/workspace/taskflow-api)
54

65
Welcome to the documentation for Dispatch Hub! This guide provides developers with the necessary information to interact with our API and integrate it into their applications.
76

@@ -90,3 +89,25 @@ python manage.py test
9089
```
9190
python manage.py test <app_name>.tests.<test_file>
9291
```
92+
93+
# Authentication
94+
Authentication is required for most endpoints in the API. To authenticate, include an access token in the `Authorization` header of your request. The access token can be obtained by logging in to your account or registering a new account.
95+
96+
# API Authentication Endpoints
97+
The following endpoints are available in the API:
98+
99+
- `api/user/signup/` (POST): to allow users register an account.
100+
- `api/user/login/` (POST): to allow users to log in into their account.
101+
- `api/user/login/refresh/` (POST): to allow user refresh to get their access token after it expires.
102+
- `api/user/confirm-email/<uidb64>/<token>/` (GET): to allow users confirm their email address.
103+
- `api/user/logout/` (POST): to allow users to log out of their account.
104+
- `api/user/change_password/` (POST): to allow users change there account password.
105+
106+
# API Task Operations Endpoints
107+
The following endpoints are available in the API:
108+
109+
- `api/task/task_view/` (POST): allow users create tasks.
110+
- `api/task/task_view/` (GET): getting all task owned by the logged in user in order or priority and deadline if provided.
111+
- `api/task/task_detail/` (GET): getting a single task.
112+
- `api/task/task_detail/` (PUT): updating a task.
113+
- `api/task/task_detail/` (DELETE): deleting a task.

0 commit comments

Comments
 (0)