Skip to content

Commit

Permalink
Deployed b14dd3e with MkDocs version: 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
kkli08 committed Dec 7, 2024
1 parent 89cb1be commit 43e83a3
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 5 deletions.
18 changes: 15 additions & 3 deletions authentication/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,11 +108,23 @@ <h4 id="post-body-json">Post Body (<em>Json</em>)<a class="headerlink" href="#po
<ul>
<li>Response: (String or Status Code?)<ul>
<li>If email exists:<ul>
<li>password good: <code>STATUS_CODE::OK</code> (200)</li>
<li>password bad: <code>STATUS_CODE::BAD_REQUEST</code> (400)</li>
<li>password good: <ul>
<li><code>STATUS_CODE</code>: <code>OK (200)</code> </li>
<li><code>Message</code>: "<code>username</code> Login successful"</li>
</ul>
</li>
<li>password bad:<ul>
<li><code>STATUS_CODE</code>:<code>BAD_REQUEST (400)</code> </li>
<li><code>Message</code>: "Invalid password"</li>
</ul>
</li>
</ul>
</li>
<li>If email does not exist: <ul>
<li><code>STATUS_CODE</code>: <code>CREATED (201)</code> </li>
<li><code>Message</code>: "User successfully registered"</li>
</ul>
</li>
<li>If email does not exist: <code>STATUS_CODE::CREATED</code> (201)</li>
</ul>
</li>
</ul>
Expand Down
43 changes: 42 additions & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,47 @@ <h1 id="backend-documentation">Backend Documentation<a class="headerlink" href="
<h2 id="api">API<a class="headerlink" href="#api" title="Permanent link">&para;</a></h2>
<h3 id="authentication"><a href="authentication/">Authentication</a><a class="headerlink" href="#authentication" title="Permanent link">&para;</a></h3>
<h3 id="account-management"><a href="account/">Account Management</a><a class="headerlink" href="#account-management" title="Permanent link">&para;</a></h3>
<table>
<thead>
<tr>
<th>Category</th>
<th>API</th>
<th>Done or Not</th>
<th>Time Finished</th>
<th>Link to Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td>Authentication</td>
<td><code>/signup</code></td>
<td></td>
<td>2024-12-07 2:00pm</td>
<td><a href="authentication/#signup-post">View Docs</a></td>
</tr>
<tr>
<td>Account Management</td>
<td><code>/account_create</code></td>
<td></td>
<td></td>
<td><a href="account/#create-new-account-for-user-post">View Docs</a></td>
</tr>
<tr>
<td>Account Management</td>
<td><code>/account_summary</code></td>
<td></td>
<td></td>
<td><a href="account/#get-account-overview-for-user-get">View Docs</a></td>
</tr>
<tr>
<td>Account Management</td>
<td><code>/account_detail</code></td>
<td></td>
<td></td>
<td><a href="account/#get-account-detailed-view-for-user-get">View Docs</a></td>
</tr>
</tbody>
</table>
<h2 id="quick-start">Quick Start<a class="headerlink" href="#quick-start" title="Permanent link">&para;</a></h2>
<h3 id="update-documentation">Update Documentation<a class="headerlink" href="#update-documentation" title="Permanent link">&para;</a></h3>
<h4 id="clone-project">Clone project<a class="headerlink" href="#clone-project" title="Permanent link">&para;</a></h4>
Expand Down Expand Up @@ -195,5 +236,5 @@ <h2 id="project-layout">Project layout<a class="headerlink" href="#project-layou

<!--
MkDocs version : 1.6.1
Build Date UTC : 2024-12-07 04:39:30.722511+00:00
Build Date UTC : 2024-12-07 19:18:34.083114+00:00
-->
Loading

0 comments on commit 43e83a3

Please sign in to comment.