Skip to content

Commit 46bbc38

Browse files
committed
docs: update the endpoints docs in the README file
1 parent 731c26a commit 46bbc38

1 file changed

Lines changed: 32 additions & 25 deletions

File tree

README.md

Lines changed: 32 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -21,34 +21,41 @@ base url: `http://localhost:3000`
2121

2222
### Auth
2323

24-
- **Sign up** or **register**: POST `/api/auth/signup`
25-
- **Verify email**: POST `/api/auth/verifyEmail`
26-
- **Sign in** or **login**: POST `/api/auth/signin`
27-
- **Forget Password**: POST `/api/auth/forgotPassword`
28-
- **Reset Password**: POST `/api/auth/resetPassword`
29-
- **Refresh Access Token**: POST `/api/auth/refreshAccessToken`
30-
- **Login with google**: POST `/api/auth/google`
31-
- **Logout**: POST `/api/auth/logout`
24+
- Sign up or register: `POST /api/auth/signup`
25+
- Verify email: `POST /api/auth/verifyEmail`
26+
- Sign in or login: `POST /api/auth/signin`
27+
- Forget Password: `POST /api/auth/forgotPassword`
28+
- Reset Password: `POST /api/auth/resetPassword`
29+
- Refresh Access Token: `POST /api/auth/refreshAccessToken`
30+
- Login with google: `POST /api/auth/google`
31+
- Logout: `POST /api/auth/logout`
3232

3333
### User
3434

35-
- **Get all Users**: GET `/api/users/all`
36-
- **Get a specific User**: GET `/api/users/:id`
37-
- **Update a User**: PUT `/api/users/:id`
38-
- **Update User Password**: PUT `/api/users/update-password/:id`
39-
- **Delete a User**: DELETE `/api/users/:id`
40-
- **Restore a User**: PATCH `/api/users/restore/:id`
41-
- **Upload User Profile Picture**: POST `/api/users/:userId/profile-picture`
42-
- **Delete User Profile Picture**: DELETE `/api/users/:userId/profile-picture`
35+
- Get all Users: `GET /api/users/all`
36+
- Get a specific User: `GET /api/users/:id`
37+
- Update a User: `PUT /api/users/:id`
38+
- Update User Password: `PUT /api/users/update-password/:id`
39+
- Delete a User: `DELETE /api/users/:id`
40+
- Restore a User: `PATCH /api/users/restore/:id`
41+
- Upload User Profile Picture: `POST /api/users/:userId/profile-picture`
42+
- Delete User Profile Picture: `DELETE /api/users/:userId/profile-picture`
4343

4444
### Organization
4545

46-
- **Create an Organization**: POST `/api/organization`
47-
- **Verify an Organization**: POST `/api/organization/verifyOrg`
48-
- **Get all Organizations**: GET `/api/organization/all`
49-
- **Get a specific Organization**: GET `/api/organization/:organizationId`
50-
- **Update an Organization**: PUT `/api/organization/:organizationId`
51-
- **Delete an Organization**: DELETE `/api/organization/:organizationId`
52-
- **Add owners to the org**: POST `/api/organization/:organizationId/addOwner`
53-
- **Upload the organization logo**: POST `/api/organization/:organizationId/logo/upload`
54-
- **Delete the organization logo**: DELETE `/api/organization/:organizationId/logo/delete`
46+
- Create an Organization: `POST /api/organization`
47+
- Verify an Organization: `POST /api/organization/verifyOrg`
48+
- Get all Organizations: `GET /api/organization/all`
49+
- Get a specific Organization: `GET /api/organization/:organizationId`
50+
- Update an Organization: `PUT /api/organization/:organizationId`
51+
- Delete an Organization: `DELETE /api/organization/:organizationId`
52+
- Add owners to the org: `POST /api/organization/:organizationId/addOwner`
53+
- Upload the organization logo: `POST /api/organization/:organizationId/logo/upload`
54+
- Delete the organization logo: `DELETE /api/organization/:organizationId/logo/delete`
55+
56+
### Department
57+
58+
### Team
59+
60+
- Create a new team in a specific organization: `POST /api/organization/:organizationId/department/:departmentId/team`
61+
- Add new team members: `POST /api/organization/:organizationId/department/:departmentId/team/:teamId/addMember`

0 commit comments

Comments
 (0)