Bookhoard/bookhoard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

docs(api): update existing documentation

Browse Source 
- 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:
john-okeefe
2026-02-08 13:33:12 -05:00
parent c437528522
commit a4314db2d7
3 changed files with 45 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/developer/api/books/bulk_update_books.md
+43 -18
View File
@@ -10,30 +10,47 @@ Update multiple media items at once.
| 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) |
### Update Fields
| Field | Type | Required | Description |
|--------|------|-----------|-------------|
| tags | array of strings | No | New tags (will replace existing) |
| contributors | array of strings | No | New contributors (will replace existing) |
| add_tags | array of strings | No | Tags to add to existing |
| remove_tags | array of strings | No | Tags to remove from existing |
| title | string | No | Updated title |
| author | string | No | Updated author |
| genre | string | No | Updated genre |
| 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
```json
{
"media_item_ids": [
"550e8400-e29b-41d4-a716-446655440001",
"660e8400-e29b-41d4-a716-446655440002"
],
"updates": {
"add_tags": ["science-fiction", "award-winner"],
"contributors": ["Publisher Name"]
}
"updates": [
{
"book_id": "550e8400-e29b-41d4-a716-446655440001",
"updates": {
"title": "Updated Title",
"genre": "Science Fiction",
"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
{
"message": "Books updated successfully",
"updated_count": 2,
"failed_count": 0,
"normalized_tags": ["Science-Fiction", "Award-Winner"],
"normalized_contributors": ["Publisher Name"]
"results": [
{
"book_id": "550e8400-e29b-41d4-a716-446655440001",
"success": true
},
{
"book_id": "660e8400-e29b-41d4-a716-446655440002",
"success": true
}
],
"total": 2,
"success": 2,
"failed": 0
}
```