Skip to content
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

Add contributors to albumid3 #130

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions content/en/docs/Responses/AlbumID3.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,15 @@ description: >
"disc": 2,
"title": "Disc 1 title"
}
],
"contributors": [
{
"role": "composer",
"artist": {
"id": "ar-3",
"name": "Artist 3"
}
}
]
}
{{< /tab >}}
Expand Down Expand Up @@ -130,6 +139,8 @@ description: >
| `isCompilation` | `boolean` | No | **Yes** | True if the album is a compilation. |
| `explicitStatus` | `string` | No | **Yes** | Returns "explicit" if at least one song is explicit, "clean" if no song is explicit and at least one is "clean" else "". |
| `discTitles` | Array of [`DiscTitle`](../disctitle) | No | **Yes** | The list of all disc titles of the album. |
| `contributors` | Array of [`Contributor`](../contributor) | No | **Yes** | The list of all contributor artists of the album. |


{{< alert color="warning" title="OpenSubsonic" >}}
New fields are added:
Expand All @@ -148,6 +159,7 @@ New fields are added:
- `isCompilation`
- `discTitles`
- `explicitStatus`
- `contributors`

**Note**: All OpenSubsonic added fields are **optionals**. But if a server support a field it **must** return it with an empty / default value when not present in it's database so that clients knows what the server supports.

Expand Down
11 changes: 11 additions & 0 deletions content/en/docs/Responses/AlbumID3WithSongs.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,15 @@ description: >
"title": "Disc 1 title"
}
],
"contributors": [
{
"role": "composer",
"artist": {
"id": "ar-3",
"name": "Artist 3"
}
}
],
"song": [
{
"id": "300000116",
Expand Down Expand Up @@ -243,6 +252,7 @@ description: >
| `isCompilation` | `boolean` | No | **Yes** | True if the album is a compilation.|
| `explicitStatus` | `string` | No | **Yes** | Returns "explicit" if at least one song is explicit, "clean" if no song is explicit and at least one is "clean" else "". |
| `discTitles` | Array of [`DiscTitle`](../disctitle) | No | **Yes** | The list of all disc titles of the album. |
| `contributors` | Array of [`Contributor`](../contributor) | No | **Yes** | The list of all contributor artists of the album. |
| `song` | Array of [`Child`](../child) | No | | The list of songs |

{{< alert color="warning" title="OpenSubsonic" >}}
Expand All @@ -262,6 +272,7 @@ New fields are added:
- `isCompilation`
- `discTitles`
- `explicitStatus`
- `contributors`

**Note**: All OpenSubsonic added fields are **optionals**. But if a server support a field it **must** return it with an empty / default value when not present in it's database so that clients knows what the server supports.

Expand Down