0 Fork 0

Files

T

John O'Keefe 2c56ae4b9d docs(scanner): Beam batch 7 — all 10 scanner endpoints backfilled

Scanner surface frontmatter'd (scan/start/stop/cancel/status/active/
active-summary + watch start/stop/status) with provenance comments;
active-summary on a non-admin group.

Claude registry: 10 entries. Fixed handler drift Beam missed: scan_library
request has no "recursive"; scanner/start binds folder_paths (not
invented interval_seconds); scanner/stop binds no body; response is
{message, job_id, status} with 409 coalescing variant
{error, active_job_id}.

Gate fix in drift_test seed: registerScannerRoutes group seeds used bare
"jwt"/"admin" tokens invisible to authLabel; and silently passed before
only because the seeded set was unchecked. Seeds now 'jwtMiddleware'/
'AdminMiddleware' markers. Also: cleanup of a stale-merge-script residue
in collections/update_rule.md example (extra null keys). make test 9/9.

2026-10-24 17:20:46 -04:00

1.7 KiB

Raw Blame History

method, path, auth, area

method	path	auth	area
POST	/api/scanner/watch/start	jwt+admin	scanner

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"
}

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