docs(media-items,collections,koreader,admin): Beam batch 11 — final backfill
All remaining endpoint docs frontmatter'd: media-item bulk ops + audio surface, collections book-listing/preview, koreader rating/review/stats plugin protocol, hash-conflicts JSON list. Scope call (Claude): resolve_hash_conflict.md DELETED — the resolve POST renders an htmx fragment (renderResolved), a web-admin flow under rule 3; only the GET list is a JSON API. update_media_review skipped by Beam (correct): ratings/upsert_media_review.md already covers the PUT. Registry: 16 entries. koreader rating/review/stats all bind koreaderBookRef (query or body) — odd=half-star rating scale; audio track endpoint serves raw bytes (ServeContent, Range) — response nil. Fixed drift: deleted_annotations doc's secondary restore/purge fences unlabeled (gate validates labeled blocks against the ONE frontmatter route); chapters example labeled. UNVERIFIED: 1 (koreader book-ref fields, push_stats). make test 9/9.
This commit is contained in:
1 parent
18084de7a6
commit
e21e1facde
17 files changed
+515
-6
No files matched your search
@@ -1,3 +1,11 @@
|
||||
---
|
||||
method: POST
|
||||
path: /api/media-items/bulk-delete
|
||||
auth: jwt
|
||||
area: media-items
|
||||
---
|
||||
<!-- source: internal/handlers/media.go:448 MediaHandler.HandleBulkDelete -->
|
||||
|
||||
# Bulk Delete Media Items
|
||||
|
||||
Delete multiple media items at once (supports ebooks, comics, manga).
|
||||
@@ -14,7 +22,7 @@ Delete multiple media items at once (supports ebooks, comics, manga).
|
||||
|
||||
### Example Request
|
||||
|
||||
```json
|
||||
```json example-request
|
||||
{
|
||||
"media_item_ids": [
|
||||
"550e8400-e29b-41d4-a716-446655440001",
|
||||
@@ -26,7 +34,7 @@ Delete multiple media items at once (supports ebooks, comics, manga).
|
||||
|
||||
## Response (200 OK)
|
||||
|
||||
```json
|
||||
```json example-response
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
---
|
||||
method: POST
|
||||
path: /api/media-items/bulk-update
|
||||
auth: jwt
|
||||
area: media-items
|
||||
---
|
||||
<!-- source: internal/handlers/media.go:540 MediaHandler.HandleBulkUpdate -->
|
||||
|
||||
# Bulk Update Media Items
|
||||
|
||||
Update multiple media items at once (supports ebooks, comics, manga).
|
||||
@@ -26,7 +34,7 @@ Update multiple media items at once (supports ebooks, comics, manga).
|
||||
|
||||
### Example Request
|
||||
|
||||
```json
|
||||
```json example-request
|
||||
{
|
||||
"media_item_updates": [
|
||||
{
|
||||
@@ -50,7 +58,7 @@ Update multiple media items at once (supports ebooks, comics, manga).
|
||||
|
||||
## Response (200 OK)
|
||||
|
||||
```json
|
||||
```json example-response
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
---
|
||||
method: GET
|
||||
path: /api/media-items/:id/annotations/deleted
|
||||
auth: jwt
|
||||
area: media-items
|
||||
---
|
||||
<!-- source: internal/handlers/annotation_history.go:61 MediaHandler.GetDeletedAnnotations -->
|
||||
|
||||
# Deleted Annotations History
|
||||
|
||||
List, restore, or permanently delete tombstoned annotations (highlights,
|
||||
@@ -18,7 +26,7 @@ Returns tombstoned annotations for the book, newest deletion first.
|
||||
|
||||
### Response (200 OK)
|
||||
|
||||
```json
|
||||
```json example-response
|
||||
{
|
||||
"deleted_annotations": [
|
||||
{
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
---
|
||||
method: GET
|
||||
path: /api/media-items/:id/chapters
|
||||
auth: jwt
|
||||
area: media-items
|
||||
---
|
||||
<!-- source: internal/handlers/media.go:2947 MediaHandler.GetAudioChapters -->
|
||||
|
||||
# Get Audio Chapters
|
||||
|
||||
The format-abstraction chapter list for audiobooks, sourced from
|
||||
@@ -11,7 +19,7 @@ which file model produced them.
|
||||
|
||||
## Response
|
||||
|
||||
```json
|
||||
```json example-response
|
||||
{
|
||||
"media_item_id": "…",
|
||||
"chapters": [
|
||||
|
||||
@@ -1,3 +1,11 @@
|
||||
---
|
||||
method: GET
|
||||
path: /api/media-items/:id/audio/:trackIndex
|
||||
auth: jwt
|
||||
area: media-items
|
||||
---
|
||||
<!-- source: internal/handlers/media.go:3088 MediaHandler.GetAudioTrack -->
|
||||
|
||||
# Get Audio Track
|
||||
|
||||
Streams one playable track of a multi-file audiobook (folder-of-tracks
|
||||
|
||||
Reference in new issue
Block a user