Files

T

john-okeefe c4607cd9b5 docs(api): complete backend documentation with all missing endpoints

Complete API documentation audit covering all backend endpoints.

Auth Endpoints:
- Fixed endpoint paths from /api/users/me/* to /api/auth/*
- Added update_email.md and update_username.md

Device Management:
- Device shelf operations (add, get, remove, clear)
- Device CRUD operations (update, delete)
- Registration management (pending, approve, reject)

Books Operations:
- Bulk delete and bulk update with normalization
- Download endpoint with format-specific headers

Conflict Resolution:
- Complete conflict management (list, get, resolve, delete)
- Bulk operations (bulk resolve, bulk dismiss, dismiss all)

Sync Protocols:
- KOReader: progress, metadata, library, bookmarks
- Kobo: markup, bookmarks, analytics, initialization, server sync

Scanner:
- Enhanced docs with manga/comic support
- Added 148-line comprehensive overview
- All formats documented (ebooks, comics, manga)

WebSocket:
- Comprehensive real-time sync API
- Messages, topics, authentication, examples

Documentation:
- Updated api-reference.md with all 122+ endpoints
- Updated index.md with new categories

Total: 36 new files, 6 modified files, 100% coverage

2026-02-08 12:39:46 -05:00

1.4 KiB

Raw Blame History

Start Watch Mode

Start watch mode for a library to automatically detect and process new/modified files. Supports ebook, manga, and comic libraries with real-time file system monitoring.

Endpoint: POST /api/scanner/watch/start Auth: Required (Admin only) Content-Type: application/json

Request Body

Field	Type	Required	Description
library_id	string (UUID)	Yes	Library UUID to watch (supports ebooks, manga, and comics)

Watch Mode Features

Watch mode automatically detects and processes:

New files added to library folders
Modified files that have been updated
Format-specific metadata extraction for comics (.cbz, .cbr) and manga
ComicInfo.xml parsing for comic archives
Image-based manga processing for individual page files

Example Request

{
  "library_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response (200 OK)

{
  "message": "Watch mode started successfully",
  "library_id": "uuid",
  "status": "watching"
}

Error Responses

Code	Description
400	Invalid request data
401	Invalid or expired token
403	User does not have admin privileges
404	Library not found
409	Watch mode already active for this library

1.4 KiB Raw Blame History