Skip to content

Commit

Permalink
initial documentation change
Browse files Browse the repository at this point in the history
  • Loading branch information
joelr committed Jun 27, 2016
1 parent bd68655 commit 7e9491f
Show file tree
Hide file tree
Showing 5 changed files with 725 additions and 90 deletions.
Binary file added source/images/social.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/images/timeseries.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 6 additions & 9 deletions source/includes/_errors.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,17 @@
# Errors

<aside class="notice">This error section is stored in a separate file in `includes/_errors.md`. Slate allows you to optionally separate out your docs into many files...just save them to the `includes` folder and add them to the top of your `index.md`'s frontmatter. Files are included in the order listed.</aside>

The Kittn API uses the following error codes:
The JustCharity 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
403 | Forbidden -- The object requested is hidden for authenticated users only
404 | Not Found -- The specified object could not be found
405 | Method Not Allowed -- You tried to access a object 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!
410 | Gone -- The object requested has been removed from our servers
429 | Too Many Requests -- You're requesting too many objects! 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.
Loading

0 comments on commit 7e9491f

Please sign in to comment.