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
61 lines
1.5 KiB
Markdown
61 lines
1.5 KiB
Markdown
# Sync From Server
|
|
|
|
Push content and metadata to Kobo device.
|
|
|
|
**Endpoint**: `POST /api/sync/kobo/sync-from-server`
|
|
**Auth**: Required (Device authentication)
|
|
|
|
## Device Authentication
|
|
|
|
This endpoint requires device authentication (not user JWT). Kobo devices authenticate using their device credentials and access tokens.
|
|
|
|
## Request Body
|
|
|
|
| Field | Type | Required | Description |
|
|
| --------- | --------------- | -------- | --------------------------------------------- |
|
|
| book_ids | array of string | No | Array of ContentIDs to sync |
|
|
| full_sync | boolean | No | Whether to perform full sync (default: false) |
|
|
|
|
### Example Request
|
|
|
|
```json
|
|
{
|
|
"book_ids": ["content-id-1", "content-id-2"],
|
|
"full_sync": false
|
|
}
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"books": [
|
|
{
|
|
"ContentID": "content-id-1",
|
|
"Title": "Book Title",
|
|
"Author": "Author Name",
|
|
"ISBN": "978-0123456789",
|
|
"PublicationDate": "2026-02-08",
|
|
"FileSize": 1234567,
|
|
"CoverImageId": "cover-id-1",
|
|
"Metadata": {
|
|
"language": "en",
|
|
"publisher": "Publisher Name"
|
|
}
|
|
}
|
|
],
|
|
"total": 2
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
| ---- | ---------------------------- |
|
|
| 401 | Device authentication failed |
|
|
| 404 | Device not found |
|
|
|
|
## Notes
|
|
|
|
This endpoint pushes library content from the server to the Kobo device. It's called during sync operations to update the device's library catalog.
|