Bookhoard/bookhoard
0
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

docs(bruno): correct rating scale and endpoint paths

Browse Source 
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.
This commit is contained in:
john-okeefe
2026-07-30 13:08:14 -04:00
parent ca8c592496
commit c2f72ca785
2 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bruno/media-items/Update Media Rating.yml
+1 -1
View File
@@ -47,7 +47,7 @@ docs: |-
- `id` (string, required): Media item UUID - `id` (string, required): Media item UUID
**Request Body:** **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 - `review` (string, optional): Review text
**Response:** Updated rating object **Response:** Updated rating object
bruno/opencollection.yml
+4 -3
View File
@@ -83,9 +83,10 @@ docs:
- **Update Highlight**: PUT /api/highlights/:id - Update highlight - **Update Highlight**: PUT /api/highlights/:id - Update highlight
- **Delete Highlight**: DELETE /api/highlights/:id - Remove highlight - **Delete Highlight**: DELETE /api/highlights/:id - Remove highlight
Ratings (All Users) Ratings (All Users)
- **Get Rating**: GET /api/ratings/:media_id - User's rating (returns 0 if unrated) - **Get Rating**: GET /api/media-items/:id/rating - User's rating (returns null if unrated)
- **Create/Update Rating**: POST /api/ratings - Rate media item (1-5 stars, half-star precision) - **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.
- **Delete Rating**: DELETE /api/ratings/:media_id - Remove rating - **Update Rating**: PUT /api/media-items/:id/rating - Update rating (upsert)
- **Delete Rating**: DELETE /api/media-items/:id/rating - Remove rating
Collections (All Users) Collections (All Users)
- **List Collections**: GET /api/collections - Get user's collections - **List Collections**: GET /api/collections - Get user's collections
- **Get Collection**: GET /api/collections/:id - Collection details with media items - **Get Collection**: GET /api/collections/:id - Collection details with media items