john-okeefe
4d321528b2
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
56 lines
1.6 KiB
Markdown
56 lines
1.6 KiB
Markdown
# 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
|
|
|
|
```json
|
|
{
|
|
"library_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"recursive": true,
|
|
"force": false
|
|
}
|
|
```
|
|
|
|
## Response (202 Accepted)
|
|
|
|
```json
|
|
{
|
|
"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 |
|