Skip to content
This repository has been archived by the owner on Sep 26, 2023. It is now read-only.

Commit

Permalink
Small update
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcDufresne committed Dec 9, 2015
1 parent 650c79e commit 6a0b513
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 37 deletions.
Binary file modified build/doctrees/environment.pickle
Binary file not shown.
Binary file modified build/doctrees/index.doctree
Binary file not shown.
18 changes: 3 additions & 15 deletions build/html/_sources/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The API is hosted at ``https://api.enlightns.com``

POST /api-token-auth
^^^^^^^^^^^^^^^^^^^^
Returns the API token for subsequent calls
Returns the API authentication token for subsequent calls

**Request Headers**

Expand All @@ -27,8 +27,8 @@ Returns the API token for subsequent calls
::

{
"email": "your.email@enlightns.com",
"password": "<password>"
"email": "your.email@example.com",
"password": "p455w0rd"
}

..
Expand Down Expand Up @@ -65,12 +65,6 @@ Lists a user's records


**Response**
::

Content-Type: application/json

..


::

Expand Down Expand Up @@ -188,12 +182,6 @@ Returns your public IP

**Response**

::

Content-Type: application/json

..

::

{
Expand Down
12 changes: 3 additions & 9 deletions build/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,15 +122,15 @@ <h1>Welcome to EnlightNS&#8217;s API Documentation!<a class="headerlink" href="#
<p>The API is hosted at <code class="docutils literal"><span class="pre">https://api.enlightns.com</span></code></p>
<div class="section" id="post-api-token-auth">
<h2>POST /api-token-auth<a class="headerlink" href="#post-api-token-auth" title="Permalink to this headline"></a></h2>
<p>Returns the API token for subsequent calls</p>
<p>Returns the API authentication token for subsequent calls</p>
<p><strong>Request Headers</strong></p>
<div class="highlight-python"><div class="highlight"><pre>Content-Type: application/json
</pre></div>
</div>
<p><strong>Request Body</strong></p>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&quot;email&quot;</span><span class="p">:</span> <span class="s">&quot;your.email@enlightns.com&quot;</span><span class="p">,</span>
<span class="s">&quot;password&quot;</span><span class="p">:</span> <span class="s">&quot;&lt;password&gt;&quot;</span>
<span class="s">&quot;email&quot;</span><span class="p">:</span> <span class="s">&quot;your.email@example.com&quot;</span><span class="p">,</span>
<span class="s">&quot;password&quot;</span><span class="p">:</span> <span class="s">&quot;p455w0rd&quot;</span>
<span class="p">}</span>
</pre></div>
</div>
Expand Down Expand Up @@ -162,9 +162,6 @@ <h2>GET /user/record/<a class="headerlink" href="#get-user-record" title="Permal
</li>
</ul>
<p><strong>Response</strong></p>
<div class="highlight-python"><div class="highlight"><pre>Content-Type: application/json
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="p">[</span>
<span class="p">{</span>
<span class="s">&quot;id&quot;</span><span class="p">:</span> <span class="mi">402</span><span class="p">,</span>
Expand Down Expand Up @@ -255,9 +252,6 @@ <h2>PUT /user/record/&lt;record_id&gt;<a class="headerlink" href="#put-user-reco
<h2>GET /tools/whatismyip/<a class="headerlink" href="#get-tools-whatismyip" title="Permalink to this headline"></a></h2>
<p>Returns your public IP</p>
<p><strong>Response</strong></p>
<div class="highlight-python"><div class="highlight"><pre>Content-Type: application/json
</pre></div>
</div>
<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
<span class="s">&quot;ip&quot;</span><span class="p">:</span> <span class="s">&quot;184.55.30.206&quot;</span>
<span class="p">}</span>
Expand Down
2 changes: 1 addition & 1 deletion build/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 0 additions & 12 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,12 +65,6 @@ Lists a user's records


**Response**
::

Content-Type: application/json

..

::

Expand Down Expand Up @@ -188,12 +182,6 @@ Returns your public IP

**Response**

::

Content-Type: application/json

..
::

{
Expand Down

0 comments on commit 6a0b513

Please sign in to comment.