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
68 lines
2.0 KiB
Markdown
68 lines
2.0 KiB
Markdown
# Sync Bookmarks
|
|
|
|
Sync bookmarks from KOReader device.
|
|
|
|
**Endpoint**: `POST /api/sync/koreader/bookmarks`
|
|
**Auth**: Required (Device authentication)
|
|
|
|
## Device Authentication
|
|
|
|
This endpoint requires device authentication (not user JWT). Devices authenticate using their device credentials.
|
|
|
|
## Request Body
|
|
|
|
| Field | Type | Required | Description |
|
|
| --------- | ------------- | -------- | ------------------------- |
|
|
| device_id | string (UUID) | Yes | Device UUID |
|
|
| bookmarks | array | Yes | Array of bookmark objects |
|
|
|
|
### Bookmark Object
|
|
|
|
| Field | Type | Required | Description |
|
|
| ---------------- | ------- | -------- | -------------------------- |
|
|
| book | string | Yes | Book identifier |
|
|
| chapter | string | No | Chapter title |
|
|
| page | integer | No | Page number |
|
|
| position | float | Yes | Position in document (0-1) |
|
|
| notes | string | No | Bookmark notes |
|
|
| highlighted_text | string | No | Highlighted text |
|
|
| time | string | Yes | ISO 8601 timestamp |
|
|
| created_at | string | Yes | ISO 8601 timestamp |
|
|
|
|
### Example Request
|
|
|
|
```json
|
|
{
|
|
"device_id": "550e8400-e29b-41d4-a716-446655440000",
|
|
"bookmarks": [
|
|
{
|
|
"book": "book.epub",
|
|
"chapter": "Chapter 1",
|
|
"page": 25,
|
|
"position": 0.125,
|
|
"notes": "Important section",
|
|
"highlighted_text": "Text to remember",
|
|
"time": "2026-02-08T10:00:00Z",
|
|
"created_at": "2026-02-08T10:00:00Z"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"message": "Bookmarks synced successfully",
|
|
"synced_count": 1
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
| ---- | ---------------------------- |
|
|
| 401 | Device authentication failed |
|
|
| 400 | Invalid request data |
|
|
| 404 | Device not found |
|