-
Notifications
You must be signed in to change notification settings - Fork 0
/
apiary.apib
317 lines (241 loc) · 10.2 KB
/
apiary.apib
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
FORMAT: 1A
HOST: http://www.google.com
# MR. FOGG
Descripcion de MR. FOGG (TODO)
# Group Authentication
## Login [/login]
### Login into the application [POST]
+ Request (application/json)
{
"email": "[email protected]",
"password": "secret"
}
+ Response 200 (application/json)
{ "token": "9ae355fb-c3ff-4f36-9b8a-b64cdd513d68" }
## Logout [/logout]
### Login into the application [POST]
+ Response 204
## Register [/register]
+ Request (application/json)
{
"email": "[email protected]",
"password": "secret"
}
+ Response 204
# Group Users API
## Users [/users]
### List all users [GET]
+ Response 200 (application/json)
[{ "id": 1, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/3f98f26534b1ef1012596da615661867" },
{ "id": 2, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/59d33ac8915ede62376b0986224d17bd" },
{ "id": 3, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/c84bc865eabadfa8fcf29dbc4a11af30" },
{ "id": 4, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/c84bc865eabadfa8fcf29dbc4a11af30" },
{ "id": 5, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/c84bc865eabadfa8fcf29dbc4a11af30" },
{ "id": 6, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/c84bc865eabadfa8fcf29dbc4a11af30" }]
## Current user detail [/users/me]
### Retrieve the user details [GET]
+ Response 200 (application/json)
{ "id": 3, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/c84bc865eabadfa8fcf29dbc4a11af30" }
## User detail [/users/{userId}]
### Retrieve the user details [GET]
+ Parameters
+ userId (required, number, `1`) ... User id
+ Response 200 (application/json)
{ "id": 1, "email": "[email protected]", "avatar": "http://gravatar.com/alotor" }
# Group Trip API
## Trips [/trips]
### Retrieve trips for the current user [GET]
+ Response 200 (application/json)
[
{ "id": 1, "name": "Viaje a Londres" },
{ "id": 2, "name": "Verano 2014" },
{ "id": 3, "name": "Fin de semana en la playa" }
]
### Creates a new trip [POST]
+ Request (application/json)
{
"name": "Viaje a Londres",
"description": "Nos vamos de viaje con motivo del GGX lo vamos a pasar mu bien!!"
}
+ Response 200 (application/json)
{
"id": 1,
"name": "Viaje a Londres",
"description": "Nos vamos de viaje con motivo del GGX lo vamos a pasar mu bien!!",
"members": [
{ "id": 1, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/3f98f26534b1ef1012596da615661867" }
]
}
## Trips Detail [/trips/{tripId}]
### Retrieve the trip details [GET]
+ Parameters
+ tripId (required, number, `1`) ... Trip id
+ Response 200 (application/json)
{
"id": 1,
"name": "Viaje a Londres",
"description": "Nos vamos de viaje con motivo del GGX lo vamos a pasar mu bien!!",
"members": [
{ "id": 1, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/3f98f26534b1ef1012596da615661867" },
{ "id": 2, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/59d33ac8915ede62376b0986224d17bd" },
{ "id": 3, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/c84bc865eabadfa8fcf29dbc4a11af30" },
{ "id": 4, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/c84bc865eabadfa8fcf29dbc4a11af30" },
{ "id": 5, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/c84bc865eabadfa8fcf29dbc4a11af30" },
{ "id": 6, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/c84bc865eabadfa8fcf29dbc4a11af30" }
]
}
### Modify the trip details [PUT]
+ Parameters
+ tripId (required, number, `1`) ... Trip id
+ Response 200 (application/json)
{
"name": "Viaje a Londres (2013/12/11)",
"description": "Nueva descripción"
}
+ Response 204
## Add user to trip [/trips/{tripId}/addUser/{userId}]
### Add user to a trip [POST]
+ Parameters
+ tripId (required, number, `1`) ... Trip id
+ userId (required, number, `1`) ... User id to add
+ Response 204
## Add list of users to trip [/trips/{tripId}/addUsers]
### Add a list of users to a trip [PUT]
+ Parameters
+ tripId (required, number, `1`) ... Trip id
+ Request (application/json)
+ Response 200 (application/json)
[
{ "id": 1, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/3f98f26534b1ef1012596da615661867" },
{ "id": 2, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/59d33ac8915ede62376b0986224d17bd" },
{ "id": 3, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/c84bc865eabadfa8fcf29dbc4a11af30" },
{ "id": 4, "email": "[email protected]", "avatar": "http://www.gravatar.com/avatar/c84bc865eabadfa8fcf29dbc4a11af30" }
]
## Tasks [/trips/{tripId}/tasks]
### Retrieve the tasks for a trip [GET]
+ Parameters
+ tripId (required, number, `1`) ... Trip id
+ Response 200 (application/json)
[
{ "id": 1, "name": "Comprar billetes", "status": "pending" },
{ "id": 2, "name": "Escoger hotel", "status": "done" }
]
### Creates a new task inside a trip [POST]
+ Parameters
+ tripId (required, number, `1`) ... Trip id
+ Request (application/json)
{
"name": "Comprar billentes"
}
+ Response 200 (application/json)
{
"id": 1,
"name": "Comprar billentes",
"status": "pending"
}
# Group Tasks API
## Task detail [/trips/{tripId}/tasks/{taskId}]
### Update task information [PUT]
+ Parameters
+ tripId (required, number, `1`) ... Trip id
+ taskId (required, number, `1`) ... Task id
+ Request (application/json)
{ "name": "Comprar los billetes de avión", "status": "done" }
+ Response 204
# Group Cards API
## Cards [/trips/{tripId}/tasks/{taskId}/cards]
### Retrieve the cards for a defined task [GET]
+ Parameters
+ tripId (required, number, `1`) ... Trip id
+ taskId (required, number, `1`) ... Task id
+ Response 200 (application/json)
[
{
"id": 1,
"title": "Encuesta de bares",
"dateCreated": "2013-12-18T15:55:00.245Z",
"description": "LoremBacon ipsum dolor sit amet ground round filet mignon pig pork chop, short loin frankfurter venison.",
"owner": {
"id": 1,
"email": "[email protected]",
"avatar": "http://gravatar.com/alotor"
},
"widget": {
"model": "/widget/images/10001",
"template": "/assets/client/mrfogg-widget-images.html"
},
"comments": [
{ "user": { "id": 1, "email": "[email protected]", "avatar": "http://gravatar.com/alotor" }, "text": "Lorem ipsum", "dateCreated": "2013-12-18T15:55:00.245Z" },
{ "user": { "id": 2, "email": "[email protected]", "avatar": "http://gravatar.com/ramiro" }, "text": "Lorem ipsum", "dateCreated": "2013-12-18T15:55:00.245Z" }
]
},
{
"id": 2,
"title": "Mapa de la zona centro",
"dateCreated": "2013-12-18T15:55:00.245Z",
"description": "Mapa de la zona centro",
"owner": {
"id": 1,
"email": "[email protected]",
"avatar": "http://gravatar.com/alotor"
},
"widget": {
"model": "/widget/images/10001",
"template": "http://localhost:8080/assets/client/mrfogg-widget-images.html"
},
"comments": []
}
]
### Create a new card inside the task [POST]
+ Parameters
+ tripId (required, number, `1`) ... Trip id
+ taskId (required, number, `1`) ... Task id
+ Request (application/json)
{
"title": "Encuesta de bares",
"description": "LoremBacon ipsum dolor sit amet ground round filet mignon pig pork chop, short loin frankfurter venison.",
"widget": {
"model": "/widget/images/10001",
"template": "/assets/client/mrfogg-widget-images.html"
}
}
+ Response 200 (application/json)
{
"id": 1,
"title": "Encuesta de bares",
"dateCreated": "2013-12-18T15:55:00.245Z",
"description": "LoremBacon ipsum dolor sit amet ground round filet mignon pig pork chop, short loin frankfurter venison.",
"owner": {
"id": 1,
"email": "[email protected]",
"avatar": "http://gravatar.com/alotor"
},
"widget": {
"id": "1001",
"type": "/widget/poll"
},
"comments": []
}
## Card detail [/trips/{tripId}/tasks/{taskId}/cards/{cardId}]
### Create a new card inside the task [GET]
+ Parameters
+ tripId (required, number, `1`) ... Trip id
+ taskId (required, number, `1`) ... Task id
+ cardId (required, number, `1`) ... Card id
+ Response 200 (application/json)
{
"id": 1,
"title": "Encuesta de bares",
"description": "LoremBacon ipsum dolor sit amet ground round filet mignon pig pork chop, short loin frankfurter venison.",
"owner": {
"id": 1,
"email": "[email protected]",
"avatar": "http://gravatar.com/alotor"
},
"widget": {
"id": "1001",
"type": "/widget/poll"
},
"comments": []
}