update docs

esatterwhite · Jan 12, 2017 · c0c2f19 · c0c2f19
1 parent d64acd2
commit c0c2f19
Show file tree

Hide file tree

Showing 36 changed files with 76 additions and 36 deletions.
diff --git a/docs/api/api_data.js b/docs/api/api_data.js
@@ -213,6 +213,26 @@ define({ "api": [
         ]
       }
     },
+    "header": {
+      "fields": {
+        "Response Headers": [
+          {
+            "group": "Response Headers",
+            "type": "String",
+            "optional": false,
+            "field": "location",
+            "description": "<p>URI of the created timer which can be used to modify or cancel the timer</p>"
+          },
+          {
+            "group": "Response Headers",
+            "type": "String",
+            "optional": true,
+            "field": "x-skyring-reason",
+            "description": "<p>An err message if an error occured</p>"
+          }
+        ]
+      }
+    },
     "examples": [
       {
         "title": "curl:",

diff --git a/docs/api/api_data.json b/docs/api/api_data.json
@@ -213,6 +213,26 @@
         ]
       }
     },
+    "header": {
+      "fields": {
+        "Response Headers": [
+          {
+            "group": "Response Headers",
+            "type": "String",
+            "optional": false,
+            "field": "location",
+            "description": "<p>URI of the created timer which can be used to modify or cancel the timer</p>"
+          },
+          {
+            "group": "Response Headers",
+            "type": "String",
+            "optional": true,
+            "field": "x-skyring-reason",
+            "description": "<p>An err message if an error occured</p>"
+          }
+        ]
+      }
+    },
     "examples": [
       {
         "title": "curl:",

diff --git a/docs/api/api_project.js b/docs/api/api_project.js
@@ -1,12 +1,12 @@
 define({
   "name": "skyring",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Distributed timers as a service",
   "sampleUrl": false,
   "apidoc": "0.2.0",
   "generator": {
     "name": "apidoc",
-    "time": "2017-01-10T03:59:04.246Z",
+    "time": "2017-01-12T04:04:17.020Z",
     "url": "http://apidocjs.com",
     "version": "0.16.1"
   }

diff --git a/docs/api/api_project.json b/docs/api/api_project.json
@@ -1,12 +1,12 @@
 {
   "name": "skyring",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "Distributed timers as a service",
   "sampleUrl": false,
   "apidoc": "0.2.0",
   "generator": {
     "name": "apidoc",
-    "time": "2017-01-10T03:59:04.246Z",
+    "time": "2017-01-12T04:04:17.020Z",
     "url": "http://apidocjs.com",
     "version": "0.16.1"
   }

diff --git a/docs/index.html b/docs/index.html
@@ -197,7 +197,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/index.js.html b/docs/index.js.html
@@ -157,7 +157,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_json.js.html b/docs/lib_json.js.html
@@ -146,7 +146,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_nats.js.html b/docs/lib_nats.js.html
@@ -224,7 +224,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_index.js.html b/docs/lib_server_index.js.html
@@ -295,7 +295,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_mock.js.html b/docs/lib_server_mock.js.html
@@ -288,7 +288,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_node.js.html b/docs/lib_server_node.js.html
@@ -309,7 +309,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_request.js.html b/docs/lib_server_request.js.html
@@ -187,7 +187,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_response.js.html b/docs/lib_server_response.js.html
@@ -182,7 +182,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_route.js.html b/docs/lib_server_route.js.html
@@ -230,7 +230,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_server_router.js.html b/docs/lib_server_router.js.html
@@ -286,7 +286,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_timer.js.html b/docs/lib_timer.js.html
@@ -355,7 +355,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_transports_callback.js.html b/docs/lib_transports_callback.js.html
@@ -127,7 +127,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_transports_http.js.html b/docs/lib_transports_http.js.html
@@ -166,7 +166,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/lib_transports_index.js.html b/docs/lib_transports_index.js.html
@@ -149,7 +149,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-keef.html b/docs/module-keef.html
@@ -310,7 +310,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring.html b/docs/module-skyring.html
@@ -225,7 +225,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_json.html b/docs/module-skyring_lib_json.html
@@ -501,7 +501,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_nats.html b/docs/module-skyring_lib_nats.html
@@ -576,7 +576,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server.html b/docs/module-skyring_lib_server.html
@@ -1188,7 +1188,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_mock.html b/docs/module-skyring_lib_server_mock.html
@@ -226,7 +226,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_node.html b/docs/module-skyring_lib_server_node.html
@@ -1574,7 +1574,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_request.html b/docs/module-skyring_lib_server_request.html
@@ -218,7 +218,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:04-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_response.html b/docs/module-skyring_lib_server_response.html
@@ -218,7 +218,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:04-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_route.html b/docs/module-skyring_lib_server_route.html
@@ -820,7 +820,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:04-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_server_router.html b/docs/module-skyring_lib_server_router.html
@@ -1838,7 +1838,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:04-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_timer.html b/docs/module-skyring_lib_timer.html
@@ -1937,7 +1937,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:04-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_transports.html b/docs/module-skyring_lib_transports.html
@@ -344,7 +344,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:04-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_transports_http.html b/docs/module-skyring_lib_transports_http.html
@@ -374,7 +374,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:04-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/module-skyring_lib_transports_timer.html b/docs/module-skyring_lib_transports_timer.html
@@ -212,7 +212,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:04-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/modules.list.html b/docs/modules.list.html
@@ -211,7 +211,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>

diff --git a/docs/node_modules_keef_index.js.html b/docs/node_modules_keef_index.js.html
@@ -383,7 +383,7 @@ <h4 class="modal-title">Search results</h4>
 <span class="jsdoc-message">
 	Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a>
 
-		on 2017-01-09T21:59:03-06:00
+		on 2017-01-11T22:04:16-06:00
 
 	using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
 </span>