Browse Source

cleaning up API docs a little

Paul Liverman III 6 years ago
parent
commit
205f972360
1 changed files with 7 additions and 6 deletions
  1. 7
    6
      views/docs/v1.moon

+ 7
- 6
views/docs/v1.moon View File

@@ -69,7 +69,7 @@ class Docs_1 extends Widget
69 69
       li ->
70 70
         a href: "#next", "Coming Next"
71 71
       li ->
72
-        a href: "#notes", "Notes"
72
+        a href: "#notes", "Notes/Tips"
73 73
 
74 74
     a name: "endpoints"
75 75
     h2 "Endpoints"
@@ -90,13 +90,14 @@ class Docs_1 extends Widget
90 90
     div class: "content", ->
91 91
       p ->
92 92
         code "#{domain}/v1/get/12?api_key=#{example_key}"
93
-        text " (assuming a task with ID "
93
+        br!
94
+        text "(assuming a task with ID "
94 95
         code 12
95 96
         text " belongs to you, and the "
96 97
         code "api_key"
97 98
         text " is valid):"
98 99
         br!
99
-        code title: "(This example is a real task that I added while developing this API. :P)", "{\"success\":true,\"task\":{\"created_at\":\"2018-04-24 14:15:04\",\"id\":12,\"content\":\"Make index return a logged_out view instead of redirecting to login\",\"done\":true,\"user_id\":1,\"updated_at\":\"2018-04-25 04:28:36\"}}"
100
+        pre -> code title: "(This example is a real task that I added while developing this API. :P)", "{\"success\":true,\"task\":{\"created_at\":\"2018-04-24 14:15:04\",\"id\":12,\"content\":\"Make index return a logged_out view instead of redirecting to login\",\"done\":true,\"user_id\":1,\"updated_at\":\"2018-04-25 04:28:36\"}}"
100 101
 
101 102
     a class: ".top", href: "#top", "back to top"
102 103
     a name: "auth"
@@ -172,7 +173,7 @@ class Docs_1 extends Widget
172 173
     p ->
173 174
       text "All tasks are returned like so:"
174 175
       br!
175
-      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" } }'
176
+      pre -> 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" } }'
176 177
 
177 178
     button class: "collapsible", "Examples"
178 179
     div class: "content", ->
@@ -269,7 +270,7 @@ class Docs_1 extends Widget
269 270
     p ->
270 271
       text "Send an empty request. Receive something like the following:"
271 272
       br!
272
-      code "{ \"success\": true, \"api_key\": { \"user_id\": 1, \"key\": \"#{example_key}\", \"created_at\": \"2018-04-25 06:05:53\", \"updated_at\": \"2018-04-25 06:05:53\" } }"
273
+      pre -> code "{ \"success\": true, \"api_key\": { \"user_id\": 1, \"key\": \"#{example_key}\", \"created_at\": \"2018-04-25 06:05:53\", \"updated_at\": \"2018-04-25 06:05:53\" } }"
273 274
 
274 275
     a class: ".top", href: "#top", "back to top"
275 276
     a name: "delete-key"
@@ -396,7 +397,7 @@ class Docs_1 extends Widget
396 397
 
397 398
     a class: ".top", href: "#top", "back to top"
398 399
     a name: "notes"
399
-    h2 "Notes"
400
+    h2 "Notes / Tips"
400 401
 
401 402
     p "All routes are technically available by any HTTP verb. However, depending on the HTTP spec for the verb you use, this may cause required data to not be parsed correctly."
402 403