Skip to content

Commit

Permalink
Merge pull request #25 from nick-ching23/nick-ching23-patch-3
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
nl2878 authored Nov 28, 2024
2 parents 9afe75d + ad64c5b commit 913b7ef
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,23 @@ or the underlying checkText call errs out)</li>
<li>Expected Output: HTTP OK, with the number of flags (int)</li>
</details>

<details>
<summary>POST: /register</summary>
<li>Purpose: Register a new organization</li>
<li>Expected Parameters: LoginRequest loginRequest -- an object containing an orgId and password.</li>
<li>Expected Output: HTTP OK Status with a boolean showing if the organization has been successfully registered</li>
<li>Upon Failure: HTTP Bad Request or Internal Server Error</li>
</details>

<details>
<summary>POST: /login</summary>
<li>Purpose: Log a current organiztion in</li>
<li>Expected Parameters: LoginRequest loginRequest -- an object containing an orgId and password.</li>
<li>Expected Output: HTTP OK Status with a boolean showing if the organization has been successfully logged in or not</li>
<li>Upon Failure: HTTP Bad Request or Internal Server Error showing the user has failed to enter the correct orgId or password</li>
</details>


Note: we have incorporated login functionality. Each valid user and organization will need to re-enter their credentials every 24 hours. This check has been integrated into each of our endpoints.


Expand Down

0 comments on commit 913b7ef

Please sign in to comment.