-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deployed cb820f5 with MkDocs version: 1.6.1
- Loading branch information
Showing
8 changed files
with
329 additions
and
275 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,220 @@ | ||
| <!DOCTYPE html> | ||
| <html class="writer-html5" lang="en" > | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=edge" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <link rel="shortcut icon" href="../img/favicon.ico" /> | ||
| <title>Account Management - Backend Documentation</title> | ||
| <link rel="stylesheet" href="../css/theme.css" /> | ||
| <link rel="stylesheet" href="../css/theme_extra.css" /> | ||
| <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/styles/github.min.css" /> | ||
|
|
||
| <script> | ||
| // Current page data | ||
| var mkdocs_page_name = "Account Management"; | ||
| var mkdocs_page_input_path = "account.md"; | ||
| var mkdocs_page_url = null; | ||
| </script> | ||
|
|
||
| <!--[if lt IE 9]> | ||
| <script src="../js/html5shiv.min.js"></script> | ||
| <![endif]--> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js"></script> | ||
| <script>hljs.highlightAll();</script> | ||
| </head> | ||
|
|
||
| <body class="wy-body-for-nav" role="document"> | ||
|
|
||
| <div class="wy-grid-for-nav"> | ||
| <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav"> | ||
| <div class="wy-side-scroll"> | ||
| <div class="wy-side-nav-search"> | ||
| <a href=".." class="icon icon-home"> Backend Documentation | ||
| </a><div role="search"> | ||
| <form id ="rtd-search-form" class="wy-form" action="../search.html" method="get"> | ||
| <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" title="Type search term here" /> | ||
| </form> | ||
| </div> | ||
| </div> | ||
|
|
||
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="..">Home</a> | ||
| </li> | ||
| </ul> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="../authentication/">Authentication</a> | ||
| </li> | ||
| </ul> | ||
| <ul class="current"> | ||
| <li class="toctree-l1 current"><a class="reference internal current" href="#">Account Management</a> | ||
| <ul class="current"> | ||
| <li class="toctree-l2"><a class="reference internal" href="#create-new-account-for-user-post">Create New Account for User POST</a> | ||
| <ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="#api">API</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#get-account-overview-for-user-get">Get Account Overview for User GET</a> | ||
| <ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="#api_1">API</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li class="toctree-l2"><a class="reference internal" href="#get-account-detailed-view-for-user-get">Get Account Detailed View for User GET</a> | ||
| <ul> | ||
| <li class="toctree-l3"><a class="reference internal" href="#api_2">API</a> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <ul> | ||
| <li class="toctree-l1"><a class="reference internal" href="../database/">Database Schema</a> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
|
|
||
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
| <nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu"> | ||
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
| <a href="..">Backend Documentation</a> | ||
|
|
||
| </nav> | ||
| <div class="wy-nav-content"> | ||
| <div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation"> | ||
| <ul class="wy-breadcrumbs"> | ||
| <li><a href=".." class="icon icon-home" aria-label="Docs"></a></li> | ||
| <li class="breadcrumb-item active">Account Management</li> | ||
| <li class="wy-breadcrumbs-aside"> | ||
| </li> | ||
| </ul> | ||
| <hr/> | ||
| </div> | ||
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||
| <div class="section" itemprop="articleBody"> | ||
|
|
||
| <h1 id="account-management">Account Management<a class="headerlink" href="#account-management" title="Permanent link">¶</a></h1> | ||
| <h2 id="create-new-account-for-user-post">Create New Account for User <code>POST</code><a class="headerlink" href="#create-new-account-for-user-post" title="Permanent link">¶</a></h2> | ||
| <h4 id="api">API<a class="headerlink" href="#api" title="Permanent link">¶</a></h4> | ||
| <pre class="codehilite"><code>http://127.0.0.1:8000/account_create | ||
| </code></pre> | ||
|
|
||
| <ul> | ||
| <li>Request:</li> | ||
| </ul> | ||
| <pre class="codehilite"><code class="language-Json">{ | ||
| "email": "test@example.com", | ||
| "type": "credit", | ||
| "account_name": "td_credit", | ||
| "init_balance(optional)": -200 | ||
| } | ||
| </code></pre> | ||
|
|
||
| <ul> | ||
| <li>Response:<ul> | ||
| <li>Successfully created: <code>STATUS_CODE::CREATED</code> (201)</li> | ||
| <li>Failed to create (e.g. account name already exists): <code>STATUS_CODE::BAD_REQUEST</code> (400)</li> | ||
| </ul> | ||
| </li> | ||
| </ul> | ||
| <h2 id="get-account-overview-for-user-get">Get Account Overview for User <code>GET</code><a class="headerlink" href="#get-account-overview-for-user-get" title="Permanent link">¶</a></h2> | ||
| <h4 id="api_1">API<a class="headerlink" href="#api_1" title="Permanent link">¶</a></h4> | ||
| <pre class="codehilite"><code>http://127.0.0.1:8000/account_summary | ||
| </code></pre> | ||
|
|
||
| <ul> | ||
| <li>Request:</li> | ||
| </ul> | ||
| <pre class="codehilite"><code class="language-Json">{ | ||
| "email": "test@example.com" | ||
| } | ||
| </code></pre> | ||
|
|
||
| <ul> | ||
| <li>Response:</li> | ||
| </ul> | ||
| <pre class="codehilite"><code class="language-Json">{ | ||
| "account1": "888.88CAD", | ||
| "account2": "666.66CAD" | ||
| } | ||
| </code></pre> | ||
|
|
||
| <h2 id="get-account-detailed-view-for-user-get">Get Account Detailed View for User <code>GET</code><a class="headerlink" href="#get-account-detailed-view-for-user-get" title="Permanent link">¶</a></h2> | ||
| <h4 id="api_2">API<a class="headerlink" href="#api_2" title="Permanent link">¶</a></h4> | ||
| <pre class="codehilite"><code>http://127.0.0.1:8000/account_details | ||
| </code></pre> | ||
|
|
||
| <ul> | ||
| <li>Request:</li> | ||
| </ul> | ||
| <pre class="codehilite"><code class="language-Json">{ | ||
| "email": "test@example.com", | ||
| "account_name": "td_credit" | ||
| } | ||
| </code></pre> | ||
|
|
||
| <ul> | ||
| <li>Response:</li> | ||
| </ul> | ||
| <pre class="codehilite"><code class="language-Json">[ | ||
| { | ||
| "1": "TBD" | ||
| }, | ||
| { | ||
| "2": "TBD" | ||
| } | ||
| ] | ||
| </code></pre> | ||
|
|
||
| </div> | ||
| </div><footer> | ||
| <div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation"> | ||
| <a href="../authentication/" class="btn btn-neutral float-left" title="Authentication"><span class="icon icon-circle-arrow-left"></span> Previous</a> | ||
| <a href="../database/" class="btn btn-neutral float-right" title="Database Schema">Next <span class="icon icon-circle-arrow-right"></span></a> | ||
| </div> | ||
|
|
||
| <hr/> | ||
|
|
||
| <div role="contentinfo"> | ||
| <!-- Copyright etc --> | ||
| </div> | ||
|
|
||
| Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. | ||
| </footer> | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
| </section> | ||
|
|
||
| </div> | ||
|
|
||
| <div class="rst-versions" role="note" aria-label="Versions"> | ||
| <span class="rst-current-version" data-toggle="rst-current-version"> | ||
|
|
||
|
|
||
| <span><a href="../authentication/" style="color: #fcfcfc">« Previous</a></span> | ||
|
|
||
|
|
||
| <span><a href="../database/" style="color: #fcfcfc">Next »</a></span> | ||
|
|
||
| </span> | ||
| </div> | ||
| <script src="../js/jquery-3.6.0.min.js"></script> | ||
| <script>var base_url = "..";</script> | ||
| <script src="../js/theme_extra.js"></script> | ||
| <script src="../js/theme.js"></script> | ||
| <script src="../search/main.js"></script> | ||
| <script> | ||
| jQuery(function () { | ||
| SphinxRtdTheme.Navigation.enable(true); | ||
| }); | ||
| </script> | ||
|
|
||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.