John O'Keefe
7a7b2ab82a
Highlights + notes CRUD (media-item scoped, jwt), progress delete,
reading-stats analytics, and the OPDS trio frontmatter'd. OPDS docs are
the first XML entries: example-response intentionally omitted (Atom
responses), gate contract honored via nil-Response registry pins.
Gate fix: group .Use() middleware now parsed (opds.Use(DeviceAuth...
Authenticate) previously resolved to auth 'none'). Registry: 13 entries.
Drift fixed by gate: reading-stats key names (total_reading_time_minutes,
most_active_day_of_week, daily_reading_minutes — draft invented
reading_time_hours/books_completed); notes/highlights list endpoints
return BARE arrays (no {notes:[]}/{highlights:[]} wrapper); create-note
request has no percentage_location/epubcfi_location. New
/tmp/merge_arrays.py handles array-example merges.
make test 9/9.
79 lines
1.9 KiB
Markdown
79 lines
1.9 KiB
Markdown
---
|
|
method: GET
|
|
path: /api/media-items/:id/highlights
|
|
auth: jwt
|
|
area: media-items
|
|
---
|
|
<!-- source: internal/handlers/media.go:2001 MediaHandler.GetMediaHighlights -->
|
|
|
|
# Get Highlights
|
|
|
|
Retrieve all highlights for a specific media item.
|
|
|
|
**Endpoint**: `GET /api/media-items/{media_id}/highlights`
|
|
**Auth**: Required
|
|
|
|
## Path Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ------ | -------- | --------------- |
|
|
| media_id | string | Yes | Media item UUID |
|
|
|
|
## Request Headers
|
|
|
|
| Header | Type | Required | Description |
|
|
| ------------- | ------ | -------- | ------------ |
|
|
| Authorization | string | Yes | Bearer token |
|
|
|
|
### Example Request
|
|
|
|
```http
|
|
GET /api/media-items/uuid/highlights
|
|
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
|
|
```
|
|
|
|
## Response (200 OK)
|
|
|
|
```json example-response
|
|
[
|
|
{
|
|
"id": "uuid",
|
|
"media_item_id": "uuid",
|
|
"user_id": "uuid",
|
|
"selection_text": "Highlighted text passage...",
|
|
"start_position": "epubcfi(/6/4/2:15)",
|
|
"end_position": "epubcfi(/6/4/2:20)",
|
|
"color": "#ffff00",
|
|
"percentage_start": 0.45,
|
|
"percentage_end": 0.47,
|
|
"character_start": 15432,
|
|
"character_end": 15480,
|
|
"epubcfi_start": "epubcfi(/6/4/2:15)",
|
|
"epubcfi_end": "epubcfi(/6/4/2:20)",
|
|
"created_at": "2026-01-31T10:00:00Z",
|
|
"chapter_reference": null,
|
|
"dedup_key": "",
|
|
"deleted": false,
|
|
"deleted_at": null,
|
|
"device_sync_data": "",
|
|
"last_modified_at": null,
|
|
"last_modified_source": "",
|
|
"note_id": null,
|
|
"note_text": null,
|
|
"panel_number": null,
|
|
"paragraph_end": null,
|
|
"paragraph_start": null,
|
|
"updated_at": null
|
|
}
|
|
]
|
|
```
|
|
|
|
Response is a bare JSON array of MediaHighlights rows — no wrapper object.
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
| ---- | ------------------------ |
|
|
| 401 | Invalid or expired token |
|
|
| 404 | Media item not found |
|