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
53 lines
1.3 KiB
Markdown
53 lines
1.3 KiB
Markdown
# Search Books for Matching
|
|
|
|
Query books to find potential matches for linking.
|
|
|
|
**Endpoint**: `POST /api/sync/books/query`
|
|
**Auth**: Required
|
|
**Content-Type**: `application/json`
|
|
|
|
## Request Body
|
|
|
|
| Field | Type | Required | Description |
|
|
| ----------- | ------- | -------- | -------------------------------- |
|
|
| identifiers | array | No | List of identifiers (ISBN, UUID) |
|
|
| sha256 | string | No | SHA256 hash of book file |
|
|
| title | string | No | Book title |
|
|
| author | string | No | Book author |
|
|
| file_size | integer | No | File size in bytes |
|
|
|
|
### Example Request
|
|
|
|
```json
|
|
{
|
|
"identifiers": ["isbn:978-0345391802", "uuid:abc-123"],
|
|
"sha256": "a1b2c3d4e5f6abc123...",
|
|
"title": "The Hobbit",
|
|
"author": "J.R.R. Tolkien",
|
|
"file_size": 2456789
|
|
}
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"matches": [
|
|
{
|
|
"media_item_id": "uuid-123",
|
|
"bookhoard_uuid": "uuid-123",
|
|
"confidence": 1.0,
|
|
"match_method": "uuid_match"
|
|
}
|
|
],
|
|
"action": "auto_link"
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
| ---- | ------------------------ |
|
|
| 400 | Invalid query parameters |
|
|
| 401 | Invalid or expired token |
|