Skip to content

Commit

Permalink
update generated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@esatterwhite
esatterwhite committed Jan 10, 2017
1 parent 12600fe commit d17c119
Show file tree
Hide file tree
Showing 37 changed files with 164 additions and 87 deletions.
26 changes: 24 additions & 2 deletions docs/api/api_data.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,20 @@ define({ "api": [
"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": "Headers Example:",
"content": "HTTP/1.1 201 CREATED\nLOCATION: /timer/489ea3df-c583-4325-8fb0-0f1ec8301bd9\nDate: Fri, 23 Dec 2016 00:19:13 GMT\nConnection: keep-alive\nContent-Length: 0",
"content": "HTTP/1.1 201 CREATED\nLocation: /timer/489ea3df-c583-4325-8fb0-0f1ec8301bd9\nDate: Fri, 23 Dec 2016 00:19:13 GMT\nConnection: keep-alive\nContent-Length: 0",
"type": "text"
}
]
Expand All @@ -95,8 +102,13 @@ define({ "api": [
},
{
"title": "python:",
"content": "import json\nfrom urlib.request import Request, urlopen\ndata = {\n 'timeout': 5000\n, 'data': {'foo':'bar'}\n, 'callback': {\n 'transport': 'http'\n , 'method': 'post'\n , 'uri': 'http://mydomain.name/timer/callback'\n }\n}\nreq = Request(url='http://localhost:3000/timer', data=bytes(json.dumps(data),'ascii'), method='POST')\nres = urlopen(req)\nprint(res.status)\nprint(res.headers['location'])",
"content": "import json\nfrom urllib.request import Request, urlopen\ndata = {\n 'timeout': 5000\n, 'data': {'foo':'bar'}\n, 'callback': {\n 'transport': 'http'\n , 'method': 'post'\n , 'uri': 'http://mydomain.name/timer/callback'\n }\n}\nreq = Request(url='http://localhost:3000/timer', data=bytes(json.dumps(data),'ascii'), method='POST')\nres = urlopen(req)\nprint(res.status)\nprint(res.headers['location'])",
"type": "python"
},
{
"title": "ruby:",
"content": "\nrequire 'json'\nrequire 'net/http'\nrequire 'uri'\n\nuri = URI.parse('http://localhost:3003/timer')\npayload = {\n timeout: 3000, \n data: \"hello world\", \n callback: {\n method: 'post',\n transport: 'http',\n uri: 'http://localhost:4000'\n }\n}\n\nhttp = Net::HTTP.new(uri.host, uri.port)\nrequest = Net::HTTP::Post.new(uri.request_uri, {'Content-Type': 'application/json'})\nrequest.body = payload.to_json\nresponse = http.request(request)\nprint response.code",
"type": "ruby"
}
],
"filename": "lib/server/api/post_timer.js",
Expand Down Expand Up @@ -211,6 +223,16 @@ define({ "api": [
"title": "Node.js:",
"content": "const http = require('http')\nconst data = JSON.stringify({\n timeout: 5000,\n data: {foo: 'bar', bar: 'baz'},\n callback: {\n transport: 'http',\n method: 'post',\n uri: 'http://mydomain.name/timer/callback\n }\n})\nconst options = {\n hostname: 'localhost',\n port: 3000,\n path: '/timer/8c66a779-9c74-4e30-b5e8-f32d60909d45',\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n 'Content-Length': Buffer.byteLength(data)\n }\n };\nconst req = http.request(options, (res) => {\n let data = '';\n res.on('data', (chunk) => {\n data += chunk;\n });\n\n res.on('end', () => {\n // done\n });\n})\nreq.write(data);\nreq.end();",
"type": "js"
},
{
"title": "python:",
"content": "import json\nfrom urllib.request import Request, urlopen\ndata = {\n 'timeout': 5000\n, 'data': {'foo':'bar'}\n, 'callback': {\n 'transport': 'http'\n , 'method': 'post'\n , 'uri': 'http://mydomain.name/timer/callback'\n }\n}\nreq = Request(url='http://localhost:3000/timer/8c66a779-9c74-4e30-b5e8-f32d60909d45', data=bytes(json.dumps(data),'ascii'), method='PUT')\nres = urlopen(req)\nprint(res.status)\nprint(res.headers['location'])",
"type": "python"
},
{
"title": "ruby:",
"content": "\nrequire 'json'\nrequire 'net/http'\nrequire 'uri'\n\nuri = URI.parse('http://localhost:3003/timer/8c66a779-9c74-4e30-b5e8-f32d60909d45')\npayload = {\n timeout: 3000, \n data: \"hello world\", \n callback: {\n method: 'post',\n transport: 'http',\n uri: 'http://localhost:4000'\n }\n}\n\nhttp = Net::HTTP.new(uri.host, uri.port)\nrequest = Net::HTTP::Put.new(uri.request_uri, {'Content-Type': 'application/json'})\nrequest.body = payload.to_json\nresponse = http.request(request)\nprint response.code",
"type": "ruby"
}
],
"filename": "lib/server/api/put_timer.js",
Expand Down
26 changes: 24 additions & 2 deletions docs/api/api_data.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,13 +71,20 @@
"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": "Headers Example:",
"content": "HTTP/1.1 201 CREATED\nLOCATION: /timer/489ea3df-c583-4325-8fb0-0f1ec8301bd9\nDate: Fri, 23 Dec 2016 00:19:13 GMT\nConnection: keep-alive\nContent-Length: 0",
"content": "HTTP/1.1 201 CREATED\nLocation: /timer/489ea3df-c583-4325-8fb0-0f1ec8301bd9\nDate: Fri, 23 Dec 2016 00:19:13 GMT\nConnection: keep-alive\nContent-Length: 0",
"type": "text"
}
]
Expand All @@ -95,8 +102,13 @@
},
{
"title": "python:",
"content": "import json\nfrom urlib.request import Request, urlopen\ndata = {\n 'timeout': 5000\n, 'data': {'foo':'bar'}\n, 'callback': {\n 'transport': 'http'\n , 'method': 'post'\n , 'uri': 'http://mydomain.name/timer/callback'\n }\n}\nreq = Request(url='http://localhost:3000/timer', data=bytes(json.dumps(data),'ascii'), method='POST')\nres = urlopen(req)\nprint(res.status)\nprint(res.headers['location'])",
"content": "import json\nfrom urllib.request import Request, urlopen\ndata = {\n 'timeout': 5000\n, 'data': {'foo':'bar'}\n, 'callback': {\n 'transport': 'http'\n , 'method': 'post'\n , 'uri': 'http://mydomain.name/timer/callback'\n }\n}\nreq = Request(url='http://localhost:3000/timer', data=bytes(json.dumps(data),'ascii'), method='POST')\nres = urlopen(req)\nprint(res.status)\nprint(res.headers['location'])",
"type": "python"
},
{
"title": "ruby:",
"content": "\nrequire 'json'\nrequire 'net/http'\nrequire 'uri'\n\nuri = URI.parse('http://localhost:3003/timer')\npayload = {\n timeout: 3000, \n data: \"hello world\", \n callback: {\n method: 'post',\n transport: 'http',\n uri: 'http://localhost:4000'\n }\n}\n\nhttp = Net::HTTP.new(uri.host, uri.port)\nrequest = Net::HTTP::Post.new(uri.request_uri, {'Content-Type': 'application/json'})\nrequest.body = payload.to_json\nresponse = http.request(request)\nprint response.code",
"type": "ruby"
}
],
"filename": "lib/server/api/post_timer.js",
Expand Down Expand Up @@ -211,6 +223,16 @@
"title": "Node.js:",
"content": "const http = require('http')\nconst data = JSON.stringify({\n timeout: 5000,\n data: {foo: 'bar', bar: 'baz'},\n callback: {\n transport: 'http',\n method: 'post',\n uri: 'http://mydomain.name/timer/callback\n }\n})\nconst options = {\n hostname: 'localhost',\n port: 3000,\n path: '/timer/8c66a779-9c74-4e30-b5e8-f32d60909d45',\n method: 'POST',\n headers: {\n 'Content-Type': 'application/json',\n 'Content-Length': Buffer.byteLength(data)\n }\n };\nconst req = http.request(options, (res) => {\n let data = '';\n res.on('data', (chunk) => {\n data += chunk;\n });\n\n res.on('end', () => {\n // done\n });\n})\nreq.write(data);\nreq.end();",
"type": "js"
},
{
"title": "python:",
"content": "import json\nfrom urllib.request import Request, urlopen\ndata = {\n 'timeout': 5000\n, 'data': {'foo':'bar'}\n, 'callback': {\n 'transport': 'http'\n , 'method': 'post'\n , 'uri': 'http://mydomain.name/timer/callback'\n }\n}\nreq = Request(url='http://localhost:3000/timer/8c66a779-9c74-4e30-b5e8-f32d60909d45', data=bytes(json.dumps(data),'ascii'), method='PUT')\nres = urlopen(req)\nprint(res.status)\nprint(res.headers['location'])",
"type": "python"
},
{
"title": "ruby:",
"content": "\nrequire 'json'\nrequire 'net/http'\nrequire 'uri'\n\nuri = URI.parse('http://localhost:3003/timer/8c66a779-9c74-4e30-b5e8-f32d60909d45')\npayload = {\n timeout: 3000, \n data: \"hello world\", \n callback: {\n method: 'post',\n transport: 'http',\n uri: 'http://localhost:4000'\n }\n}\n\nhttp = Net::HTTP.new(uri.host, uri.port)\nrequest = Net::HTTP::Put.new(uri.request_uri, {'Content-Type': 'application/json'})\nrequest.body = payload.to_json\nresponse = http.request(request)\nprint response.code",
"type": "ruby"
}
],
"filename": "lib/server/api/put_timer.js",
Expand Down
2 changes: 1 addition & 1 deletion docs/api/api_project.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ define({
"apidoc": "0.2.0",
"generator": {
"name": "apidoc",
"time": "2017-01-07T04:08:52.108Z",
"time": "2017-01-10T03:59:04.246Z",
"url": "http://apidocjs.com",
"version": "0.16.1"
}
Expand Down
2 changes: 1 addition & 1 deletion docs/api/api_project.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"apidoc": "0.2.0",
"generator": {
"name": "apidoc",
"time": "2017-01-07T04:08:52.108Z",
"time": "2017-01-10T03:59:04.246Z",
"url": "http://apidocjs.com",
"version": "0.16.1"
}
Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="module-keef-conf.html">keef-conf</a></li><li><a href="module-skyring.html">skyring</a></li><li><a href="module-skyring_lib_json.html">skyring/lib/json</a></li><li><a href="module-skyring_lib_nats.html">skyring/lib/nats</a></li><li><a href="module-skyring_lib_server.html">skyring/lib/server</a></li><li><a href="module-skyring_lib_server_mock.html">skyring/lib/server/mock</a></li><li><a href="module-skyring_lib_server_node.html">skyring/lib/server/node</a></li><li><a href="module-skyring_lib_server_request.html">skyring/lib/server/request</a></li><li><a href="module-skyring_lib_server_response.html">skyring/lib/server/response</a></li><li><a href="module-skyring_lib_server_route.html">skyring/lib/server/route</a></li><li><a href="module-skyring_lib_server_router.html">skyring/lib/server/router</a></li><li><a href="module-skyring_lib_timer.html">skyring/lib/timer</a></li><li><a href="module-skyring_lib_transports.html">skyring/lib/transports</a></li><li><a href="module-skyring_lib_transports_http.html">skyring/lib/transports/http</a></li><li><a href="module-skyring_lib_transports_timer.html">skyring/lib/transports/timer</a></li>
<li><a href="module-keef.html">keef</a></li><li><a href="module-skyring.html">skyring</a></li><li><a href="module-skyring_lib_json.html">skyring/lib/json</a></li><li><a href="module-skyring_lib_nats.html">skyring/lib/nats</a></li><li><a href="module-skyring_lib_server.html">skyring/lib/server</a></li><li><a href="module-skyring_lib_server_mock.html">skyring/lib/server/mock</a></li><li><a href="module-skyring_lib_server_node.html">skyring/lib/server/node</a></li><li><a href="module-skyring_lib_server_request.html">skyring/lib/server/request</a></li><li><a href="module-skyring_lib_server_response.html">skyring/lib/server/response</a></li><li><a href="module-skyring_lib_server_route.html">skyring/lib/server/route</a></li><li><a href="module-skyring_lib_server_router.html">skyring/lib/server/router</a></li><li><a href="module-skyring_lib_timer.html">skyring/lib/timer</a></li><li><a href="module-skyring_lib_transports.html">skyring/lib/transports</a></li><li><a href="module-skyring_lib_transports_http.html">skyring/lib/transports/http</a></li><li><a href="module-skyring_lib_transports_timer.html">skyring/lib/transports/timer</a></li>
</ul>
</li>

Expand Down Expand Up @@ -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-07T12:45:02-06:00
on 2017-01-09T21:59:03-06:00

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/index.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="module-keef-conf.html">keef-conf</a></li><li><a href="module-skyring.html">skyring</a></li><li><a href="module-skyring_lib_json.html">skyring/lib/json</a></li><li><a href="module-skyring_lib_nats.html">skyring/lib/nats</a></li><li><a href="module-skyring_lib_server.html">skyring/lib/server</a></li><li><a href="module-skyring_lib_server_mock.html">skyring/lib/server/mock</a></li><li><a href="module-skyring_lib_server_node.html">skyring/lib/server/node</a></li><li><a href="module-skyring_lib_server_request.html">skyring/lib/server/request</a></li><li><a href="module-skyring_lib_server_response.html">skyring/lib/server/response</a></li><li><a href="module-skyring_lib_server_route.html">skyring/lib/server/route</a></li><li><a href="module-skyring_lib_server_router.html">skyring/lib/server/router</a></li><li><a href="module-skyring_lib_timer.html">skyring/lib/timer</a></li><li><a href="module-skyring_lib_transports.html">skyring/lib/transports</a></li><li><a href="module-skyring_lib_transports_http.html">skyring/lib/transports/http</a></li><li><a href="module-skyring_lib_transports_timer.html">skyring/lib/transports/timer</a></li>
<li><a href="module-keef.html">keef</a></li><li><a href="module-skyring.html">skyring</a></li><li><a href="module-skyring_lib_json.html">skyring/lib/json</a></li><li><a href="module-skyring_lib_nats.html">skyring/lib/nats</a></li><li><a href="module-skyring_lib_server.html">skyring/lib/server</a></li><li><a href="module-skyring_lib_server_mock.html">skyring/lib/server/mock</a></li><li><a href="module-skyring_lib_server_node.html">skyring/lib/server/node</a></li><li><a href="module-skyring_lib_server_request.html">skyring/lib/server/request</a></li><li><a href="module-skyring_lib_server_response.html">skyring/lib/server/response</a></li><li><a href="module-skyring_lib_server_route.html">skyring/lib/server/route</a></li><li><a href="module-skyring_lib_server_router.html">skyring/lib/server/router</a></li><li><a href="module-skyring_lib_timer.html">skyring/lib/timer</a></li><li><a href="module-skyring_lib_transports.html">skyring/lib/transports</a></li><li><a href="module-skyring_lib_transports_http.html">skyring/lib/transports/http</a></li><li><a href="module-skyring_lib_transports_timer.html">skyring/lib/transports/timer</a></li>
</ul>
</li>

Expand Down Expand Up @@ -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-07T12:45:02-06:00
on 2017-01-09T21:59:03-06:00

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/lib_json.js.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a>
<ul class="dropdown-menu ">
<li><a href="module-keef-conf.html">keef-conf</a></li><li><a href="module-skyring.html">skyring</a></li><li><a href="module-skyring_lib_json.html">skyring/lib/json</a></li><li><a href="module-skyring_lib_nats.html">skyring/lib/nats</a></li><li><a href="module-skyring_lib_server.html">skyring/lib/server</a></li><li><a href="module-skyring_lib_server_mock.html">skyring/lib/server/mock</a></li><li><a href="module-skyring_lib_server_node.html">skyring/lib/server/node</a></li><li><a href="module-skyring_lib_server_request.html">skyring/lib/server/request</a></li><li><a href="module-skyring_lib_server_response.html">skyring/lib/server/response</a></li><li><a href="module-skyring_lib_server_route.html">skyring/lib/server/route</a></li><li><a href="module-skyring_lib_server_router.html">skyring/lib/server/router</a></li><li><a href="module-skyring_lib_timer.html">skyring/lib/timer</a></li><li><a href="module-skyring_lib_transports.html">skyring/lib/transports</a></li><li><a href="module-skyring_lib_transports_http.html">skyring/lib/transports/http</a></li><li><a href="module-skyring_lib_transports_timer.html">skyring/lib/transports/timer</a></li>
<li><a href="module-keef.html">keef</a></li><li><a href="module-skyring.html">skyring</a></li><li><a href="module-skyring_lib_json.html">skyring/lib/json</a></li><li><a href="module-skyring_lib_nats.html">skyring/lib/nats</a></li><li><a href="module-skyring_lib_server.html">skyring/lib/server</a></li><li><a href="module-skyring_lib_server_mock.html">skyring/lib/server/mock</a></li><li><a href="module-skyring_lib_server_node.html">skyring/lib/server/node</a></li><li><a href="module-skyring_lib_server_request.html">skyring/lib/server/request</a></li><li><a href="module-skyring_lib_server_response.html">skyring/lib/server/response</a></li><li><a href="module-skyring_lib_server_route.html">skyring/lib/server/route</a></li><li><a href="module-skyring_lib_server_router.html">skyring/lib/server/router</a></li><li><a href="module-skyring_lib_timer.html">skyring/lib/timer</a></li><li><a href="module-skyring_lib_transports.html">skyring/lib/transports</a></li><li><a href="module-skyring_lib_transports_http.html">skyring/lib/transports/http</a></li><li><a href="module-skyring_lib_transports_timer.html">skyring/lib/transports/timer</a></li>
</ul>
</li>

Expand Down Expand Up @@ -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-07T12:45:02-06:00
on 2017-01-09T21:59:03-06:00

using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>.
</span>
Expand Down
Loading

0 comments on commit d17c119

Please sign in to comment.