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
# Get Book Matches
|
|
|
|
Get potential book matches for a given query.
|
|
|
|
**Endpoint**: `GET /api/books/match`
|
|
**Auth**: Required
|
|
|
|
## Query Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ------- | -------- | ------------------------------------------------- |
|
|
| q | string | Yes | Search query (title, author, etc.) |
|
|
| limit | integer | No | Maximum number of matches to return (default: 10) |
|
|
|
|
## Request Headers
|
|
|
|
| Header | Type | Required | Description |
|
|
| ------------- | ------ | -------- | ------------ |
|
|
| Authorization | string | Yes | Bearer token |
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
GET /api/books/match?q=Foundation+Asimov&limit=5
|
|
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"matches": [
|
|
{
|
|
"id": "uuid",
|
|
"title": "Foundation",
|
|
"authors": ["Isaac Asimov"],
|
|
"isbn": "978-0553293357",
|
|
"published_year": 1951,
|
|
"publisher": "Bantam Books",
|
|
"cover_url": "https://example.com/cover.jpg"
|
|
}
|
|
],
|
|
"total": 5
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
| ---- | -------------------------------- |
|
|
| 400 | Missing required query parameter |
|
|
| 401 | Invalid or expired token |
|