Bookhoard/bookhoard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

docs: update cross-references from /api/books/ to /api/media-items/

Browse Source 
- Update api-reference.md with new endpoint paths
- Update api-reference.md Books API section → Media Items API section
- Update index.md Books API link → Media Items API
- Update get_shelf.md cover_url reference from /api/books/ to /api/media-items/
This commit is contained in:
john-okeefe
2026-02-10 19:59:12 -05:00
parent d4903feb71
commit 5f268238c8
3 changed files with 17 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/developer/api/api-reference.md
+3 -8
View File
@@ -73,14 +73,6 @@ See [Library Management](libraries/)
- GET /api/libraries/visibility - Get visible libraries - GET /api/libraries/visibility - Get visible libraries
- POST /api/libraries/visibility - Set library visibility - POST /api/libraries/visibility - Set library visibility
## Books
See [Book Operations](books/)
- POST /api/books/bulk-delete - Bulk delete books
- POST /api/books/bulk-update - Bulk update books (tags/contributors with normalization)
- GET /api/books/:uuid/download - Download book file
## Media Items ## Media Items
See [Media Item Operations](media-items/) See [Media Item Operations](media-items/)
@@ -88,6 +80,9 @@ See [Media Item Operations](media-items/)
- GET /api/media-items - List media items - GET /api/media-items - List media items
- GET /api/media-items/filtered - Filter and sort media items - GET /api/media-items/filtered - Filter and sort media items
- GET /api/media-items/:id - Get media item details - GET /api/media-items/:id - Get media item details
- POST /api/media-items/bulk-delete - Bulk delete media items
- POST /api/media-items/bulk-update - Bulk update media items (tags/contributors with normalization)
- GET /api/media-items/:uuid/download - Download media item file
- POST /api/media-items/:id/rating - Create rating - POST /api/media-items/:id/rating - Create rating
- GET /api/media-items/:id/rating - Get rating - GET /api/media-items/:id/rating - Get rating
- PUT /api/media-items/:id/rating - Update rating - PUT /api/media-items/:id/rating - Update rating
docs/developer/api/devices/get_shelf.md
+1 -1
View File
@@ -34,7 +34,7 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
"media_item_id": "uuid", "media_item_id": "uuid",
"title": "Book Title", "title": "Book Title",
"authors": ["Author Name"], "authors": ["Author Name"],
"cover_url": "/api/books/uuid/cover", "cover_url": "/api/media-items/uuid/cover",
"added_at": "2026-02-08T10:00:00Z" "added_at": "2026-02-08T10:00:00Z"
} }
], ],
docs/index.md
+13 -13
View File
@@ -27,19 +27,19 @@ Complete guide to Bookhoard documentation. Find what you need quickly.
**[Developer Documentation Portal](developer/development.md)** - Technical documentation & API reference **[Developer Documentation Portal](developer/development.md)** - Technical documentation & API reference
- **API Documentation** - **API Documentation**
- [Complete API Reference](developer/api-reference.md) - Monolithic REST API reference (1,300+ lines) - [Complete API Reference](developer/api-reference.md) - Monolithic REST API reference (1,300+ lines)
- [Split Endpoint Docs](developer/api/api-reference.md) - Individual endpoints with interactive API Explorer - [Split Endpoint Docs](developer/api/api-reference.md) - Individual endpoints with interactive API Explorer
- [Collections API](developer/collections-api.md) - Collections management API - [Collections API](developer/collections-api.md) - Collections management API
- [Admin API](developer/api/admin/) - User management (admin operations) - [Admin API](developer/api/admin/) - User management (admin operations)
- [Books API](developer/api/books/) - Bulk book operations and downloads - [Media Items API](developer/api/media-items/) - Media item operations including bulk operations and downloads
- [Devices API](developer/api/devices/) - Device sync and shelf management - [Devices API](developer/api/devices/) - Device sync and shelf management
- [Conflicts API](developer/api/conflicts/) - Sync conflict resolution endpoints - [Conflicts API](developer/api/conflicts/) - Sync conflict resolution endpoints
- [Queue API](developer/api/queue/) - Sync queue management endpoints - [Queue API](developer/api/queue/) - Sync queue management endpoints
- [Scanner API](developer/api/scanner/) - Library scanning and automated watch mode (admin) - [Scanner API](developer/api/scanner/) - Library scanning and automated watch mode (admin)
- [KOReader API](developer/api/koreader/) - KOReader sync protocol endpoints - [KOReader API](developer/api/koreader/) - KOReader sync protocol endpoints
- [Kobo API](developer/api/kobo/) - Kobo sync protocol endpoints - [Kobo API](developer/api/kobo/) - Kobo sync protocol endpoints
- [WebSocket API](developer/api/websocket/) - Real-time sync events - [WebSocket API](developer/api/websocket/) - Real-time sync events
- **Protocol Specifications** - **Protocol Specifications**
- [Kobo Sync Protocol](developer/api/sync/kobo-protocol.md) - Kobo device sync - [Kobo Sync Protocol](developer/api/sync/kobo-protocol.md) - Kobo device sync