Files

T

john-okeefe b44e4e4709 docs: remove Phase X placeholders from API documentation

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.

2026-02-13 21:50:44 -05:00

1.1 KiB

Raw Blame History

Update Rating

Update an existing rating for a media item.

Endpoint: PUT /api/media-items/{media_id}/rating 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
rating	integer	Yes	Rating value (1-10 scale)
review	string	No	Optional review text

Rating Scale: 1-10 (odd numbers = half-stars: 1=0.5★, 2=1★, 3=1.5★, ..., 9=4.5★, 10=5★)

Example Request

{
  "rating": 8,
  "review": "Great book! Very enjoyable read."
}

Response (200 OK)

{
  "id": "uuid",
  "media_item_id": "uuid",
  "user_id": "uuid",
  "rating": 8,
  "review": "Great book! Very enjoyable read.",
  "created_at": "2026-01-31T10:00:00Z",
  "updated_at": "2026-01-31T11:00:00Z"
}

Error Responses

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

1.1 KiB Raw Blame History