Browse Source

beginning work on docs

Paul Liverman III 6 years ago
parent
commit
0e52a5e936
4 changed files with 28 additions and 11 deletions
  1. 1
    0
      app.moon
  2. 0
    10
      applications/api.moon
  3. 26
    0
      applications/docs.moon
  4. 1
    1
      layouts/main.moon

+ 1
- 0
app.moon View File

@@ -14,6 +14,7 @@ class Simplex extends Application
14 14
 
15 15
   @include locate "users"
16 16
   @include locate "api"
17
+  @include locate "docs"
17 18
 
18 19
   -- TODO intentionally cause an error to see if this is working as intended
19 20
   handle_error: (err, trace) =>

+ 0
- 10
applications/api.moon View File

@@ -157,13 +157,3 @@ class API extends Application
157 157
       return json: { success: true }
158 158
     else
159 159
       abort 500, "Error deleting api_key."
160
-
161
-  -- /new { content: "string" }
162
-  -- /do { id: # } or content
163
-  -- /undo { id: # } or content
164
-  -- /get { id: # } or content
165
-  -- /random { count: #, done: bool } (both args optional, defaults count 1, done false)
166
-  -- /list { count: #, done: bool, page: #, order: asc/desc } (if done not specified, returns all,
167
-  --                        default count is 50, default page is 1, default order is latest first
168
-  -- /key/new
169
-  -- /key/delete { id: #, key: "str" }

+ 26
- 0
applications/docs.moon View File

@@ -0,0 +1,26 @@
1
+import Application from require "lapis"
2
+
3
+class Docs extends Application
4
+  @path: "/docs"
5
+  @name: "docs_"
6
+
7
+  [index: ""]: =>
8
+    @html ->
9
+      h3 "Hi there."
10
+      a href: @url_for("docs_v1"), "click here"
11
+
12
+  [v1: "/v1"]: =>
13
+    @html ->
14
+      p "ToDo. Write this."
15
+
16
+      -- /new { content: "string" }
17
+      -- /get { id: # } or content
18
+      -- /do { id: # } or content
19
+      -- /undo { id: # } or content
20
+      -- /delete { id: # } or content
21
+      -- /random { count: #, done: bool } (both args optional, defaults count 1, done false)
22
+      -- /list { count: #, done: bool, page: #, order: asc/desc } (if done not specified, returns all,
23
+      --                        default count is 50, default page is 1, default order is latest first
24
+
25
+      -- /key/new
26
+      -- /key/delete { id: #, key: "str" }

+ 1
- 1
layouts/main.moon View File

@@ -23,7 +23,7 @@ class extends Widget
23 23
         div class: "container", ->
24 24
           div class: "row", ->
25 25
             div class: "column column-25 btns", ->
26
-              a class: "button", href: "#", "API Docs"
26
+              a class: "button", href: @url_for("docs_v1"), "API Docs"
27 27
             div class: "column column-100", ->
28 28
               h1(@title or "Simplex")
29 29
             div class: "column column-25 btns", ->