Files
bookhoard/bruno/media-items/Update Media Rating.yml
T
john-okeefe c2f72ca785 docs(bruno): correct rating scale and endpoint paths
The Bruno collection docs mislabeled the rating system and referenced
endpoints that do not exist.

- Update Media Rating.yml: the rating value is a 1-10 integer scale
  (displayed as 1-5 stars with half-star precision), not "typically 1-5".
- opencollection.yml: the rating routes live under
  /api/media-items/:id/rating (not /api/ratings/:media_id), GET returns
  null (not 0) when unrated, and document the PUT upsert route. Correct
  the scale to 1-10 here as well.
2026-07-30 13:08:14 -04:00

67 lines
1.5 KiB
YAML

info:
name: Update Media Rating
type: http
seq: 9
http:
method: PUT
url: "{{base_url}}/api/media-items/{{media_item_id}}/rating"
headers:
- name: ""
value: application/json
body:
type: json
data: |-
{
"rating": 9,
"review": "Updated review text"
}
auth: inherit
runtime:
scripts:
- type: tests
code: |-
test_update_media_rating_success(status, headers, body) {
if (status !== 200) {
throw new Error("Expected status 200, got " + status);
settings:
encodeUrl: true
timeout: 0
followRedirects: true
maxRedirects: 5
docs: |-
## Update Media Rating
Updates an existing rating for a media item.
**Method:** PUT
**Endpoint:** /api/media-items/:id/rating
**Authentication:** Required (Bearer token)
**Path Parameters:**
- `id` (string, required): Media item UUID
**Request Body:**
- `rating` (number, required): Rating value (1-10 integer scale; displayed as 1-5 stars with half-star precision)
- `review` (string, optional): Review text
**Response:** Updated rating object
- `id` (string): Rating ID
- `media_item_id` (string): Media item UUID
- `rating` (number): Rating value
- `review` (string): Review text
- `created_at` (string): Creation timestamp
- `updated_at` (string): Last update timestamp
**Status Codes:**
- 200: Success
- 400: Invalid request body
- 401: Unauthorized
- 404: Media item or rating not found
- 500: Internal server error