Commit 7bb6b70a authored by Robert Knight's avatar Robert Knight

Add notes about use of annotation targets in h to `Target` docs

parent d9085810
...@@ -34,10 +34,13 @@ ...@@ -34,10 +34,13 @@
*/ */
/** /**
* @typedef Target * An entry in the `target` field of an annotation which identifies the document
* @prop {string} source * and region of the document that it refers to.
* @prop {Selector[]} [selector]
* *
* @typedef Target
* @prop {string} source - URI of the document
* @prop {Selector[]} [selector] - Region of the document
*/
/** /**
* TODO - Fill out remaining properties * TODO - Fill out remaining properties
...@@ -68,7 +71,9 @@ ...@@ -68,7 +71,9 @@
* @prop {string[]} permissions.update * @prop {string[]} permissions.update
* @prop {string[]} permissions.delete * @prop {string[]} permissions.delete
* *
* @prop {Target[]} target * @prop {Target[]} target - Which document and region this annotation refers to.
* The Hypothesis API structure allows for multiple targets, but the current
* h server only allows for one target per annotation.
* *
* @prop {Object} [moderation] * @prop {Object} [moderation]
* @prop {number} moderation.flagCount * @prop {number} moderation.flagCount
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment