Add releaseDate field to AlbumID3 (#68)

* add `releaseDate` field to AlbumID3 * update AlbumID3WithSongs response * Update type of releaseDate to ItemDate * undo accidental file rename * Update releaseDate type to ItemDate in AlbumID3WithSongs * Add TDRL note * Add TDRL notice to AlbumID3WithSOngs
opensubsonic · Mar 13, 2024 · 200a2e8 · 200a2e8
1 parent 7e4180e
commit 200a2e8
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/content/en/docs/Responses/AlbumID3.md b/content/en/docs/Responses/AlbumID3.md
@@ -64,6 +64,11 @@ description: >
         "month": 3,
         "day": 10
     },
+    "releaseDate": {
+        "year": 2001,
+        "month": 3,
+        "day": 10
+    },
     "isCompilation": false,
     "discTitles": [
         {
@@ -103,7 +108,7 @@ description: >
 | `artistId` | `string` | No |    | The id of the artist |
 | `coverArt` | `string` | No |     | A covertArt id.  |
 | `songCount` | `int` | **Yes** |     | Number of songs |
-| `duration` | `int` | **Yes** |     | Total duration of the album |
+| `duration` | `int` | **Yes** |     | Total duration of the album in seconds |
 | `playCount` | `long` | No |     | Number of play of the album |
 | `created` | `string` | **Yes** |     | Date the album was added. [ISO 8601]|
 | `starred` | `string` | No |     | Date the album was starred. [ISO 8601]|
@@ -120,6 +125,7 @@ description: >
 | `moods` | Array of `string` | No | **Yes**    | The list of all moods of the album. |
 | `sortName` | `string` | No |  **Yes**   | The album sort name. |
 | `originalReleaseDate` | [`ItemDate`](../itemdate) | No |   **Yes**   | Date the album was originally released. |
+| `releaseDate` | [`ItemDate`](../itemdate)  | No |   **Yes**   | Date the specific edition of the album was released. *Note:* for files using ID3 tags, releaseDate should generally be read from the **TDRL** tag. Servers that use a different source for this field should document the behavior. |
 | `isCompilation` | `boolean` | No |  **Yes**    | True if the album is a compilation. |
 | `discTitles` | Array of [`DiscTitle`](../disctitle) | No | **Yes**    | The list of all disc titles of the album. |
 

diff --git a/content/en/docs/Responses/AlbumID3WithSongs.md b/content/en/docs/Responses/AlbumID3WithSongs.md
@@ -64,6 +64,11 @@ description: >
         "month": 3,
         "day": 10
     },
+    "releaseDate": {
+        "year": 2001,
+        "month": 3,
+        "day": 10
+    },
     "isCompilation": false,
     "discTitles": [
         {
@@ -202,7 +207,7 @@ description: >
 | `artistId` | `string` | No |    | The id of the artist |
 | `coverArt` | `string` | No |     | A covertArt id.  |
 | `songCount` | `int` | **Yes** |     | Number of songs |
-| `duration` | `int` | **Yes** |     | Total duration of the album |
+| `duration` | `int` | **Yes** |     | Total duration of the album in seconds |
 | `playCount` | `long` | No |     | Number of play of the album |
 | `created` | `string` | **Yes** |     | Date the album was added. [ISO 8601]|
 | `starred` | `string` | No |     | Date the album was starred. [ISO 8601]|
@@ -219,6 +224,7 @@ description: >
 | `moods` | Array of `string` | No | **Yes**    | The list of all moods of the album. |
 | `sortName` | `string` | No |  **Yes**   | The album sort name. |
 | `originalReleaseDate` | [`ItemDate`](../itemdate) | No |   **Yes**   | Date the album was originally released. |
+| `releaseDate` | [`ItemDate`](../itemdate) | No |   **Yes**   | Date the specific edition of the album was released. *Note:* for files using ID3 tags, releaseDate should generally be read from the **TDRL** tag. Servers that use a different source for this field should document the behavior. |
 | `isCompilation` | `boolean` | No |  **Yes**    | True if the album is a compilation.|
 | `discTitles` | Array of [`DiscTitle`](../disctitle) | No | **Yes**    | The list of all disc titles of the album. |
 | `song` | Array of [`Child`](../child) | No |     | The list of songs |