0 Fork 0

Files

T

John O'Keefe 7a7b2ab82a docs(highlights,notes,opds,progress,analytics): Beam batch 9 — 13 endpoints

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.

2026-10-24 17:47:07 -04:00

2.4 KiB

Raw Blame History

method, path, auth, area

method	path	auth	area
POST	/api/media-items/:id/highlights	jwt	media-items

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

{
  "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)

{
  "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",
  "chapter_reference": null,
  "character_end": null,
  "character_start": null,
  "dedup_key": null,
  "deleted": null,
  "deleted_at": null,
  "device_sync_data": null,
  "epubcfi_end": null,
  "epubcfi_start": null,
  "last_modified_at": null,
  "last_modified_source": null,
  "note_id": null,
  "note_text": null,
  "panel_number": null,
  "paragraph_end": null,
  "paragraph_start": null,
  "updated_at": null
}

Error Responses

Code	Description
400	Invalid highlight data
401	Invalid or expired token
404	Media item not found

2.4 KiB Raw Blame History