Skip to content

Commit

Permalink
add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
leonlolly committed Mar 17, 2024
1 parent c5a977d commit e070618
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions ROUTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ http://localhost:8000/login
"username": "username",
"password": "password"
}
```
- 401: User login **failed**:
```json
{
Expand Down Expand Up @@ -167,7 +168,7 @@ http://localhost:8000/getOrganisationName/<_id>
- URL
```json
{
_id: "organisation_id"
"_id": "organisation_id"
}
```
- Body
Expand All @@ -183,6 +184,7 @@ http://localhost:8000/getOrganisationName/<_id>
{
"organisation_name": [string]
}
```
- 404: Organization not found.
- 409: Error retrieving organization name.
Expand All @@ -199,6 +201,7 @@ http://localhost:8000/getOrganisationNames
{
"authorization": "---authorization---jwt---"
}
```
- 401: No authorization provided.
- 400: Invalid authorization token.
- 200: Retrieved user's organization names successfully.
Expand Down Expand Up @@ -235,7 +238,7 @@ http://localhost:8000/addUserToOrganisation
- 200: User added to the organization successfully.
```json
{
"organisation_id": number
"organisation_id": "number"
}
```
- 409: Error adding user to organization.
Expand Down Expand Up @@ -335,7 +338,6 @@ http://localhost:8000/data/upload/file
{
"document_ids": ["number"|"string"]
}
```
---
Expand Down

0 comments on commit e070618

Please sign in to comment.