/
configuration_api.html
449 lines (347 loc) · 11.8 KB
/
configuration_api.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<html lang="en">
<head>
<meta name="generator" content=
"HTML Tidy for Linux (vers 25 March 2009), see www.w3.org">
<title>BUGswarm Developers</title>
<link rel="stylesheet" href="bootstrap/bootstrap.css" type=
"text/css">
<link rel="stylesheet" href="css/this.css" type="text/css">
<link rel="stylesheet" href=
"js/google-code-prettify/prettify.css" type="text/css">
<script src="http://code.jquery.com/jquery-1.5.2.js" type=
"text/javascript">
</script>
<script src="js/google-code-prettify/prettify.js" type=
"text/javascript">
</script>
<script src="js/application.js" type="text/javascript">
</script>
<script src="js/google-analytics.js" type="text/javascript">
</script>
</head>
<body>
<!-- NAVIGATION-->
<div class="topbar">
<div class="topbar-inner">
<div class="container">
<h3><a id="banner" href="index.html" name=
"banner"><img src="images/bs_logo.png"></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> → <a href=
"documentation.html">Documentation</a> → Configuration
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="#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.</p><!-- API Keys-->
<h3><a id="api-keys" href="restful_api_keys.html" name=
"api-keys">API Keys</a></h3>
<p>Used as credentials and passed as headers when making HTTP
requests.</p>
<div class="row">
<div class="span6 columns">
<h5>Method</h5>
</div>
<div class="span6 columns">
<h5>Description</h5>
</div>
</div>
<div class="page-header"></div><!-- create-->
<div class="row">
<div class="span6 columns">
<a href="restful_api_keys.html#create">Create (POST)</a>
</div>
<div class="span10 columns">
<p>Create your participation key, configuration key, or
both at once.</p>
</div>
</div>
<div class="page-header"></div><!-- list-->
<div class="row">
<div class="span6 columns">
<a href="restful_api_keys.html#list">List (GET)</a>
</div>
<div class="span10 columns">
<p>Retrieve both of your API keys or just one based on
type.</p>
</div>
</div>
<div class="page-header"></div><!-- Resources-->
<h3><a id="resources" href="restful_resources.html" name=
"resources">Resources</a></h3>
<p>Used to produce and consume data in the swarms they are
members of.</p>
<div class="row">
<div class="span6 columns">
<h5>Method</h5>
</div>
<div class="span6 columns">
<h5>Description</h5>
</div>
</div>
<div class="page-header"></div><!-- create-->
<div class="row">
<div class="span6 columns">
<a href="restful_resources.html#create">Create (POST)</a>
</div>
<div class="span10 columns">
<p>Create a resource. POST a JSON file containing
information about the resource to be created.</p>
</div>
</div>
<div class="page-header"></div><!-- update-->
<div class="row">
<div class="span6 columns">
<a href="restful_resources.html#update">Update (PUT)</a>
</div>
<div class="span10 columns">
<p>Update an already existing resource. PUT a JSON file
containing the information to update.</p>
</div>
</div>
<div class="page-header"></div><!-- destroy-->
<div class="row">
<div class="span6 columns">
<a href="restful_resources.html#destroy">Destroy
(DELETE)</a>
</div>
<div class="span10 columns">
<p>Destroy a resource. Remove a resource from your user
account.</p>
</div>
</div>
<div class="page-header"></div><!-- list-->
<div class="row">
<div class="span6 columns">
<a href="restful_resources.html#list">List (GET)</a>
</div>
<div class="span10 columns">
<p>List all of the resources in your user account.</p>
</div>
</div>
<div class="page-header"></div><!-- get info-->
<div class="row">
<div class="span6 columns">
<a href="restful_resources.html#get-info">Get Info
(GET)</a>
</div>
<div class="span10 columns">
<p>Get a given resource's information.</p>
</div>
</div>
<div class="page-header"></div><!-- list swarms-->
<div class="row">
<div class="span6 columns">
<a href="restful_resources.html#list-swarms">List Swarms
(GET)</a>
</div>
<div class="span10 columns">
<p>List the swarms that a given resource is a member
of.</p>
</div>
</div>
<div class="page-header"></div><!-- Swarms-->
<h3><a id="swarms" href="restful_swarms.html" name=
"swarms">Swarms</a></h3>
<p>Used to group together resources and allow them to share
data with each other.</p>
<div class="row">
<div class="span6 columns">
<h5>Method</h5>
</div>
<div class="span6 columns">
<h5>Description</h5>
</div>
</div>
<div class="page-header"></div><!-- create-->
<div class="row">
<div class="span6 columns">
<a href="restful_swarms.html#create">Create (POST)</a>
</div>
<div class="span10 columns">
<p>Create a swarm. POST a JSON file containing information
about the swarm to be created.</p>
</div>
</div>
<div class="page-header"></div><!-- update-->
<div class="row">
<div class="span6 columns">
<a href="restful_swarms.html#update">Update (PUT)</a>
</div>
<div class="span10 columns">
<p>Update an already existing swarm. PUT a JSON file
containing the information to update.</p>
</div>
</div>
<div class="page-header"></div><!-- destroy-->
<div class="row">
<div class="span6 columns">
<a href="restful_swarms.html#destroy">Destroy (DELETE)</a>
</div>
<div class="span10 columns">
<p>Destroy a swarm. Remove a swarm from your user
account.</p>
</div>
</div>
<div class="page-header"></div><!-- list-->
<div class="row">
<div class="span6 columns">
<a href="restful_swarms.html#list">List (GET)</a>
</div>
<div class="span10 columns">
<p>List all of the swarms in your user account.</p>
</div>
</div>
<div class="page-header"></div><!-- get info-->
<div class="row">
<div class="span6 columns">
<a href="restful_swarms.html#get-info">Get Info (GET)</a>
</div>
<div class="span10 columns">
<p>Get a given swarm's information, including it's member
resources.</p>
</div>
</div>
<div class="page-header"></div><!-- add resource-->
<div class="row">
<div class="span6 columns">
<a href="restful_swarms.html#add-resource">Add Resource
(POST)</a>
</div>
<div class="span10 columns">
<p>Add a resource to a swarm. POST a JSON file containing
the swarm-relevant information regarding the resource to be
added.</p>
</div>
</div>
<div class="page-header"></div><!-- remove resource-->
<div class="row">
<div class="span6 columns">
<a href="restful_swarms.html#remove-resource">Remove
Resource (DELETE)</a>
</div>
<div class="span10 columns">
<p>Remove a resource from a swarm. POST a JSON file
containing swarm-relevant information regarding the
resource to remove.</p>
</div>
</div>
<div class="page-header"></div><!-- list resources-->
<div class="row">
<div class="span6 columns">
<a href="restful_swarms.html#list-resources">List Resources
(GET)</a>
</div>
<div class="span10 columns">
<p>List a given swarm's member resources. Users may choose
to list only producing resources, only consuming resourcs,
or all resources at once.</p>
</div>
</div>
<div class="page-header"></div><!-- Invitations-->
<h3><a id="invitations" href="restful_invitations.html" name=
"invitations">Invitations</a></h3>
<p>Expose BUGswarm's unique social presence by inviting another
user's resources to join your swarms and share in the
production and consumption of data. Accept invitations from
other users to join their swarms as well.</p>
<div class="row">
<div class="span6 columns">
<h5>Method</h5>
</div>
<div class="span6 columns">
<h5>Description</h5>
</div>
</div>
<div class="page-header"></div><!-- send-->
<div class="row">
<div class="span6 columns">
<a href="restful_invitations.html#send">Send (POST)</a>
</div>
<div class="span10 columns">
<p>Send an invitation to another user's resource to join
your swarm.</p>
</div>
</div>
<div class="page-header"></div><!-- respond-->
<div class="row">
<div class="span6 columns">
<a href="restful_invitations.html#respond">Respond
(PUT)</a>
</div>
<div class="span10 columns">
<p>Respond to received invitations by either accepting or
rejecting them.</p>
</div>
</div>
<div class="page-header"></div><!-- list sent-->
<div class="row">
<div class="span6 columns">
<a href="restful_invitations.html#list-sent">List Sent
(GET)</a>
</div>
<div class="span10 columns">
<p>List all the invitations sent from your user account for
resources to join a given swarm.</p>
</div>
</div>
<div class="page-header"></div><!-- list received-->
<div class="row">
<div class="span6 columns">
<a href="restful_invitations.html#list-received">List
Received (GET)</a>
</div>
<div class="span10 columns">
<p>List the invitations received by your user account from
other users. List all invitations or only those sent to
specific resources.</p>
</div>
</div>
<div class="page-header"></div>
</div>
</body>
</html>