-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathopenapi.yml
564 lines (536 loc) · 13 KB
/
openapi.yml
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
openapi: 3.0.3
info:
title: Mercury
version: 0.1.1
servers:
- url: http://localhost:8000
description: Local
paths:
/candidate_labels:
get:
summary: Get candidate labels
description: Get candidate labels for labeling
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/LabelMeta"
/user/me:
get:
summary: Get current user info
description: Get current user info
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/User"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
security:
- OAuth2: []
/user/name:
post:
summary: Update current user name
description: Update current user name
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
required: true
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RequestMessage"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
security:
- OAuth2: []
/user/export:
get:
summary: Export labels made by current user
description: Export labels made by current user
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/LabelData"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
security:
- OAuth2: []
/task:
get:
summary: Get task count
description: Get task count
responses:
"200":
description: OK
content:
application/json:
schema:
type: object
properties:
all:
type: integer
/task/{task_index}:
get:
summary: Get task info
description: Get task info
parameters:
- name: task_index
in: path
required: true
schema:
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
oneOf:
- $ref: "#/components/schemas/Task"
- $ref: "#/components/schemas/RequestError"
/task/{task_index}/history:
get:
summary: Get all labels made for a task
description: Get all labels made for a task
parameters:
- name: task_index
in: path
required: true
schema:
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/LabelData"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
security:
- OAuth2: []
/task/{task_index}/label:
post:
summary: Submit a label for a task
description: Submit a label for a task
parameters:
- name: task_index
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Label"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RequestMessage"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
security:
- OAuth2: []
/task/{task_index}/label/{record_id}:
patch:
summary: Edit a label for a task
description: Edit a label for a task
parameters:
- name: task_index
in: path
required: true
schema:
type: integer
- name: record_id
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Label"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RequestMessage"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
"403":
description: Not allowed to edit other's annotation
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
"404":
description: Annotation not found
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
security:
- OAuth2: []
/task/{task_index}/select:
post:
summary: Get AI prediction for a selected span
description: Get AI prediction for a selected span. Returns five possible spans.
parameters:
- name: task_index
in: path
required: true
schema:
type: integer
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Selection"
responses:
"200":
description: OK
content:
application/json:
schema:
oneOf:
- type: array
items:
$ref: "#/components/schemas/SelectionResponseSlice"
- $ref: "#/components/schemas/RequestError"
/annot/{annot_index}/comments:
parameters:
- name: annot_index
in: path
required: true
schema:
type: integer
get:
summary: Get all comments for a label
description: Get all comments for a label
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/Comment"
post:
summary: Submit a comment for a label
description: Submit a comment for a label
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CommentData"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RequestMessage"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
security:
- OAuth2: []
/annot/{annot_index}/comments/{comment_id}:
parameters:
- name: annot_index
in: path
required: true
schema:
type: integer
- name: comment_id
in: path
required: true
schema:
type: integer
patch:
summary: Edit a comment for a label
description: Edit a comment for a label
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/CommentData"
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RequestMessage"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
"403":
description: Not allowed to edit other's comment
security:
- OAuth2: []
delete:
summary: Delete a comment for a label
description: Delete a comment for a label
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RequestMessage"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
"403":
description: Not allowed to delete other's comment
security:
- OAuth2: []
/record/{record_id}:
delete:
summary: Delete a label
description: Delete a label
parameters:
- name: record_id
in: path
required: true
schema:
type: integer
responses:
"200":
description: OK
content:
application/json:
schema:
$ref: "#/components/schemas/RequestMessage"
"401":
description: Unauthorized
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
"403":
description: Not allowed to delete other's annotation
content:
application/json:
schema:
$ref: "#/components/schemas/HTTPException"
security:
- OAuth2: []
components:
securitySchemes:
OAuth2:
type: oauth2
flows:
password:
tokenUrl: /login
schemas:
HTTPException:
type: object
properties:
detail:
type: string
RequestMessage:
type: object
properties:
message:
type: string
RequestError:
type: object
properties:
error:
type: string
User:
type: object
properties:
id:
type: string
name:
type: string
email:
type: string
LabelMeta:
type: array
items:
oneOf:
- type: string
- type: object
properties:
LABEL:
type: array
items:
type: string
LabelData:
type: object
required:
- record_id
- sample_id
- summary_start
- summary_end
- source_start
- source_end
- consistent
- task_index
- user_id
- note
properties:
record_id:
type: integer
sample_id:
type: string
summary_start:
type: integer
summary_end:
type: integer
source_start:
type: integer
source_end:
type: integer
consistent:
type: array
items:
type: string
task_index:
type: integer
user_id:
type: string
note:
type: string
username:
type: string
Label:
type: object
properties:
summary_start:
type: integer
summary_end:
type: integer
source_start:
type: integer
source_end:
type: integer
consistent:
type: array
items:
type: string
note:
type: string
Task:
type: object
properties:
doc:
type: string
sum:
type: string
Selection:
type: object
properties:
start:
type: integer
end:
type: integer
from_summary:
type: boolean
SelectionResponseSlice:
type: object
properties:
score:
type: number
offset:
type: integer
len:
type: integer
to_doc:
type: boolean
Comment:
type: object
properties:
comment_id:
type: integer
user_id:
type: string
username:
type: string
annot_id:
type: integer
parent_id:
type: integer
nullable: true
text:
type: string
comment_time:
type: string
CommentData:
type: object
required:
- annot_id
- text
properties:
annot_id:
type: integer
parent_id:
type: integer
nullable: true
text:
type: string