-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.html
122 lines (121 loc) · 2.8 KB
/
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
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Forward Board</title>
</head>
<body>
<h2 id="api">API</h2>
<p><sub>Strikethrough</sub> indicates functionality not implemented yet</p>
<h3 id="api-1">/api/</h3>
<table>
<thead>
<tr class="header">
<th align="left">HTTP Method</th>
<th align="left">Action</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">GET</td>
<td align="left">retrieve this documentation</td>
</tr>
</tbody>
</table>
<h3 id="apibobs">/api/bobs</h3>
<table>
<thead>
<tr class="header">
<th align="left">HTTP Method</th>
<th align="left">Action</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">GET</td>
<td align="left">retrieve a list of bobs</td>
</tr>
<tr class="even">
<td align="left">POST</td>
<td align="left">create a new bob object</td>
</tr>
</tbody>
</table>
<h3 id="apibobsactive">/api/bobs/active</h3>
<table>
<thead>
<tr class="header">
<th align="left">HTTP Method</th>
<th align="left">Action</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">GET</td>
<td align="left">retrieve a list of active bobs (Date.now() is between date.start and date.end)</td>
</tr>
</tbody>
</table>
<h3 id="apibobsbobid">/api/bobs/bobID</h3>
<table>
<thead>
<tr class="header">
<th align="left">HTTP Method</th>
<th align="left">Action</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">GET</td>
<td align="left">retrieve bob object with id bobID</td>
</tr>
<tr class="even">
<td align="left">PUT</td>
<td align="left">update the bob object</td>
</tr>
<tr class="odd">
<td align="left">DELETE</td>
<td align="left">delete the bob object</td>
</tr>
</tbody>
</table>
<h3 id="apiflavors">/api/flavors</h3>
<table>
<thead>
<tr class="header">
<th align="left">HTTP Method</th>
<th align="left">Action</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">GET</td>
<td align="left">retrieve all flavors</td>
</tr>
<tr class="even">
<td align="left"><sub>POST</sub></td>
<td align="left">create a new flavor object</td>
</tr>
</tbody>
</table>
<h3 id="apiflavorsflavorid-flavorname">/api/flavors/[flavorID : flavorName]</h3>
<table>
<thead>
<tr class="header">
<th align="left">HTTP Method</th>
<th align="left">Action</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">GET</td>
<td align="left">retrieve a flavor object by name or id</td>
</tr>
<tr class="even">
<td align="left"><sub>PUT</sub></td>
<td align="left">update the flavor object</td>
</tr>
</tbody>
</table>
</body>
</html>