1.8.0 Release

funmaker · Sep 27, 2023 · 1bb93c5 · 1bb93c5
1 parent a6508c0
commit 1bb93c5
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/API.md b/API.md
@@ -64,6 +64,7 @@ Fetches post details by given `id`.
 | tags      | object                          | Post's tags(keys are the names, values are their global usage).                                                                                         |
 | sources   | string[]                        | List of source urls.                                                                                                                                    |
 | relations | [PostRelation](#PostRelation)[] | List of post relations.                                                                                                                                 |
+| notes     | [PostNote](#PostNote)[]         | List of post notes.                                                                                                                                     |
 
 ### PostRelation
 
@@ -73,6 +74,18 @@ Same as [PostSummary](#PostSummary) with additional fields:
 |------|--------|-------------------------------------------------------------------------------------------------------------|
 | kind | string | `"DUPLICATE"`(duplicate), `"DUPLICATE_BEST"`(better quality duplicate), `"ALTERNATE"`(related alternative), |
 
+### PostNote
+
+| Name        | Type           | Comment                                                                                             |
+|-------------|----------------|-----------------------------------------------------------------------------------------------------|
+| label       | string or null | Title of the note.                                                                                  |
+| note        | string         | Text content of the note.                                                                           |
+| rect        | object or null | Optional positional information about the note. [Learn More](README.md#translationoverlay-notes)    |
+| rect.top    | object or null | Vertical offset of the note from the top of the image, in percents relative to image height.        |
+| rect.left   | object or null | Horizontal offset of the note from the left side of the image, in percents relative to image width. |
+| rect.width  | object or null | Width of the note from the top of the image, in percents relative to image width.                   |
+| rect.height | object or null | Height of the note from the top of the image, in percents relative to image height.                 |
+
 
 ## GET /api/tags
 

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
 	"name": "hybooru",
 	"description": "Hydrus-based booru-styled imageboard in React",
-	"version": "1.8.0-dev",
+	"version": "1.8.0",
 	"engines": {
 		"node": ">=14.0.0",
 		"npm": ">=7.0.0"