john-okeefe
253f56399d
BREAKING CHANGE: Documentation URLs have changed New structure: - user/ - End-user documentation (device setup, sync guides, frontend) - developer/ - Developer documentation (API reference, protocols, specs) - operations/ - Operations documentation (deployment, troubleshooting) - contributing/ - Contribution guides Changes: - Created portal INDEX.md files for each audience section - Moved device guides to user/devices/ (kobo-setup.md, koreader-setup.md) - Moved API docs to developer/ (api-reference.md, collections-api.md) - Moved sync guide to user/sync-guide.md - Moved troubleshooting to operations/troubleshooting.md - Moved all split API docs to developer/api/ - Renamed protocol files (kobo-protocol.md, koreader-protocol.md) - Added placeholder user guides (frontend, user-areas, settings, admin) - Updated all internal links to new paths - Updated Go code (http_handler.go, navigation.go) for new paths - Updated main INDEX.md for audience-based navigation Benefits: - Clear separation of user and developer documentation - Scalable structure for future user guide expansion - Better organization and discoverability - Audience-specific landing pages Related to DOCS_IMPLEMENTATION_PLAN.md Phase 2 completion
73 lines
1.8 KiB
Markdown
73 lines
1.8 KiB
Markdown
# Update Reading Progress
|
|
|
|
Update reading progress for a media item. This will sync across all devices via WebSocket.
|
|
|
|
**Endpoint**: `PUT /api/media-items/{media_id}/progress`
|
|
**Auth**: Required
|
|
**Content-Type**: `application/json`
|
|
|
|
## Path Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|-----------|------|-----------|-------------|
|
|
| media_id | string | Yes | Media item UUID |
|
|
|
|
## Request Body
|
|
|
|
| Field | Type | Required | Description |
|
|
|--------|------|-----------|-------------|
|
|
| source | string | Yes | Progress source (e.g., "web", "koreader", "kobo") |
|
|
| location | object | Yes | Location information |
|
|
| location.percentage | float | No | Progress percentage (0-1) |
|
|
| location.epubcfi | string | No | EPUB CFI location |
|
|
| location.character | integer | No | Character offset |
|
|
| location.chapter | integer | No | Chapter number |
|
|
| location.page | integer | No | Current page |
|
|
| location.total_pages | integer | No | Total pages |
|
|
| device_metadata | object | No | Device metadata |
|
|
| device_metadata.device_type | string | No | Device type |
|
|
| device_metadata.user_agent | string | No | User agent string |
|
|
|
|
### Example Request
|
|
|
|
```json
|
|
{
|
|
"source": "web",
|
|
"location": {
|
|
"percentage": 0.45678,
|
|
"epubcfi": "epubcfi(/6/4/2:15)",
|
|
"character": 15432,
|
|
"chapter": 3,
|
|
"page": 89,
|
|
"total_pages": 200
|
|
},
|
|
"device_metadata": {
|
|
"device_type": "web",
|
|
"user_agent": "Mozilla/5.0..."
|
|
}
|
|
}
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"sync_status": "success",
|
|
"progress_updated": true,
|
|
"devices_notified": ["device-1", "device-2"],
|
|
"broadcast": true
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
|------|-------------|
|
|
| 400 | Invalid location data |
|
|
| 401 | Invalid or expired token |
|
|
| 404 | Media item not found |
|
|
|
|
## Try It Out
|
|
|
|
<!-- API Explorer will be inserted here in Phase 3 -->
|