From c2f72ca785f4931b64b8df2276308c041fc99a2b Mon Sep 17 00:00:00 2001 From: John O'Keefe Date: Thu, 30 Jul 2026 13:08:14 -0400 Subject: [PATCH] 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. --- bruno/media-items/Update Media Rating.yml | 2 +- bruno/opencollection.yml | 7 ++++--- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/bruno/media-items/Update Media Rating.yml b/bruno/media-items/Update Media Rating.yml index 179fca8..765a149 100644 --- a/bruno/media-items/Update Media Rating.yml +++ b/bruno/media-items/Update Media Rating.yml @@ -47,7 +47,7 @@ docs: |- - `id` (string, required): Media item UUID **Request Body:** - - `rating` (number, required): Rating value (typically 1-5) + - `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 diff --git a/bruno/opencollection.yml b/bruno/opencollection.yml index 1318a1c..40b11a6 100644 --- a/bruno/opencollection.yml +++ b/bruno/opencollection.yml @@ -83,9 +83,10 @@ docs: - **Update Highlight**: PUT /api/highlights/:id - Update highlight - **Delete Highlight**: DELETE /api/highlights/:id - Remove highlight Ratings (All Users) - - **Get Rating**: GET /api/ratings/:media_id - User's rating (returns 0 if unrated) - - **Create/Update Rating**: POST /api/ratings - Rate media item (1-5 stars, half-star precision) - - **Delete Rating**: DELETE /api/ratings/:media_id - Remove rating + - **Get Rating**: GET /api/media-items/:id/rating - User's rating (returns null if unrated) + - **Create/Update Rating**: POST /api/media-items/:id/rating - Rate media item (1-10 scale, displayed as 1-5 stars with half-star precision). POST upserts; PUT also available. + - **Update Rating**: PUT /api/media-items/:id/rating - Update rating (upsert) + - **Delete Rating**: DELETE /api/media-items/:id/rating - Remove rating Collections (All Users) - **List Collections**: GET /api/collections - Get user's collections - **Get Collection**: GET /api/collections/:id - Collection details with media items