mirror of
https://github.com/danbulant/api_docs
synced 2026-06-24 09:02:20 +00:00
Add ability to split content in include files.
This commit is contained in:
parent
dc7a7dce41
commit
b90436e48e
3 changed files with 29 additions and 20 deletions
18
source/includes/_errors.md
Normal file
18
source/includes/_errors.md
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
# Errors
|
||||||
|
|
||||||
|
The Kittn API uses the following error codes:
|
||||||
|
|
||||||
|
|
||||||
|
Error Code | Meaning
|
||||||
|
---------- | -------
|
||||||
|
400 | Bad Request -- Your request sucks
|
||||||
|
401 | Unauthorized -- Your API key is wrong
|
||||||
|
403 | Forbidden -- The kitten requested is hidden for administrators only
|
||||||
|
404 | Not Found -- The specified kitten could not be found
|
||||||
|
405 | Method Not Allowed -- You tried to access a kitten with an invalid method
|
||||||
|
406 | Not Acceptable -- You requested a format that isn't json
|
||||||
|
410 | Gone -- The kitten requested has been removed from our servers
|
||||||
|
418 | I'm a teapot
|
||||||
|
429 | Too Many Requests -- You're requesting too many kittens! Slown down!
|
||||||
|
500 | Internal Server Error -- We had a problem with our server. Try again later.
|
||||||
|
503 | Service Unavailable -- We're temporarially offline for maintanance. Please try again later.
|
||||||
|
|
@ -7,8 +7,12 @@ language_tabs:
|
||||||
- python
|
- python
|
||||||
|
|
||||||
toc_footers:
|
toc_footers:
|
||||||
- <a href='#'>Sign Up for a Developer Key</a>
|
- <a href='#'>Sign Up for a Developer Key</a>
|
||||||
- <a href='http://github.com/tripit/slate'>Documentation Powered by Slate</a>
|
- <a href='http://github.com/tripit/slate'>Documentation Powered by Slate</a>
|
||||||
|
|
||||||
|
includes:
|
||||||
|
- errors
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# Introduction
|
# Introduction
|
||||||
|
|
@ -161,21 +165,3 @@ Parameter | Description
|
||||||
--------- | -----------
|
--------- | -----------
|
||||||
ID | The ID of the cat to retrieve
|
ID | The ID of the cat to retrieve
|
||||||
|
|
||||||
# Errors
|
|
||||||
|
|
||||||
The Kittn API uses the following error codes:
|
|
||||||
|
|
||||||
|
|
||||||
Error Code | Meaning
|
|
||||||
---------- | -------
|
|
||||||
400 | Bad Request -- Your request sucks
|
|
||||||
401 | Unauthorized -- Your API key is wrong
|
|
||||||
403 | Forbidden -- The kitten requested is hidden for administrators only
|
|
||||||
404 | Not Found -- The specified kitten could not be found
|
|
||||||
405 | Method Not Allowed -- You tried to access a kitten with an invalid method
|
|
||||||
406 | Not Acceptable -- You requested a format that isn't json
|
|
||||||
410 | Gone -- The kitten requested has been removed from our servers
|
|
||||||
418 | I'm a teapot
|
|
||||||
429 | Too Many Requests -- You're requesting too many kittens! Slown down!
|
|
||||||
500 | Internal Server Error -- We had a problem with our server. Try again later.
|
|
||||||
503 | Service Unavailable -- We're temporarially offline for maintanance. Please try again later.
|
|
||||||
|
|
@ -83,6 +83,11 @@ under the License.
|
||||||
<div class="page-wrapper">
|
<div class="page-wrapper">
|
||||||
<div class="content">
|
<div class="content">
|
||||||
<%= yield %>
|
<%= yield %>
|
||||||
|
<% if current_page.data.includes %>
|
||||||
|
<% current_page.data.includes.each do |include| %>
|
||||||
|
<%= partial "includes/#{include}" %>
|
||||||
|
<% end %>
|
||||||
|
<% end %>
|
||||||
</div>
|
</div>
|
||||||
<div class="dark-box">
|
<div class="dark-box">
|
||||||
<div id="lang-selector">
|
<div id="lang-selector">
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue