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

docs: remove Phase X placeholders from API documentation

Browse Source 
Clean up API documentation files by removing Phase X references:

Remove 'API Explorer will be inserted here in Phase X' placeholders from:
- 70+ API endpoint documentation files
- Authentication endpoints (login, logout, register, refresh)
- User endpoints (profile, settings, password)
- Device endpoints (registration, sync, shelves)
- Library endpoints (CRUD, folders, visibility)
- Media endpoints (items, progress, highlights, notes)
- Admin endpoints (users, analytics)
- Sync endpoints (Kobo, KOReader)
- OPDS endpoints
- Scanner endpoints
- Queue endpoints

These placeholders were from planning documents and have no meaning
to API consumers. The documentation is now clean and ready for use.
This commit is contained in:
john-okeefe
2026-02-13 21:50:44 -05:00
parent 2706ae52c1
commit b44e4e4709
108 changed files with 0 additions and 432 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/developer/api/admin/list_users.md
-4
View File
@@ -76,7 +76,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/admin/update_user_max_devices.md
-4
View File
@@ -47,7 +47,3 @@ Update the maximum number of devices a user can register (admin only).
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | User not found | | 404 | User not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/analytics/get_analytics.md
-4
View File
@@ -43,7 +43,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 400 | Invalid date format | | 400 | Invalid date format |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/authentication/login.md
-4
View File
@@ -43,7 +43,3 @@ Authenticate with email and password.
|------|-------------| |------|-------------|
| 401 | Invalid email or password | | 401 | Invalid email or password |
| 400 | Missing required fields | | 400 | Missing required fields |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/authentication/logout.md
-4
View File
@@ -29,7 +29,3 @@ No response body.
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | Token already invalidated | | 403 | Token already invalidated |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/authentication/refresh_token.md
-4
View File
@@ -35,7 +35,3 @@ Obtain a new JWT token using a refresh token.
|------|-------------| |------|-------------|
| 401 | Invalid or expired refresh token | | 401 | Invalid or expired refresh token |
| 400 | Missing refresh token | | 400 | Missing refresh token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/authentication/register.md
-4
View File
@@ -51,7 +51,3 @@ Create a new user account.
|------|-------------| |------|-------------|
| 400 | Invalid email format, weak password, or missing fields | | 400 | Invalid email format, weak password, or missing fields |
| 409 | Email or username already exists | | 409 | Email or username already exists |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/auto_link_books.md
-4
View File
@@ -46,7 +46,3 @@ Automatically link books to media items based on matching metadata.
| 400 | Invalid request data | | 400 | Invalid request data |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/bulk_link_books.md
-4
View File
@@ -55,7 +55,3 @@ Each link object contains:
| 400 | Invalid request data | | 400 | Invalid request data |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device, book, or media item not found | | 404 | Device, book, or media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/create_device_file_alias.md
-4
View File
@@ -51,7 +51,3 @@ Create a new file alias for a device.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device or media item not found | | 404 | Device or media item not found |
| 409 | File alias already exists | | 409 | File alias already exists |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/delete_device_file_alias.md
-4
View File
@@ -35,7 +35,3 @@ File alias deleted successfully.
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device or file alias not found | | 404 | Device or file alias not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/get_book_matches.md
-4
View File
@@ -50,7 +50,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 400 | Missing required query parameter | | 400 | Missing required query parameter |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/get_device_file_aliases.md
-4
View File
@@ -48,7 +48,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/get_unlinked_book_suggestions.md
-4
View File
@@ -65,7 +65,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/get_unlinked_books.md
-4
View File
@@ -56,7 +56,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/link_book.md
-4
View File
@@ -86,7 +86,3 @@ Link a device book to a Bookhoard media item. Supports bulk linking.
| 400 | Invalid link data | | 400 | Invalid link data |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/search_books.md
-4
View File
@@ -50,7 +50,3 @@ Query books to find potential matches for linking.
|------|-------------| |------|-------------|
| 400 | Invalid query parameters | | 400 | Invalid query parameters |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/book-matching/update_device_file_alias.md
-4
View File
@@ -49,7 +49,3 @@ Update an existing device file alias.
| 400 | Invalid request data | | 400 | Invalid request data |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device or file alias not found | | 404 | Device or file alias not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/conflicts/bulk_dismiss_conflicts.md
-4
View File
@@ -38,7 +38,3 @@ Dismiss multiple conflicts at once.
|------|-------------| |------|-------------|
| 400 | Invalid request body | | 400 | Invalid request body |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/conflicts/bulk_resolve_conflicts.md
-4
View File
@@ -42,7 +42,3 @@ Resolve multiple conflicts at once using a specified strategy.
| 400 | Invalid request body | | 400 | Invalid request body |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 400 | Invalid resolution strategy | | 400 | Invalid resolution strategy |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/conflicts/delete_conflict.md
-4
View File
@@ -34,7 +34,3 @@ Conflict deleted successfully.
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Conflict not found | | 404 | Conflict not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/conflicts/dismiss_all_resolved.md
-4
View File
@@ -32,7 +32,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| Code | Description | | Code | Description |
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/conflicts/get_conflict.md
-4
View File
@@ -73,7 +73,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Conflict not found | | 404 | Conflict not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/conflicts/list_conflicts.md
-4
View File
@@ -63,7 +63,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| Code | Description | | Code | Description |
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/conflicts/resolve_conflict.md
-4
View File
@@ -44,7 +44,3 @@ Resolve a specific conflict by choosing which version to keep.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Conflict not found | | 404 | Conflict not found |
| 400 | Conflict already resolved | | 400 | Conflict already resolved |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/add_to_shelf.md
-4
View File
@@ -44,7 +44,3 @@ Add a media item to a device's shelf (Kobo reading shelf).
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device or media item not found | | 404 | Device or media item not found |
| 409 | Item already on shelf | | 409 | Item already on shelf |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/approve_device_registration.md
-4
View File
@@ -44,7 +44,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Registration not found | | 404 | Registration not found |
| 400 | Registration already processed | | 400 | Registration already processed |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/clear_shelf.md
-4
View File
@@ -34,7 +34,3 @@ Shelf cleared successfully.
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/delete_device.md
-4
View File
@@ -35,7 +35,3 @@ Device deleted successfully.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | Device does not belong to user | | 403 | Device does not belong to user |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/get_devices.md
-4
View File
@@ -56,7 +56,3 @@ Check device registration status or get device details.
|------|-------------| |------|-------------|
| 401 | Invalid or expired token (for device details) | | 401 | Invalid or expired token (for device details) |
| 404 | Device or registration not found | | 404 | Device or registration not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/get_shelf.md
-4
View File
@@ -48,7 +48,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/list_devices.md
-4
View File
@@ -42,7 +42,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| Code | Description | | Code | Description |
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/list_pending_registrations.md
-4
View File
@@ -41,7 +41,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/register_device.md
-4
View File
@@ -42,7 +42,3 @@ Register a new device for sync.
|------|-------------| |------|-------------|
| 400 | Invalid device data | | 400 | Invalid device data |
| 409 | Device already registered | | 409 | Device already registered |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/reject_device_registration.md
-4
View File
@@ -40,7 +40,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Registration not found | | 404 | Registration not found |
| 400 | Registration already processed | | 400 | Registration already processed |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/remove_from_shelf.md
-4
View File
@@ -37,7 +37,3 @@ Item removed from shelf successfully.
| 400 | Invalid request data | | 400 | Invalid request data |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device or shelf item not found | | 404 | Device or shelf item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/revoke_device.md
-4
View File
@@ -35,7 +35,3 @@ Device revoked successfully.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not own this device | | 403 | User does not own this device |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/devices/update_device.md
-4
View File
@@ -50,7 +50,3 @@ Update a device's information.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | Device does not belong to user | | 403 | Device does not belong to user |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/highlights/create_highlight.md
-4
View File
@@ -60,7 +60,3 @@ Create a new highlight for a media item.
| 400 | Invalid highlight data | | 400 | Invalid highlight data |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/highlights/delete_highlight.md
-4
View File
@@ -35,7 +35,3 @@ Highlight deleted successfully.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not own this highlight | | 403 | User does not own this highlight |
| 404 | Highlight not found | | 404 | Highlight not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/highlights/get_highlights.md
-4
View File
@@ -55,7 +55,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/highlights/update_highlight.md
-4
View File
@@ -49,7 +49,3 @@ Update an existing highlight.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not own this highlight | | 403 | User does not own this highlight |
| 404 | Highlight not found | | 404 | Highlight not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/kobo/analytics_gettests.md
-4
View File
@@ -40,7 +40,3 @@ This endpoint requires device authentication (not user JWT). This is a Kobo comp
## Notes ## Notes
This is a Kobo compatibility endpoint used by Kobo devices for analytics purposes. The exact request/response format follows Kobo's proprietary protocol. This is a Kobo compatibility endpoint used by Kobo devices for analytics purposes. The exact request/response format follows Kobo's proprietary protocol.
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/kobo/bookmark_sync.md
-4
View File
@@ -57,7 +57,3 @@ This endpoint requires device authentication (not user JWT). Kobo devices authen
| 401 | Device authentication failed | | 401 | Device authentication failed |
| 400 | Invalid request data | | 400 | Invalid request data |
| 404 | Device or book not found | | 404 | Device or book not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/kobo/initialization.md
-4
View File
@@ -47,7 +47,3 @@ X-Device-Key: device-auth-key
## Notes ## Notes
This endpoint is called by Kobo devices during initial setup and connection. It returns configuration data required for proper Kobo integration. This endpoint is called by Kobo devices during initial setup and connection. It returns configuration data required for proper Kobo integration.
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/kobo/markup_sync.md
-4
View File
@@ -65,7 +65,3 @@ This endpoint requires device authentication (not user JWT). Kobo devices authen
| 401 | Device authentication failed | | 401 | Device authentication failed |
| 400 | Invalid request data | | 400 | Invalid request data |
| 404 | Device or book not found | | 404 | Device or book not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/kobo/sync_from_server.md
-4
View File
@@ -61,7 +61,3 @@ This endpoint requires device authentication (not user JWT). Kobo devices authen
## Notes ## Notes
This endpoint pushes library content from the server to the Kobo device. It's called during sync operations to update the device's library catalog. This endpoint pushes library content from the server to the Kobo device. It's called during sync operations to update the device's library catalog.
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/koreader/get_library.md
-4
View File
@@ -47,7 +47,3 @@ X-Device-Key: device-auth-key
|------|-------------| |------|-------------|
| 401 | Device authentication failed | | 401 | Device authentication failed |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/koreader/get_metadata.md
-4
View File
@@ -49,7 +49,3 @@ X-Device-Key: device-auth-key
|------|-------------| |------|-------------|
| 401 | Device authentication failed | | 401 | Device authentication failed |
| 404 | Book or device not found | | 404 | Book or device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/koreader/sync_bookmarks.md
-4
View File
@@ -65,7 +65,3 @@ This endpoint requires device authentication (not user JWT). Devices authenticat
| 401 | Device authentication failed | | 401 | Device authentication failed |
| 400 | Invalid request data | | 400 | Invalid request data |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/koreader/sync_progress.md
-4
View File
@@ -61,7 +61,3 @@ This endpoint requires device authentication (not user JWT). Devices authenticat
| 401 | Device authentication failed | | 401 | Device authentication failed |
| 400 | Invalid request data | | 400 | Invalid request data |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/libraries/add_library_folder.md
-4
View File
@@ -45,7 +45,3 @@ Add a folder to an existing library (Admin only).
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User is not an admin | | 403 | User is not an admin |
| 404 | Library not found | | 404 | Library not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/libraries/create_library.md
-4
View File
@@ -43,7 +43,3 @@ Create a new library (Admin only).
| 400 | Invalid input data | | 400 | Invalid input data |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User is not an admin | | 403 | User is not an admin |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/libraries/delete_library.md
-4
View File
@@ -35,7 +35,3 @@ Library deleted successfully.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Library not found | | 404 | Library not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/libraries/delete_library_folder.md
-4
View File
@@ -38,7 +38,3 @@ Library folder deleted successfully.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Library or folder not found | | 404 | Library or folder not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/libraries/get_library.md
-4
View File
@@ -49,7 +49,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have access to this library | | 403 | User does not have access to this library |
| 404 | Library not found | | 404 | Library not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/libraries/get_library_media_items.md
-4
View File
@@ -59,7 +59,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Library not found | | 404 | Library not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/libraries/get_library_stats.md
-4
View File
@@ -48,7 +48,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Library not found | | 404 | Library not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/libraries/get_visible_libraries.md
-4
View File
@@ -39,7 +39,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| Code | Description | | Code | Description |
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/libraries/set_library_visibility.md
-4
View File
@@ -42,7 +42,3 @@ Set library visibility for a specific user (Admin only).
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User is not an admin | | 403 | User is not an admin |
| 404 | User or library not found | | 404 | User or library not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/libraries/update_library.md
-4
View File
@@ -48,7 +48,3 @@ Update a library's information.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Library not found | | 404 | Library not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/create_media_item.md
-4
View File
@@ -117,7 +117,3 @@ POST /api/libraries/{library_id}/folders
"folder_path": "/path/to/library/folder" "folder_path": "/path/to/library/folder"
} }
``` ```
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/delete_media_item.md
-4
View File
@@ -35,7 +35,3 @@ Media item deleted successfully.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User is not an admin | | 403 | User is not an admin |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/filter_sort_media_items.md
-4
View File
@@ -61,7 +61,3 @@ Filter and sort media items with advanced criteria.
| 400 | Invalid filter parameters | | 400 | Invalid filter parameters |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have access to this library | | 403 | User does not have access to this library |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/get_media_item.md
-4
View File
@@ -58,7 +58,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have access to this media item | | 403 | User does not have access to this media item |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/list_media_items.md
-4
View File
@@ -65,7 +65,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 400 | Invalid query parameters | | 400 | Invalid query parameters |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have access to this library | | 403 | User does not have access to this library |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/search_media_items.md
-4
View File
@@ -55,7 +55,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 400 | Invalid search query (too short) | | 400 | Invalid search query (too short) |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/media-items/update_media_item.md
-4
View File
@@ -64,7 +64,3 @@ Update media item metadata (Admin only).
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User is not an admin | | 403 | User is not an admin |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/notes/create_note.md
-4
View File
@@ -54,7 +54,3 @@ Create a new note for a media item.
| 400 | Invalid note data | | 400 | Invalid note data |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/notes/delete_note.md
-4
View File
@@ -35,7 +35,3 @@ Note deleted successfully.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not own this note | | 403 | User does not own this note |
| 404 | Note not found | | 404 | Note not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/notes/get_notes.md
-4
View File
@@ -52,7 +52,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/notes/update_note.md
-4
View File
@@ -49,7 +49,3 @@ Update an existing note.
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not own this note | | 403 | User does not own this note |
| 404 | Note not found | | 404 | Note not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/opds/acquisition.md
-4
View File
@@ -66,7 +66,3 @@ GET /opds/devices/kobo-id/formats/uuid-123
] ]
} }
``` ```
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/opds/feeds.md
-4
View File
@@ -75,7 +75,3 @@ GET /opds/devices/kobo-id/search?q=Hobbit
### Response (200 OK - OPDS 1.2 XML with search results) ### Response (200 OK - OPDS 1.2 XML with search results)
Returns OPDS feed with matching books. Returns OPDS feed with matching books.
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/opds/publication.md
-4
View File
@@ -50,7 +50,3 @@ GET /opds/devices/kobo-id/shelves/Favorites
### Response (200 OK - OPDS 1.2 XML) ### Response (200 OK - OPDS 1.2 XML)
Returns OPDS feed with books on the specified device shelf. Returns OPDS feed with books on the specified device shelf.
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/progress/delete_progress.md
-4
View File
@@ -34,7 +34,3 @@ Progress deleted successfully.
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/progress/get_progress.md
-4
View File
@@ -50,7 +50,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/progress/get_progress_history.md
-4
View File
@@ -67,7 +67,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/progress/get_universal_progress.md
-4
View File
@@ -48,7 +48,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/progress/update_progress.md
-4
View File
@@ -66,7 +66,3 @@ Update reading progress for a media item. This will sync across all devices via
| 400 | Invalid location data | | 400 | Invalid location data |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/progress/update_universal_progress.md
-4
View File
@@ -54,7 +54,3 @@ Update universal reading progress for a media item.
| 400 | Invalid request data | | 400 | Invalid request data |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/queue/clear_device_queue.md
-4
View File
@@ -34,7 +34,3 @@ Device queue cleared successfully.
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/queue/delete_queue_item.md
-4
View File
@@ -34,7 +34,3 @@ Queue item deleted successfully.
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Queue item not found | | 404 | Queue item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/queue/get_device_queue_stats.md
-4
View File
@@ -42,7 +42,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/queue/list_all_queue_items.md
-4
View File
@@ -56,7 +56,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/queue/list_device_queue_items.md
-4
View File
@@ -59,7 +59,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Device not found | | 404 | Device not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/queue/retry_queue_item.md
-4
View File
@@ -40,7 +40,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Queue item not found | | 404 | Queue item not found |
| 400 | Item cannot be retried (not in failed state) | | 400 | Item cannot be retried (not in failed state) |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/ratings/create_rating.md
-4
View File
@@ -46,7 +46,3 @@ Set a rating for a media item. Creates a new rating or updates an existing one.
| 400 | Invalid rating (must be 1-10) | | 400 | Invalid rating (must be 1-10) |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found | | 404 | Media item not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/ratings/delete_rating.md
-4
View File
@@ -32,7 +32,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item or rating not found | | 404 | Media item or rating not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/ratings/get_ratings.md
-4
View File
@@ -42,7 +42,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|------|-------------| |------|-------------|
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item not found or no rating set | | 404 | Media item not found or no rating set |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/ratings/update_rating.md
-4
View File
@@ -51,7 +51,3 @@ Update an existing rating for a media item.
| 400 | Invalid request data | | 400 | Invalid request data |
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 404 | Media item or rating not found | | 404 | Media item or rating not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/get_scan_status.md
-4
View File
@@ -67,7 +67,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Job not found | | 404 | Job not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/get_watch_mode_status.md
-4
View File
@@ -60,7 +60,3 @@ Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Library not found | | 404 | Library not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/scan_library.md
-4
View File
@@ -53,7 +53,3 @@ The scanner automatically detects and processes files based on the library type:
| 401 | Invalid or expired token | | 401 | Invalid or expired token |
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Library not found | | 404 | Library not found |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/start_scanner.md
-4
View File
@@ -48,7 +48,3 @@ Start the automated background scanner for a library. Supports ebook, manga, and
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Library not found | | 404 | Library not found |
| 409 | Scanner already running for this library | | 409 | Scanner already running for this library |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/start_watch_mode.md
-4
View File
@@ -48,7 +48,3 @@ Watch mode automatically detects and processes:
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Library not found | | 404 | Library not found |
| 409 | Watch mode already active for this library | | 409 | Watch mode already active for this library |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/stop_scanner.md
-4
View File
@@ -39,7 +39,3 @@ Stop the automated background scanner for a library.
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Library not found | | 404 | Library not found |
| 400 | Scanner not running for this library | | 400 | Scanner not running for this library |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/scanner/stop_watch_mode.md
-4
View File
@@ -39,7 +39,3 @@ Stop watch mode for a library.
| 403 | User does not have admin privileges | | 403 | User does not have admin privileges |
| 404 | Library not found | | 404 | Library not found |
| 400 | Watch mode not active for this library | | 400 | Watch mode not active for this library |
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/sync/kobo-protocol.md
-4
View File
@@ -97,7 +97,3 @@ Authorization: Bearer device-token
] ]
} }
``` ```
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->
docs/developer/api/sync/koreader-protocol.md
-4
View File
@@ -119,7 +119,3 @@ Authorization: Bearer device-token
"last_sync": "2026-01-30T20:00:00Z" "last_sync": "2026-01-30T20:00:00Z"
} }
``` ```
## Try It Out
<!-- API Explorer will be inserted here in Phase 3 -->

Some files were not shown because too many files have changed in this diff Show More