forked from 0x2620/pandora
add api docs
This commit is contained in:
parent
3a6c3338a2
commit
cf836ec172
4 changed files with 33 additions and 18 deletions
|
|
@ -162,8 +162,10 @@ def addAnnotation(request, data):
|
|||
}
|
||||
returns {
|
||||
id: string, // annotation id
|
||||
...
|
||||
... // more annotation properties
|
||||
}
|
||||
see: addAnnotation, editAnnotation, findAnnotations, getAnnotation,
|
||||
getTaskStatus, removeAnnotation
|
||||
'''
|
||||
for key in ('item', 'layer', 'in', 'out', 'value'):
|
||||
if key not in data:
|
||||
|
|
@ -213,13 +215,14 @@ def addAnnotations(request, data):
|
|||
out: float, // out point in seconds
|
||||
value: string // annotation value
|
||||
},
|
||||
...
|
||||
... // more annotations
|
||||
]
|
||||
}
|
||||
returns {
|
||||
taskId: string
|
||||
taskId: string // task id, use `getTaskStatus` to poll
|
||||
}
|
||||
FIXME: Explain what to do with task id
|
||||
see: addAnnotation, editAnnotation, findAnnotations, getAnnotation,
|
||||
getTaskStatus, removeAnnotation
|
||||
'''
|
||||
for key in ('item', 'layer', 'annotations'):
|
||||
if key not in data:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue