Permalink
Browse files

regenerated docs

  • Loading branch information...
1 parent ef329e2 commit 37415e6ffecab668ce16f62780e1f5b1b4195acb @barberdt barberdt committed Dec 6, 2011
Showing with 38 additions and 9 deletions.
  1. +1 −1 configuration_api.html
  2. +21 −2 css/this.css
  3. +11 −1 js/application.js
  4. +1 −1 participation_api.html
  5. +1 −1 restful_api_keys.html
  6. +1 −1 restful_invitations.html
  7. +1 −1 restful_resources.html
  8. +1 −1 restful_swarms.html
@@ -1,7 +1,7 @@
<!DOCTYPE html><html lang="en"><head><title>BUGswarm Developers</title><link rel="stylesheet" href="bootstrap/bootstrap.css"><link rel="stylesheet" href="css/this.css"><link rel="stylesheet" href="js/google-code-prettify/prettify.css"><script src="http://code.jquery.com/jquery-1.5.2.js"></script><script src="js/google-code-prettify/prettify.js"></script><script src="js/application.js"></script><script src="js/google-analytics.js"></script></head><body><!-- NAVIGATION--><div class="topbar"><div class="topbar-inner"><div class="container"><h3><a id="banner" href="index.html">BUGswarm Developers</a></h3><ul class="nav"><li class="dropdown nav-dropdown"><a href="documentation.html" class="dropdown-toggle">Documentation</a><ul class="dropdown-menu"><li><a href="configuration_api.html">Configuration</a></li><li><a href="participation_api.html">Participation</a></li></ul></li><li><a href="tools.html">Tools</a></li><li><a href="libraries.html">Libraries</a></li><li><a href="tutorial.html">Tutorial</a></li><li><a href="applications.html">Applications</a></li><li><a href="hardware.html">Hardware</a></li><li><a href="contact.html">Contact</a></li></ul></div></div></div><!-- CONTAINER--><div class="container"><!-- Path--><div class="page-header"><a href="index.html">Home</a> &rarr;
<a href="documentation.html">Documentation</a> &rarr;
Configuration API
-</div><!-- Header--><h1>Configuration API</h1><p>Configure swarms and their resources through the use of our RESTful API. Manage the social aspect of swarm
+</div><!-- Jump to dropdown--><div class="topbar-inner jump-bar"><div class="nav jump-nav"><div class="dropdown jump-dropdown"><a href="documentation.html" class="jump-header dropdown-toggle">Jump to</a><ul class="dropdown-menu jump-menu"><li><a href="#api-keys">API Keys</a></li><li><a href="#resources">Resources</a></li><li><a href="#swarms">Swarms</a></li><li><a href="#invitations">Invitations</a></li></ul></div></div></div><!-- Header--><h1>Configuration API</h1><p>Configure swarms and their resources through the use of our RESTful API. Manage the social aspect of swarm
by sending and responding to invitations. Be sure to check out the
<a href="tools.html">Tools</a> page for quick and easy ways to get started, including
<a href="http://github.com/bugswarm-tools">BUGswarm Tools</a>, a simple set of python scripts that wraps up both the Configuration and Participation APIs.
View
@@ -48,7 +48,6 @@ pre code {
a {
color: #09C;
-<<<<<<< HEAD
}
.sub-header {
@@ -63,4 +62,24 @@ a {
.app-image {
border: 1px solid black;
-}
+}
+
+.jump-bar {
+ width: 220px;
+ float: right;
+}
+
+.jump-header {
+ color: #BFBFBF;
+ font-size: 17px;
+ width: 220px;
+}
+
+.jump-header-open {
+ color: #FFFFFF;
+}
+
+.jump-menu {
+ width: 220px;
+ margin-left: -1px;;
+}
View
@@ -3,12 +3,22 @@ $(document).ready(function() {
// Instantiate prettyprint
prettyPrint();
- // Dropdown mouseover
+ // Navigation Dropdown mouseover
$(".nav-dropdown").mouseover(function () {
$(".nav-dropdown").toggleClass('open');
});
$(".nav-dropdown").mouseout(function () {
$(".nav-dropdown").toggleClass('open');
});
+
+ // Jump To Dropdown Mouseover
+ $(".jump-dropdown").mouseover(function () {
+ $(".jump-dropdown").toggleClass('open jump-header-open');
+ });
+
+ $(".jump-dropdown").mouseout(function () {
+ $(".jump-dropdown").toggleClass('open jump-header-open');
+ });
+
});
@@ -1,7 +1,7 @@
<!DOCTYPE html><html lang="en"><head><title>BUGswarm Developers</title><link rel="stylesheet" href="bootstrap/bootstrap.css"><link rel="stylesheet" href="css/this.css"><link rel="stylesheet" href="js/google-code-prettify/prettify.css"><script src="http://code.jquery.com/jquery-1.5.2.js"></script><script src="js/google-code-prettify/prettify.js"></script><script src="js/application.js"></script><script src="js/google-analytics.js"></script></head><body><!-- NAVIGATION--><div class="topbar"><div class="topbar-inner"><div class="container"><h3><a id="banner" href="index.html">BUGswarm Developers</a></h3><ul class="nav"><li class="dropdown nav-dropdown"><a href="documentation.html" class="dropdown-toggle">Documentation</a><ul class="dropdown-menu"><li><a href="configuration_api.html">Configuration</a></li><li><a href="participation_api.html">Participation</a></li></ul></li><li><a href="tools.html">Tools</a></li><li><a href="libraries.html">Libraries</a></li><li><a href="tutorial.html">Tutorial</a></li><li><a href="applications.html">Applications</a></li><li><a href="hardware.html">Hardware</a></li><li><a href="contact.html">Contact</a></li></ul></div></div></div><!-- CONTAINER--><div class="container"><!-- Path--><div class="page-header"><a href="index.html">Home</a> &rarr;
<a href="documentation.html">Documentation</a> &rarr;
Participation API
-</div><!-- Header--><h1>Participation API</h1><p>The Participation API is used to connect resources to the swarms they are a member of.
+</div><!-- Jump to dropdown--><div class="topbar-inner jump-bar"><div class="nav jump-nav"><div class="dropdown jump-dropdown"><a href="documentation.html" class="jump-header dropdown-toggle">Jump to</a><ul class="dropdown-menu jump-menu"><li><a href="#opening-a-connection">Opening a Connection</a></li><li><a href="#sending-messages">Sending Messages</a></li><li><a href="#receiving-messages">Receiving Messages</a></li><li><a href="#presence-and-errors">Presence and Errors</a></li></ul></div></div></div><!-- Header--><h1>Participation API</h1><p>The Participation API is used to connect resources to the swarms they are a member of.
Once connected, resources may produce data, consume data, or do both, depending on their level of access to the swarm.
Throughout this process, the BUGswarm platform generates presence notifications and error messages when necessary in addition to passing
along the messages being produced in the swarm. The Participation API makes use of HTTP streaming, meaning that once a connection has been opened,
@@ -2,7 +2,7 @@
<a href="documentation.html">Documentation</a> &rarr;
<a href="configuration_api.html">Configuration API</a> &rarr;
API Keys
-</div><!-- Header--><h1>API Keys</h1><p>Create and list your API keys. The Configuration API key is used for all methods associated with the
+</div><!-- Jump to dropdown--><div class="topbar-inner jump-bar"><div class="nav jump-nav"><div class="dropdown jump-dropdown"><a href="documentation.html" class="jump-header dropdown-toggle">Jump to</a><ul class="dropdown-menu jump-menu"><li><a href="#create">Create</a></li><li><a href="#list">List</a></li></ul></div></div></div><!-- Header--><h1>API Keys</h1><p>Create and list your API keys. The Configuration API key is used for all methods associated with the
<a href="configuration_api.html">Configuration API</a>, including establishing swarms and their resources as well as managing invitations. The Participation API key is used for connecting
resources to the swarms they are members of to allow production and consumption of data in those swarms. More information on this use can be found in the
<a href="participation_api.html">Participation API</a>.
@@ -2,7 +2,7 @@
<a href="documentation.html">Documentation</a> &rarr;
<a href="configuration_api.html">Configuration API</a> &rarr;
Invitations
-</div><!-- Header--><h1>Invitations</h1><p>Send, list, and respond to invitations using the RESTful API.
+</div><!-- Jump to dropdown--><div class="topbar-inner jump-bar"><div class="nav jump-nav"><div class="dropdown jump-dropdown"><a href="documentation.html" class="jump-header dropdown-toggle">Jump to</a><ul class="dropdown-menu jump-menu"><li><a href="#send">Send</a></li><li><a href="#respond">Respond</a></li><li><a href="#list-sent">List Sent</a></li><li><a href="#list-received">List Received</a></li></ul></div></div></div><!-- Header--><h1>Invitations</h1><p>Send, list, and respond to invitations using the RESTful API.
</p><div class="page-header"></div><!-- Send--><h3 id="send">Send</h3><!-- description--><div class="row"><div class="span8 columns"><ul class="unstyled"><li><strong>URL: </strong><code>http://api.bugswarm.net/swarms/SWARM_ID/invitations</code><li><strong>Method: </strong>POST
</li><li><strong>Headers: </strong><br><code>"x-bugswarmapikey: ${API_KEY}"</code>,
<br><code>"content-type: application/json"</code></li><li><strong>Parameters (Required): </strong>None
@@ -2,7 +2,7 @@
<a href="documentation.html">Documentation</a> &rarr;
<a href="configuration_api.html">Configuration API</a> &rarr;
Resources
-</div><!-- Header--><h1>Resources</h1><p>Create and manage your resources.
+</div><!-- Jump to dropdown--><div class="topbar-inner jump-bar"><div class="nav jump-nav"><div class="dropdown jump-dropdown"><a href="documentation.html" class="jump-header dropdown-toggle">Jump to</a><ul class="dropdown-menu jump-menu"><li><a href="#create">Create</a></li><li><a href="#update">Update</a></li><li><a href="#destroy">Destroy</a></li><li><a href="#list">List</a></li><li><a href="#get-info">Get Info</a></li><li><a href="#list-swarms">List Swarms</a></li></ul></div></div></div><!-- Header--><h1>Resources</h1><p>Create and manage your resources.
</p><div class="page-header"></div><!-- Create--><h3 id="create">Create</h3><!-- description--><div class="row"><div class="span8 columns"><ul class="unstyled"><li><strong>URL: </strong><code>http://api.bugswarm.net/resources</code><li><strong>Method: </strong>POST
</li><li><strong>Headers: </strong><br><code>"x-bugswarmapikey: ${API_KEY}"</code>,
<br><code>"content-type: application/json"</code></li><li><strong>Parameters (Required): </strong>None
View
@@ -2,7 +2,7 @@
<a href="documentation.html">Documentation</a> &rarr;
<a href="configuration_api.html">Configuration API</a> &rarr;
Swarms
-</div><!-- Header--><h1>Swarms</h1><p>Create and manage your swarms.
+</div><!-- Jump to dropdown--><div class="topbar-inner jump-bar"><div class="nav jump-nav"><div class="dropdown jump-dropdown"><a href="documentation.html" class="jump-header dropdown-toggle">Jump to</a><ul class="dropdown-menu jump-menu"><li><a href="#create">Create</a></li><li><a href="#update">Update</a></li><li><a href="#destroy">Destroy</a></li><li><a href="#list">List</a></li><li><a href="#get-info">Get Info</a></li><li><a href="#add-resource">Add Resource</a></li><li><a href="#remove-resource">Remove Resource</a></li><li><a href="#list-resources">List Resources </a></li></ul></div></div></div><!-- Header--><h1>Swarms</h1><p>Create and manage your swarms.
</p><div class="page-header"></div><!-- Create--><h3 id="create">Create</h3><!-- Description--><div class="row"><div class="span8 columns"><ul class="unstyled"><li><strong>URL: </strong><code>http://api.bugswarm.net/swarms</code><li><strong>Method: </strong>POST
</li><li><strong>Headers: </strong><br><code>"x-bugswarmapikey: ${API_KEY}"</code>,
<br><code>"content-type: application/json"</code></li><li><strong>Parameters (Required): </strong>None

0 comments on commit 37415e6

Please sign in to comment.