Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
C
coopwire-hypothesis
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
孙灵跃 Leon Sun
coopwire-hypothesis
Commits
7bb6b70a
Commit
7bb6b70a
authored
Apr 07, 2021
by
Robert Knight
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add notes about use of annotation targets in h to `Target` docs
parent
d9085810
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
9 additions
and
4 deletions
+9
-4
api.js
src/types/api.js
+9
-4
No files found.
src/types/api.js
View file @
7bb6b70a
...
@@ -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
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment