This repository has been archived by the owner on Apr 6, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 16
/
apiary.apib
635 lines (491 loc) · 17.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
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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
FORMAT: 1A
HOST: https://api.crick.io/
# Crick API
This document describes the Crick.io API.
# Group Crick API for Web
This is the Crick API for the main Crick.io web application.
The authentication layer uses Auth0 with a JSON Web Token.
## Users [/users]
This endpoint allows to manage Crick users.
It requires a `Authorization` header with a `Bearer` JSON Web Token,
otherwise the response will be a `401 Unauthorized`.
### Get users [GET /users{?q}]
This endpoint returns at most `LimitUsersToReturn` (`10` currently) users.
+ Parameters
+ q: `johndoe` (string, optional) - A string to autocomplete on login.
+ Request
+ Headers
Accept: application/json
Authorization: Bearer <Auth0 JWT token>
+ Response 200 (application/json)
{
"users": [
{
"id": "44178b45-0646-4b1e-84f6-ca6a5d7ba2bb",
"login": "johndoe",
"avatar_url": "https://bitbucket.org/account/johndoe/avatar/32/"
}
]
}
### Get current user's profile [GET /users/me]
+ Request
+ Headers
Accept: application/json
Authorization: Bearer <Auth0 JWT token>
+ Response 200 (application/json)
{
"id": "15178b45-0646-4b1e-84f6-ca6a5d7ba2bb",
"login": "willdurand",
"token": "xyz==",
"avatar_url": "https://bitbucket.org/account/willdurand/avatar/32/"
}
+ Response 401 (application/json)
{
"detail": "Malformed JWT token (claims)",
"title": "Unauthorized"
}
+ Response 401 (application/json)
{
"detail": "User not found",
"title": "Unauthorized"
}
## Projects [/projects]
This endpoint allows to manage Crick projects, scoped by user.
It requires a `Authorization` header with a `Bearer` JSON Web Token,
otherwise the response will be a `401 Unauthorized`.
### Retrieve all user's projects [GET]
+ Request
+ Headers
Accept: application/json
Authorization: Bearer <Auth0 JWT token>
+ Response 200 (application/json)
{
"projects": [
{
"id": "26fb1e8c-b559-4d6e-a9a7-e9092ac5fb38",
"name": "project 1"
},
{
"id": "142d08ac-8244-4b43-b04a-4d0c18a93a6e",
"name": "project 2"
}
]
}
+ Response 401 (application/json)
{
"detail": "User not found",
"title": "Unauthorized"
}
## Frames [/frames]
This endpoint allows to manage Crick frames, scoped by user.
It requires a `Authorization` header with a `Bearer` JSON Web Token,
otherwise the response will be a `401 Unauthorized`.
### Retrieve frames [GET /frames{?page,limit,from,to,tags,projectId,projects,teamId}]
The response must contain two root keys: `meta` and `frames`.
#### Pagination
This endpoint supports **pagination**, hence the presence of a `page` meta
object with the following attributes:
* `prev` is the previous page number (omitted if the current page is also the
first page);
* `next` is the next page number (omitted if the current page is also the last
page);
* `count` is the number of objects in total for the given request. It is not
the number of individual objects that are returned in each page but the number
of all individual objects;
* `limit` is the number of individual objects that are returned in each page.
Note that this is an upper limit. If there are not enough objects remaining
in the list of data, then fewer will be returned.
#### About `projectId` and `projects`
The parameters `projectId` and `projects` are mutually exclusive. If you add
both in the request, you will get a `400` error.
#### About `tags` and `projects`
The parameters `tags` and `projects` expect a comma-separated list of string
values. All extra spaces between these values will be trimed.
#### About `projectId` and `teamId`
The parameters `projectId` and `teamId` expect a UUID as value. The API will
return a `404` error if the project or the team does not exist.
+ Parameters
+ page: `2` (optional, integer) - The page to retrieve
+ Default: `1`
+ limit: `20` (optional, integer) - The number of frames to return (max)
+ Default: `50`
+ from: `2017-01-01` (optional, date) - Used to return frames after this date
+ to: `2017-01-01` (optional, date) - Used to return frames until this date
+ tags: `email,sprint-4` (optional, string) - A comma-separated list of tags
+ projectId: `5b37098a-c971-4956-92a3-5a81fc0b342b` (optional, UUID) - A project ID to only get the frames of this project
+ projects: `world-domination-plan,perso` (optional, string) - A comma-separated list of project names
+ teamId: `5b37098a-c971-4956-92a3-5a81fc0b342b` (optional, UUID) - A team ID to only get the frames of this team
+ Request without any parameters
+ Headers
Accept: application/json
Authorization: Bearer <Auth0 JWT token>
+ Response 200 (application/json)
{
"meta": {
"page": {
"prev": 1,
"next": 3,
"count": 140,
"limit": 50
}
},
"frames": [
{
"id": "5b37098a-c971-4956-92a3-5a81fc0b342b",
"start_at": "2016-10-21T09:43:36Z",
"end_at": "2016-10-21T12:03:47Z",
"project": "project 1",
"tags": ["tag1", "tag 2"]
},
{
"id": "5b37098a-c971-4956-92a3-5a81fc0b3aaa",
"start_at": "2016-10-22T09:43:36Z",
"end_at": "2016-10-22T12:03:47Z",
"project": "project 1",
"tags": []
}
]
}
+ Response 400 (application/json)
{
"detail": "Invalid request",
"title": "Bad Request"
}
+ Response 401 (application/json)
{
"detail": "User not found",
"title": "Unauthorized"
}
+ Request with `projects`
+ Headers
Accept: application/json
Authorization: Bearer <Auth0 JWT token>
+ Response 200 (application/json)
{
"meta": {
"projects": [
{
"id": "26fb1e8c-b559-4d6e-a9a7-e9092ac5fb38",
"name": "project-1"
},
{
"id": "26fb1e8c-b559-aaaa-bbbb-e9092ac5fb38",
"name": "project-3"
}
],
"page": {
"prev": 1,
"next": 3,
"count": 140,
"limit": 50
}
},
"frames": [
{
"id": "5b37098a-c971-4956-92a3-5a81fc0b342b",
"start_at": "2016-10-21T09:43:36Z",
"end_at": "2016-10-21T12:03:47Z",
"project": "project 1",
"tags": ["tag1", "tag 2"]
},
{
"id": "5b37098a-c971-4956-92a3-5a81fc0b3aaa",
"start_at": "2016-10-22T09:43:36Z",
"end_at": "2016-10-22T12:03:47Z",
"project": "project 3",
"tags": []
}
]
}
+ Request with `projectId`
+ Headers
Accept: application/json
Authorization: Bearer <Auth0 JWT token>
+ Response 200 (application/json)
{
"meta": {
"project": {
"id": "26fb1e8c-b559-4d6e-a9a7-e9092ac5fb38",
"name": "project-1"
},
"page": {
"prev": 1,
"next": 3,
"count": 140,
"limit": 50
}
},
"frames": [
{
"id": "5b37098a-c971-4956-92a3-5a81fc0b342b",
"start_at": "2016-10-21T09:43:36Z",
"end_at": "2016-10-21T12:03:47Z",
"project": "project 1",
"tags": ["tag1", "tag 2"]
},
{
"id": "5b37098a-c971-4956-92a3-5a81fc0b3aaa",
"start_at": "2016-10-22T09:43:36Z",
"end_at": "2016-10-22T12:03:47Z",
"project": "project 1",
"tags": []
}
]
}
## Teams [/teams]
This endpoint allows to manage Crick teams, scoped by user.
It requires a `Authorization` header with a `Bearer` JSON Web Token,
otherwise the response will be a `401 Unauthorized`.
### List all user's teams [GET]
+ Request
+ Headers
Accept: application/json
Authorization: Bearer <Auth0 JWT token>
+ Response 200 (application/json)
{
"teams": [
{
"id": "26fb1e8c-b559-4d6e-a9a7-e9092ac5fb38",
"name": "Team TailorDev",
"projects": [
"crick",
"watson"
],
"users": [
{
"id": "15178b45-0646-4b1e-84f6-ca6a5d7ba2bb",
"login": "willdurand",
"avatar_url": "https://bitbucket.org/account/willdurand/avatar/32/"
},
{
"id": "15178b45-0646-4b1e-84f6-ca6a5d7battt",
"login": "jmaupetit",
"avatar_url": "https://bitbucket.org/account/jmaupetit/avatar/32/"
}
]
},
{
"id": "142d08ac-8244-4b43-b04a-4d0c18a93a6e",
"name": "Team Rocket",
"projects": [],
"users": [
{
"id": "15178b45-0646-4b1e-84f6-ca6a5d7ba2bb",
"login": "willdurand",
"avatar_url": "https://bitbucket.org/account/willdurand/avatar/32/"
}
]
}
]
}
### Create a team [POST]
+ Request
+ Headers
Accept: application/json
Content-type: application/json
Authorization: Bearer <Auth0 JWT token>
+ Body
{
"name": "My Team Name",
"user_ids": [
"15178b45-0646-4b1e-84f6-ca6a5d7battt"
],
"projects": [
"that-project"
]
}
+ Response 201 (application/json)
{
"id": "26fb1e8c-xxxx-yyyy-a9a7-e9092ac5fb38"
}
+ Response 400 (application/json)
{
"detail": "Invalid request",
"title": "Bad Request"
}
+ Response 401 (application/json)
{
"detail": "User not found",
"title": "Unauthorized"
}
### Update a team [PUT /teams/{id}]
+ Parameters
+ id: `26fb1e8c-xxxx-yyyy-a9a7-e9092ac5fb38` (UUID) - ID of the team
+ Request
+ Headers
Accept: application/json
Content-type: application/json
Authorization: Bearer <Auth0 JWT token>
+ Body
{
"id": "26fb1e8c-xxxx-yyyy-a9a7-e9092ac5fb38",
"name": "My team name",
"user_ids": [
"15178b45-0646-4b1e-84f6-ca6a5d7battt"
],
"projects": [
"that-project",
"yet-another-project"
]
}
+ Response 200 (application/json)
{
"id": "26fb1e8c-xxxx-yyyy-a9a7-e9092ac5fb38",
"name": "My team name",
"users": [
{
"id": "15178b45-0646-4b1e-84f6-ca6a5d7battt",
"login": "willdurand",
"avatar_url": "https://bitbucket.org/account/willdurand/avatar/32/"
}
],
"projects": [
"that-project",
"yet-another-project"
]
}
+ Response 400 (application/json)
{
"detail": "Invalid request",
"title": "Bad Request"
}
+ Response 401 (application/json)
{
"detail": "User not found",
"title": "Unauthorized"
}
+ Response 403 (application/json)
{
"detail": "Not allowed",
"title": "Forbidden"
}
+ Response 404 (application/json)
{
"detail": "Team not found",
"title": "Not Found"
}
### Delete a team [DELETE /teams/{id}]
+ Parameters
+ id: `26fb1e8c-xxxx-yyyy-a9a7-e9092ac5fb38` (UUID) - ID of the team
+ Request
+ Headers
Accept: application/json
Authorization: Bearer <Auth0 JWT token>
+ Response 204 (application/json)
+ Response 400 (application/json)
{
"detail": "Invalid request",
"title": "Bad Request"
}
+ Response 401 (application/json)
{
"detail": "User not found",
"title": "Unauthorized"
}
+ Response 403 (application/json)
{
"detail": "Not allowed",
"title": "Forbidden"
}
+ Response 404 (application/json)
{
"detail": "Team not found",
"title": "Not Found"
}
# Group Crick API for Watson
This is the Crick API used by Watson. The authentication layer uses
a API token, generated by Crick.
## Projects [/watson/projects]
This endpoint requires a `Authorization` header with a `Token` API token,
otherwise the response will be a `401 Unauthorized`.
### Retrieve all user's projects [GET]
+ Request
+ Headers
Accept: application/json
Authorization: Token <API token>
+ Response 200 (application/json)
{
"projects": [
{
"id": "26fb1e8c-b559-4d6e-a9a7-e9092ac5fb38",
"name": "project 1"
},
{
"id": "142d08ac-8244-4b43-b04a-4d0c18a93a6e",
"name": "project 2"
}
]
}
+ Response 400 (application/json)
{
"detail": "Invalid or missing Authorization header",
"title": "Bad Request"
}
+ Response 401 (application/json)
{
"detail": "User not found",
"title": "Unauthorized"
}
## Frames [/watson/frames{?last_sync}]
This endpoint requires a `Authorization` header with a `Token` API token,
otherwise the response will be a `401 Unauthorized`.
+ Parameters
+ last_sync: `2006-01-02T15:04:05-07:00` (date, optional) - Watson last sync date.
### Retrieve all user's frames [GET]
+ Request
+ Headers
Accept: application/json
Authorization: Token <API token>
+ Response 200 (application/json)
{
"frames": [
{
"id": "5b37098a-c971-4956-92a3-5a81fc0b342b",
"start_at": "2016-10-21T09:43:36Z",
"end_at": "2016-10-21T12:03:47Z",
"project": "project 1",
"tags": ["tag1", "tag 2"]
},
{
"id": "5b37098a-c971-4956-92a3-5a81fc0b3aaa",
"start_at": "2016-10-22T09:43:36Z",
"end_at": "2016-10-22T12:03:47Z",
"project": "project 1",
"tags": []
}
]
}
+ Response 400 (application/json)
{
"detail": "Invalid or missing Authorization header",
"title": "Bad Request"
}
+ Response 401 (application/json)
{
"detail": "User not found",
"title": "Unauthorized"
}
### Push (not yet synchronized) user's frames [POST /watson/frames/bulk]
+ Request
+ Headers
Accept: application/json
Content-type: application/json
Authorization: Token <API token>
+ Body
[
{
"id": "5b37098a-c971-4956-92a3-5a81fc0b3qqq",
"start_at": "2017-10-21T09:43:36Z",
"end_at": "2017-10-21T12:03:47Z",
"project": "project 2",
"tags": ["tag XYZ"]
},
{
"id": "5b37098a-c971-4956-92a3-5a81fc0b3zzz",
"start_at": "2017-10-22T09:43:36Z",
"end_at": "2017-10-22T12:03:47Z",
"project": "project 1",
"tags": []
}
]
+ Response 201