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.9 KiB

Raw Blame History

method, path, auth, area

method	path	auth	area
POST	/api/scanner/scan	jwt+admin	scanner

Scan Library

Initiate a one-time scan of a library for ebooks, manga, or comics.

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

Request Body

Field	Type	Required	Description
library_id	string (UUID)	Yes	Library UUID to scan (supports ebooks, manga, and comics)
recursive	boolean	No	Scan subdirectories recursively (default: true)
force	boolean	No	Force rescan of existing files (default: false)

Supported Formats

The scanner automatically detects and processes files based on the library type:

Ebooks: .epub, .pdf, .mobi, .txt, .rtf, .docx, .fb2, .pdb

Comics: .cbz, .cbr, .cb7, .cbt, .pdf

Manga: .cbz, .cbr, .png, .jpg, .jpeg, .gif, .bmp, .webp

Example Request

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

Response (202 Accepted)

{
  "message": "scan job enqueued",
  "job_id": "b3d3a0c2-8f4e-4c1d-9a2b-6e5f1a7c9d01",
  "status": "pending"
}

A scan for the same library already pending or running returns 409 with {"error": "a scan for this library is already pending or running", "active_job_id": "..."}.

Error Responses

Code	Description
400	Invalid request data
401	Invalid or expired token
403	User does not have admin privileges
404	Library not found

1.9 KiB Raw Blame History