Files

T

john-okeefe b44e4e4709 docs: remove Phase X placeholders from API documentation

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.

2026-02-13 21:50:44 -05:00

1.3 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.3 KiB Raw Blame History