docs(api): update existing documentation

- Update api-reference.md with current endpoint list

- Update bulk_update_books.md with improved documentation

- Update scanner/overview.md to reference scan_library.md
This commit is contained in:
2026-02-08 13:33:12 -05:00
parent c437528522
commit a4314db2d7
3 changed files with 45 additions and 20 deletions
+1 -1
View File
@@ -200,7 +200,7 @@ See [Sync Queue](queue/)
See [Scanner Operations](scanner/) See [Scanner Operations](scanner/)
- [Scanner Overview](scanner/overview.md) - Supported formats, metadata extraction, and features - [Scanner Overview](scanner/overview.md) - Supported formats, metadata extraction, and features
- POST /api/scanner/scan - One-time library scan (ebooks, manga, comics) - POST /api/scanner/scan - Scan library (one-time) (ebooks, manga, comics)
- POST /api/scanner/start - Start automated scanner - POST /api/scanner/start - Start automated scanner
- POST /api/scanner/stop - Stop automated scanner - POST /api/scanner/stop - Stop automated scanner
- GET /api/scanner/status/:jobId - Get scan job status - GET /api/scanner/status/:jobId - Get scan job status
+43 -18
View File
@@ -10,30 +10,47 @@ Update multiple media items at once.
| Field | Type | Required | Description | | Field | Type | Required | Description |
|--------|------|-----------|-------------| |--------|------|-----------|-------------|
| media_item_ids | array of UUID | Yes | Array of media item UUIDs to update | | updates | array of objects | Yes | Array of update operations (see below) |
### Update Object
| Field | Type | Required | Description |
|--------|------|-----------|-------------|
| book_id | string (UUID) | Yes | Media item UUID to update |
| updates | object | Yes | Fields to update (see below) | | updates | object | Yes | Fields to update (see below) |
### Update Fields ### Update Fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
|--------|------|-----------|-------------| |--------|------|-----------|-------------|
| tags | array of strings | No | New tags (will replace existing) | | title | string | No | Updated title |
| contributors | array of strings | No | New contributors (will replace existing) | | author | string | No | Updated author |
| add_tags | array of strings | No | Tags to add to existing | | genre | string | No | Updated genre |
| remove_tags | array of strings | No | Tags to remove from existing | | language | string | No | Updated language |
| tags | array of strings | No | Updated tags (auto-normalized) |
| contributors | array of strings | No | Updated contributors (auto-normalized) |
### Example Request ### Example Request
```json ```json
{ {
"media_item_ids": [ "updates": [
"550e8400-e29b-41d4-a716-446655440001", {
"660e8400-e29b-41d4-a716-446655440002" "book_id": "550e8400-e29b-41d4-a716-446655440001",
], "updates": {
"updates": { "title": "Updated Title",
"add_tags": ["science-fiction", "award-winner"], "genre": "Science Fiction",
"contributors": ["Publisher Name"] "tags": ["science fiction", "non-fiction", "ACME CORP."]
} }
},
{
"book_id": "660e8400-e29b-41d4-a716-446655440002",
"updates": {
"author": "Updated Author",
"contributors": ["O'Reilly Media", "Penguin Random House"]
}
}
]
} }
``` ```
@@ -41,11 +58,19 @@ Update multiple media items at once.
```json ```json
{ {
"message": "Books updated successfully", "results": [
"updated_count": 2, {
"failed_count": 0, "book_id": "550e8400-e29b-41d4-a716-446655440001",
"normalized_tags": ["Science-Fiction", "Award-Winner"], "success": true
"normalized_contributors": ["Publisher Name"] },
{
"book_id": "660e8400-e29b-41d4-a716-446655440002",
"success": true
}
],
"total": 2,
"success": 2,
"failed": 0
} }
``` ```
+1 -1
View File
@@ -139,7 +139,7 @@ GET /api/scanner/status/550e8400-e29b-41d4-a716-446655440000
## Related Endpoints ## Related Endpoints
- [Scan Ebooks](scan_ebooks.md) - Manual one-time scan - [Scan Library](scan_library.md) - Manual one-time scan
- [Start Scanner](start_scanner.md) - Automated periodic scanning - [Start Scanner](start_scanner.md) - Automated periodic scanning
- [Stop Scanner](stop_scanner.md) - Stop automated scanner - [Stop Scanner](stop_scanner.md) - Stop automated scanner
- [Get Scan Status](get_scan_status.md) - Check scan progress - [Get Scan Status](get_scan_status.md) - Check scan progress