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
70 lines
1.7 KiB
Markdown
70 lines
1.7 KiB
Markdown
# Get Scan Status
|
|
|
|
Get the status of a specific scan job.
|
|
|
|
**Endpoint**: `GET /api/scanner/status/:jobId`
|
|
**Auth**: Required (Admin only)
|
|
|
|
## Path Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ------------- | -------- | ------------- |
|
|
| jobId | string (UUID) | Yes | Scan job UUID |
|
|
|
|
## Request Headers
|
|
|
|
| Header | Type | Required | Description |
|
|
| ------------- | ------ | -------- | ----------------------------------- |
|
|
| Authorization | string | Yes | Bearer token (must have admin role) |
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
GET /api/scanner/status/550e8400-e29b-41d4-a716-446655440000
|
|
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"job_id": "uuid",
|
|
"library_id": "uuid",
|
|
"status": "in_progress",
|
|
"started_at": "2026-02-08T10:00:00Z",
|
|
"updated_at": "2026-02-08T10:05:00Z",
|
|
"progress": {
|
|
"total_files": 1523,
|
|
"scanned_files": 850,
|
|
"added_files": 125,
|
|
"updated_files": 45,
|
|
"failed_files": 3,
|
|
"percentage": 55.8
|
|
},
|
|
"errors": [
|
|
{
|
|
"file_path": "/path/to/file.epub",
|
|
"error": "Invalid EPUB format"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## Status Values
|
|
|
|
| Status | Description |
|
|
| ----------- | -------------------------- |
|
|
| pending | Job is queued |
|
|
| in_progress | Job is currently running |
|
|
| completed | Job completed successfully |
|
|
| failed | Job failed with errors |
|
|
| cancelled | Job was cancelled |
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
| ---- | ----------------------------------- |
|
|
| 401 | Invalid or expired token |
|
|
| 403 | User does not have admin privileges |
|
|
| 404 | Job not found |
|