john-okeefe
b44e4e4709
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.
51 lines
1.3 KiB
Markdown
51 lines
1.3 KiB
Markdown
# Start Scanner
|
|
|
|
Start the automated background scanner for a library. Supports ebook, manga, and comic libraries.
|
|
|
|
**Endpoint**: `POST /api/scanner/start`
|
|
**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) |
|
|
| interval_seconds | integer | No | Scan interval in seconds (default: 3600, min: 300) |
|
|
|
|
## Supported Library Types
|
|
|
|
- **Ebooks:** Processes .epub, .pdf, .mobi, and other ebook formats
|
|
- **Comics:** Processes comic archives (.cbz, .cbr, .cb7, .cbt) with metadata extraction
|
|
- **Manga:** Processes manga archives and image files (.cbz, .cbr, .png, .jpg, etc.)
|
|
|
|
### Example Request
|
|
|
|
```json
|
|
{
|
|
"library_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"interval_seconds": 3600
|
|
}
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"message": "Scanner started successfully",
|
|
"library_id": "uuid",
|
|
"interval_seconds": 3600,
|
|
"status": "running"
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
|------|-------------|
|
|
| 400 | Invalid request data or interval too low |
|
|
| 401 | Invalid or expired token |
|
|
| 403 | User does not have admin privileges |
|
|
| 404 | Library not found |
|
|
| 409 | Scanner already running for this library |
|