2018-04-25 05:02:41 +00:00
import Widget from require "lapis.html"
2018-04-25 05:34:47 +00:00
import domain from require("lapis.config").get!
if domain == "localhost"
domain = "http://localhost"
else
domain = "https://#{domain}"
2018-04-25 05:02:41 +00:00
class Docs_1 extends Widget
content: =>
task_list = ->
ul ->
li ->
2018-04-25 05:34:47 +00:00
a href: "#new", "/new"
2018-04-25 05:02:41 +00:00
text " { content: string }"
li ->
2018-04-25 05:34:47 +00:00
a href: "#get", "/get"
2018-04-25 05:02:41 +00:00
text " { id: integer, content: string }"
li ->
2018-04-25 05:34:47 +00:00
a href: "#do", "/do"
2018-04-25 05:02:41 +00:00
text " { id: integer, content: string }"
li ->
2018-04-25 05:34:47 +00:00
a href: "#undo", "/undo"
2018-04-25 05:02:41 +00:00
text " { id: integer, content: string }"
li ->
2018-04-25 05:34:47 +00:00
a href: "#delete", "/delete"
2018-04-25 05:02:41 +00:00
text " { id: integer, content: string }"
li ->
2018-04-25 05:34:47 +00:00
a href: "#list", "/list"
2018-04-25 05:02:41 +00:00
text " { count: integer, done: boolean, page: integer, order: 'asc'/'desc' }"
li ->
2018-04-25 05:34:47 +00:00
a href: "#random", "/random"
2018-04-25 05:02:41 +00:00
text " { count: integer, done: boolean }"
style -> raw "h3 { font-family: monospace; }"
ol style: "font-family: monospace;", ->
2018-04-25 05:34:47 +00:00
li ->
a href: "#endpoints", "Endpoints"
2018-04-25 05:02:41 +00:00
li ->
a href: "#auth", "Authorization"
li ->
a href: "#tasks", "Tasks"
task_list!
li ->
a href: "#keys", "API Keys"
ul ->
li ->
2018-04-25 05:34:47 +00:00
a href: "#new-key", "/key/new"
2018-04-25 05:02:41 +00:00
li ->
2018-04-25 05:34:47 +00:00
a href: "#delete-key", "/key/delete"
2018-04-25 05:02:41 +00:00
text " { id: integer, key: string }"
2018-04-25 05:34:47 +00:00
li ->
a href: "#errors", "Errors"
li ->
a href: "#rate-limit", "Rate Limiting"
a name: "endpoints"
h2 "Endpoints"
p ->
text "All endpoints are at "
code "#{config.domain}/v1"
text ", so for example, to get an existing task, send a POST request to "
code "#{config.domain}/v1/get"
text " with the appropriate JSON and authorization (listed below)."
p ->
text "All endpoints return a JSON object with a "
code "success"
text " boolean set to "
code "true"
text " and additional object data depending on the endpoint, or an "
code "errors"
text " array stating any errors in usage or encountered during processing. See "
a href: "#errors", "Errors"
text " below for more info on that."
2018-04-25 05:02:41 +00:00
a name: "auth"
h2 "Authorization"
p "Authorization is done using a session cookie on the web interface, or an API key sent along with API requests."
p ->
text "API keys can be sent in an Authorization header or as an "
code "api_key"
text " field in JSON."
blockquote ->
code "Authorization: JDJiJDEyJFRPaG0wOW16VXhoUTd3dElB"
blockquote ->
code '{ "api_key": "JDJiJDEyJFRPaG0wOW16VXhoUTd3dElB" }'
p ->
text "Grab an API key from "
a href: @url_for("index"), "the web interface"
text " to get started. You can also delete existing API keys there."
a name: "tasks"
h2 "Tasks"
p ->
text "Version 1 of this API is extremely simple. POST "
code '{ "content": "this is a todo item" }'
text " with valid authorization to "
2018-04-25 05:34:47 +00:00
code "/new"
2018-04-25 05:02:41 +00:00
text " to add tasks. The next four endpoints ("
2018-04-25 05:34:47 +00:00
code "/get"
2018-04-25 05:02:41 +00:00
text ","
2018-04-25 05:34:47 +00:00
code "/do"
2018-04-25 05:02:41 +00:00
text ","
2018-04-25 05:34:47 +00:00
code "/undo"
2018-04-25 05:02:41 +00:00
text ","
2018-04-25 05:34:47 +00:00
code "/delete"
2018-04-25 05:02:41 +00:00
text ") all use the same input to complete their operations (an "
code "id"
text " integer or "
code "content"
text " boolean)."
p ->
2018-04-25 05:34:47 +00:00
code "/list"
2018-04-25 05:02:41 +00:00
text " and "
2018-04-25 05:34:47 +00:00
code "/random"
2018-04-25 05:02:41 +00:00
text " are a little more complex, and explained further below."
task_list!
a name: "new"
2018-04-25 05:34:47 +00:00
h3 "/new"
2018-04-25 05:20:16 +00:00
p ->
2018-04-25 05:34:47 +00:00
text "As stated above, to create a new task, just POST a "
2018-04-25 05:20:16 +00:00
code "content"
2018-04-25 05:34:47 +00:00
text " string with valid authorization and a new task item will be returned. Here's an example response:"
2018-04-25 05:20:16 +00:00
blockquote ->
2018-04-25 05:34:47 +00:00
code '{ "success": true, "task": { "id": 4, "user_id": 2, "content": "Get a new API key.", "done": false, "created_at": "2018-04-25 04:27:47", "updated_at": "2018-04-25 04:27:47" } }'
2018-04-25 05:20:16 +00:00
2018-04-25 05:34:47 +00:00
p ->
text "This same format is used to return any task, whether it is as a response to these simple queries, or as part of an array returned by "
code "/list"
text " or "
code "/random"
text "."
2018-04-25 05:02:41 +00:00
a name: "get"
2018-04-25 05:34:47 +00:00
h3 "/get"
2018-04-25 05:02:41 +00:00
a name: "do"
2018-04-25 05:34:47 +00:00
h3 "/do"
2018-04-25 05:02:41 +00:00
a name: "undo"
2018-04-25 05:34:47 +00:00
h3 "/undo"
2018-04-25 05:02:41 +00:00
a name: "delete"
2018-04-25 05:34:47 +00:00
h3 "/delete"
2018-04-25 05:02:41 +00:00
a name: "list"
2018-04-25 05:34:47 +00:00
h3 "/list"
2018-04-25 05:02:41 +00:00
a name: "random"
2018-04-25 05:34:47 +00:00
h3 "/random"
2018-04-25 05:02:41 +00:00
a name: "keys"
h2 "API Keys"
a name: "new-key"
2018-04-25 05:34:47 +00:00
h3 "/key/new"
2018-04-25 05:02:41 +00:00
a name: "delete-key"
2018-04-25 05:34:47 +00:00
h3 "/key/delete"
a name: "errors"
h2 "Errors"
a name: "rate-limit"
h2 "Rate Limiting"
p "At this time there is no rate limiting. This will be developed when needed, and the API documentation updated to reflect that, with at least 2 months' warning."
2018-04-25 05:02:41 +00:00
-- /list { count: #, done: bool, page: #, order: asc/desc } (if done not specified, returns all,
-- default count is 50, default page is 1, default order is latest first
2018-04-25 05:20:16 +00:00
-- also returns page: #, pages: #, tasks: []
2018-04-25 05:02:41 +00:00
-- /random { count: #, done: bool } (both args optional, defaults count 1, done false)