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

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, .azw, .azw3, .txt, .rtf, .doc, .docx, .lit, .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",
  "recursive": true,
  "force": false
}

Response (202 Accepted)

{
  "message": "Scan initiated successfully",
  "job_id": "uuid",
  "library_id": "uuid",
  "status": "pending"
}

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