Skip to content

Commit f0cd2f8

Browse files
committed
docs: add organization complete endpoints docs in the README file
1 parent 2201851 commit f0cd2f8

1 file changed

Lines changed: 18 additions & 8 deletions

File tree

README.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,24 @@ npm run start:dev # and makesure there is no error
1717

1818
You can test your APIs using **_Swagger_** from [_here_](http://localhost:3000/api-docs/) after running the server
1919

20+
base url: `http://localhost:3000`
21+
2022
### Auth
2123

22-
base url: `http://localhost:3000`
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 `/auth/google`
31+
32+
### User
33+
34+
### Organization
2335

24-
- **Sign up** or **register**: `/api/auth/signup`
25-
- **Verify email**: `/api/auth/verifyEmail`
26-
- **Sign in** or **login**: `/api/auth/signin`
27-
- **Forget Password**: `/api/auth/forgotPassword`
28-
- **Reset Password**: `/api/auth/resetPassword`
29-
- **Refresh Access Token**: `/api/auth/refreshAccessToken`
30-
- **Login with google**: `/auth/google`
36+
- **Create an Organization**: POST `/api/organization`
37+
- **Verify an Organization**: POST `/api/organization/verifyOrg`
38+
- **Get all Organizations**: GET `/api/organization/all`
39+
- **Get a specific Organization**: GET `/api/organization/:organizationId`
40+
- **Update an Organization**: PUT `/api/organization/:organizationId`

0 commit comments

Comments
 (0)