Files

T

john-okeefe 4d321528b2 docs: update comprehensive API documentation and project guides

This commit updates all documentation files throughout the project:

- Updated IMPLEMENTATION_PLAN.md with new implementation details
- Updated PROJECT_GUIDELINES.md with coding standards and practices
- Updated README.md with current project information
- Updated SCREENSHOT_AUTOMATION.md with new automation details
- Added TEST_DATA.md with test fixtures data
- Updated cover_image_serving_plan.md with static URL patterns

Documentation API updates:
- Updated API reference documentation for all endpoints including:
  - Authentication (login, logout, register, refresh_token)
  - Book matching (auto_link, bulk_link, link_book, search)
  - Collections (CRUD operations, shelf mappings, auto-assign rules)
  - Conflicts (bulk operations, resolve/dismiss)
  - Devices (registration, approval, shelf management)
  - Highlights (create, update, delete, get)
  - Kobo sync (bookmark, markup, initialization, sync)
  - KOReader sync (library, metadata, bookmarks, progress)
  - Libraries (CRUD, folders, media items, stats)
  - Media items (bulk operations, CRUD)
  - Notes (CRUD operations)
  - OPDS (acquisition, feeds, publication)
  - Progress (reading progress tracking)
  - Queue (device queue management)
  - Ratings (star ratings)
  - Scanner (watch mode, scan operations)
  - Sync protocols (Kobo, KOReader)
  - Users (profile, password, admin operations)
  - WebSocket protocols

- Updated user guides (admin, dashboard, settings, sync)
- Updated device setup guides (Kobo, KOReader)
- Updated developer guides (testing, contributing, operations)
- Updated scripts/README.md

2026-02-27 17:06:22 -05:00

1.6 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.6 KiB Raw Blame History