john-okeefe
b44e4e4709
Clean up API documentation files by removing Phase X references: Remove 'API Explorer will be inserted here in Phase X' placeholders from: - 70+ API endpoint documentation files - Authentication endpoints (login, logout, register, refresh) - User endpoints (profile, settings, password) - Device endpoints (registration, sync, shelves) - Library endpoints (CRUD, folders, visibility) - Media endpoints (items, progress, highlights, notes) - Admin endpoints (users, analytics) - Sync endpoints (Kobo, KOReader) - OPDS endpoints - Scanner endpoints - Queue endpoints These placeholders were from planning documents and have no meaning to API consumers. The documentation is now clean and ready for use.
52 lines
1.0 KiB
Markdown
52 lines
1.0 KiB
Markdown
# Update Highlight
|
|
|
|
Update an existing highlight.
|
|
|
|
**Endpoint**: `PUT /api/media-items/highlights/{highlight_id}`
|
|
**Auth**: Required
|
|
**Content-Type**: `application/json`
|
|
|
|
## Path Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
|-----------|------|-----------|-------------|
|
|
| highlight_id | string | Yes | Highlight UUID |
|
|
|
|
## Request Body
|
|
|
|
| Field | Type | Required | Description |
|
|
|--------|------|-----------|-------------|
|
|
| selection_text | string | No | Updated highlighted text |
|
|
| color | string | No | Updated highlight color (hex) |
|
|
|
|
### Example Request
|
|
|
|
```json
|
|
{
|
|
"selection_text": "Updated text",
|
|
"color": "#00ff00"
|
|
}
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json
|
|
{
|
|
"id": "uuid",
|
|
"media_item_id": "uuid",
|
|
"user_id": "uuid",
|
|
"selection_text": "Updated text",
|
|
"color": "#00ff00",
|
|
"updated_at": "2026-01-31T10:00:00Z"
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
|------|-------------|
|
|
| 400 | Invalid highlight data |
|
|
| 401 | Invalid or expired token |
|
|
| 403 | User does not own this highlight |
|
|
| 404 | Highlight not found |
|