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
61 lines
1.3 KiB
Markdown
61 lines
1.3 KiB
Markdown
# Create Note
|
|
|
|
Create a new note for a media item.
|
|
|
|
**Endpoint**: `POST /api/media-items/{media_id}/notes`
|
|
**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 |
|
|
|--------|------|-----------|-------------|
|
|
| content | string | Yes | Note content |
|
|
| position | string | No | Location reference (e.g., epubcfi) |
|
|
| percentage_location | float | No | Location as percentage (0-1) |
|
|
| epubcfi_location | string | No | EPUB CFI location |
|
|
|
|
### Example Request
|
|
|
|
```json
|
|
{
|
|
"content": "This is a note",
|
|
"position": "epubcfi(/6/4/2:15)",
|
|
"percentage_location": 0.45,
|
|
"epubcfi_location": "epubcfi(/6/4/2:15)"
|
|
}
|
|
```
|
|
|
|
## Response (201 Created)
|
|
|
|
```json
|
|
{
|
|
"id": "uuid",
|
|
"media_item_id": "uuid",
|
|
"user_id": "uuid",
|
|
"content": "This is a note",
|
|
"position": "epubcfi(/6/4/2:15)",
|
|
"percentage_location": 0.45,
|
|
"epubcfi_location": "epubcfi(/6/4/2:15)",
|
|
"created_at": "2026-01-31T10:00:00Z"
|
|
}
|
|
```
|
|
|
|
## Error Responses
|
|
|
|
| Code | Description |
|
|
|------|-------------|
|
|
| 400 | Invalid note data |
|
|
| 401 | Invalid or expired token |
|
|
| 404 | Media item not found |
|
|
|
|
## Try It Out
|
|
|
|
<!-- API Explorer will be inserted here in Phase 3 -->
|