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
023cae3f
Commit
023cae3f
authored
Aug 31, 2023
by
Alejandro Celaya
Committed by
Alejandro Celaya
Sep 01, 2023
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add comments which help understand Annotation vs APIAnnotationData types
parent
0ae2b78f
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
8 additions
and
0 deletions
+8
-0
api.ts
src/types/api.ts
+8
-0
No files found.
src/types/api.ts
View file @
023cae3f
...
...
@@ -158,6 +158,10 @@ export type UserInfo = {
display_name
:
string
|
null
;
};
/**
* Represents an annotation as returned by the h API.
* API docs: https://h.readthedocs.io/en/latest/api-reference/#tag/annotations
*/
export
type
APIAnnotationData
=
{
/**
* The server-assigned ID for the annotation. This is only set once the
...
...
@@ -211,6 +215,10 @@ export type APIAnnotationData = {
user_info
?:
UserInfo
;
};
/**
* Augmented annotation including what's returned by `h` API + client-internal
* properties
*/
export
type
Annotation
=
ClientAnnotationData
&
APIAnnotationData
;
/**
...
...
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