-
Notifications
You must be signed in to change notification settings - Fork 31
add ratingID3 extension to support user ratings for AlbumID3 and ArtistID3 #184
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
40a607e
93eb666
401c595
7afe6fb
7114c87
0aeffc8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,13 +9,17 @@ description: > | |
|
|
||
| `http://your-server/rest/setRating` Since [1.6.0](../../subsonic-versions) | ||
|
|
||
| Sets the rating for a music file. | ||
| Sets the rating for a music file, folder, album, or artist. | ||
|
|
||
| Servers implementing the [ratingID3 extension](../Extensions/ratingID3.md) additionally support setting ratings for ArtistID3 and AlbumID3. | ||
|
|
||
| ### Parameters | ||
|
|
||
| | Parameter | Req. | OpenS. | Default | Comment | | ||
| | --- | --- | --- | --- | --- | | ||
| | `id` | **Yes** | | | A string which uniquely identifies the file (song) or folder (album/artist) to rate. | | ||
| | `id` | No | | | A string which uniquely identifies the file (song) or folder (album/artist) to rate. | | ||
| | `artistId` | No | **Yes** | | The ID of an artistID3 to rate. Multiple parameters allowed. Supported by servers implementing the ratingID3 extension. | | ||
| | `albumId` | No | **Yes** | | The ID of an albumID3 to rate. Multiple parameters allowed. Supported by servers implementing the ratingID3 extension. | | ||
|
Comment on lines
+21
to
+22
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is the "Multiple parameters allowed" here on purpose? Unlike in the |
||
| | `rating` | **Yes** | | | The rating between 1 and 5 (inclusive), or 0 to remove the rating. | | ||
|
|
||
| ### Example | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| title: "Rating ID3" | ||
| linkTitle: "Rating ID3" | ||
| OpenSubsonic: | ||
| - Extension | ||
| description: > | ||
| Adds support for setting user ratings to ArtistID3 and AlbumID3 types. | ||
| --- | ||
|
|
||
| **OpenSubsonic version**: [1](../../opensubsonic-versions) | ||
|
|
||
| **OpenSubsonic extension name**: `ratingID3` (As returned by [`getOpenSubsonicExtensions`](../../endpoints/getopensubsonicextensions)) | ||
|
|
||
| ## Version 1 | ||
|
|
||
| Supporting this extension means that: | ||
|
|
||
| - The server supports the `userRating` field on [`AlbumID3`](../Responses/AlbumID3.md) and [`ArtistID3`](../Responses/ArtistID3.md) | ||
| - The [`setRating`](../Endpoints/setrating.md) endpoint supports the `albumId` and `artistId` parameters to apply user ratings to AlbumID3 and ArtistID3. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change went to wrong place. Here it wouldn't have been necessary as the sentence below already covers the artist and album. Now there's unnecessary repetition. My previous comment was targeted to the summary in the header on the line 7 of this file.