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.
57 lines
1.3 KiB
Markdown
57 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 |
|