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
1.6 KiB
1.6 KiB
Get Watch Mode Status
Get the watch mode status for a library.
Endpoint: GET /api/scanner/watch/status
Auth: Required (Admin only)
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| library_id | string (UUID) | Yes | Library UUID to check |
Request Headers
| Header | Type | Required | Description |
|---|---|---|---|
| Authorization | string | Yes | Bearer token (must have admin role) |
Example Request
GET /api/scanner/watch/status?library_id=550e8400-e29b-41d4-a716-446655440000
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
Response (200 OK)
{
"library_id": "uuid",
"status": "watching",
"started_at": "2026-02-08T10:00:00Z",
"watched_folders": ["/path/to/library/folder1", "/path/to/library/folder2"],
"stats": {
"files_detected": 15,
"files_processed": 12,
"files_failed": 1,
"last_activity": "2026-02-08T11:30:00Z"
}
}
Status Values
| Status | Description |
|---|---|
| watching | Watch mode is active |
| stopped | Watch mode is not active |
| error | Watch mode encountered an error |
Error Responses
| Code | Description |
|---|---|
| 400 | Missing library_id parameter |
| 401 | Invalid or expired token |
| 403 | User does not have admin privileges |
| 404 | Library not found |