mirror of
https://github.com/danbulant/api_docs
synced 2026-05-19 04:08:40 +00:00
parent
a543eecd26
commit
89d13752ca
8 changed files with 17 additions and 17 deletions
0
fonts/slate.eot
Executable file → Normal file
0
fonts/slate.eot
Executable file → Normal file
0
fonts/slate.ttf
Executable file → Normal file
0
fonts/slate.ttf
Executable file → Normal file
0
fonts/slate.woff
Executable file → Normal file
0
fonts/slate.woff
Executable file → Normal file
0
fonts/slate.woff2
Executable file → Normal file
0
fonts/slate.woff2
Executable file → Normal file
28
index.html
28
index.html
|
|
@ -231,13 +231,13 @@
|
|||
<a href="#kittens" class="toc-h1 toc-link" data-title="Kittens">Kittens</a>
|
||||
<ul class="toc-list-h2">
|
||||
<li>
|
||||
<a href="#get-all-kittens" class="toc-h2 toc-link" data-title="Kittens">Get All Kittens</a>
|
||||
<a href="#get-all-kittens" class="toc-h2 toc-link" data-title="Get All Kittens">Get All Kittens</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#get-a-specific-kitten" class="toc-h2 toc-link" data-title="Kittens">Get a Specific Kitten</a>
|
||||
<a href="#get-a-specific-kitten" class="toc-h2 toc-link" data-title="Get a Specific Kitten">Get a Specific Kitten</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#delete-a-specific-kitten" class="toc-h2 toc-link" data-title="Kittens">Delete a Specific Kitten</a>
|
||||
<a href="#delete-a-specific-kitten" class="toc-h2 toc-link" data-title="Delete a Specific Kitten">Delete a Specific Kitten</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
|
|
@ -247,7 +247,7 @@
|
|||
</div>
|
||||
<ul class="toc-footer">
|
||||
<li><a href='#'>Sign Up for a Developer Key</a></li>
|
||||
<li><a href='https://github.com/tripit/slate'>Documentation Powered by Slate</a></li>
|
||||
<li><a href='https://github.com/lord/slate'>Documentation Powered by Slate</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="page-wrapper">
|
||||
|
|
@ -258,7 +258,7 @@
|
|||
|
||||
<p>We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.</p>
|
||||
|
||||
<p>This example API documentation page was created with <a href="https://github.com/tripit/slate">Slate</a>. Feel free to edit it and use it as a base for your own API's documentation.</p>
|
||||
<p>This example API documentation page was created with <a href="https://github.com/lord/slate">Slate</a>. Feel free to edit it and use it as a base for your own API's documentation.</p>
|
||||
<h1 id='authentication'>Authentication</h1>
|
||||
<blockquote>
|
||||
<p>To authorize, use this code:</p>
|
||||
|
|
@ -417,7 +417,7 @@ Remember — a happy kitten is an authenticated kitten!
|
|||
</span><span class="s2">"deleted"</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="s2">":("</span><span class="w">
|
||||
</span><span class="p">}</span><span class="w">
|
||||
</span></code></pre>
|
||||
<p>This endpoint retrieves a specific kitten.</p>
|
||||
<p>This endpoint deletes a specific kitten.</p>
|
||||
<h3 id='http-request-3'>HTTP Request</h3>
|
||||
<p><code>DELETE http://example.com/kittens/<ID></code></p>
|
||||
<h3 id='url-parameters-2'>URL Parameters</h3>
|
||||
|
|
@ -445,35 +445,35 @@ Remember — a happy kitten is an authenticated kitten!
|
|||
</thead><tbody>
|
||||
<tr>
|
||||
<td>400</td>
|
||||
<td>Bad Request -- Your request sucks</td>
|
||||
<td>Bad Request -- Your request sucks.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>401</td>
|
||||
<td>Unauthorized -- Your API key is wrong</td>
|
||||
<td>Unauthorized -- Your API key is wrong.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>403</td>
|
||||
<td>Forbidden -- The kitten requested is hidden for administrators only</td>
|
||||
<td>Forbidden -- The kitten requested is hidden for administrators only.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>404</td>
|
||||
<td>Not Found -- The specified kitten could not be found</td>
|
||||
<td>Not Found -- The specified kitten could not be found.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>405</td>
|
||||
<td>Method Not Allowed -- You tried to access a kitten with an invalid method</td>
|
||||
<td>Method Not Allowed -- You tried to access a kitten with an invalid method.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>406</td>
|
||||
<td>Not Acceptable -- You requested a format that isn't json</td>
|
||||
<td>Not Acceptable -- You requested a format that isn't json.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>410</td>
|
||||
<td>Gone -- The kitten requested has been removed from our servers</td>
|
||||
<td>Gone -- The kitten requested has been removed from our servers.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>418</td>
|
||||
<td>I'm a teapot</td>
|
||||
<td>I'm a teapot.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>429</td>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
Loading…
Reference in a new issue