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
63 lines
1.8 KiB
Markdown
63 lines
1.8 KiB
Markdown
# Create Highlight
|
|
|
|
Create a new highlight for a media item.
|
|
|
|
**Endpoint**: `POST /api/media-items/{media_id}/highlights`
|
|
**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 |
|
|
| ---------------- | ------ | -------- | ----------------------------------------- |
|
|
| selection_text | string | Yes | Highlighted text |
|
|
| start_position | string | No | Start position (e.g., epubcfi) |
|
|
| end_position | string | No | End position (e.g., epubcfi) |
|
|
| color | string | No | Highlight color (hex, default: "#ffff00") |
|
|
| percentage_start | float | No | Start percentage (0-1) |
|
|
| percentage_end | float | No | End percentage (0-1) |
|
|
|
|
### Example Request
|
|
|
|
```json
|
|
{
|
|
"selection_text": "Highlighted text...",
|
|
"start_position": "epubcfi(/6/4/2:15)",
|
|
"end_position": "epubcfi(/6/4/2:20)",
|
|
"color": "#ffff00",
|
|
"percentage_start": 0.45,
|
|
"percentage_end": 0.47
|
|
}
|
|
```
|
|
|
|
## Response (201 Created)
|
|
|
|
```json
|
|
{
|
|
"id": "uuid",
|
|
"media_item_id": "uuid",
|
|
"user_id": "uuid",
|
|
"selection_text": "Highlighted text...",
|
|
"start_position": "epubcfi(/6/4/2:15)",
|
|
"end_position": "epubcfi(/6/4/2:20)",
|
|
"color": "#ffff00",
|
|
"percentage_start": 0.45,
|
|
"percentage_end": 0.47,
|
|
"created_at": "2026-01-31T10:00:00Z"
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
| ---- | ------------------------ |
|
|
| 400 | Invalid highlight data |
|
|
| 401 | Invalid or expired token |
|
|
| 404 | Media item not found |
|