Reorganize OpenAPI schema properties for consistency

content/en/docs/Responses/Child.md

@@ -164,52 +164,52 @@ description: >
 | `isDir` | `boolean` | **Yes** |   | The media is a directory |
 | `title` | `string` | **Yes** |   | The media name. |
 | `album` | `string` | No |   | The album name. |
-| `artist` | `string` | No |   | The artist name.  |
-| `track` | `int` | No |  | The track number. |
+| `artist` | `string` | No |   | The artist name. |
+| `track` | `int` | No |   | The track number. |
 | `year` | `int` | No |   | The media year. |
-| `genre` | `string` | No |   | The media genre|
-| `coverArt` | `string` | No |   | A covertArt id.  |
-| `size` | `long` | No |   | A file size of the media.  |
-| `contentType` | `string` | No |   | The mimeType of the media.  |
-| `suffix` | `string` | No |   | The file suffix of the media.  |
-| `transcodedContentType` | `string` | No |   | The transcoded mediaType if transcoding should happen. |
-| `transcodedSuffix` | `string` | No |   | The file suffix of the transcoded media.  |
+| `coverArt` | `string` | No |   | A covertArt id. |
+| `size` | `long` | No |   | A file size of the media. |
+| `contentType` | `string` | No |   | The mimeType of the media. |
+| `suffix` | `string` | No |   | The file suffix of the media. |
+| `starred` | `string` | No |   | Date the media was starred. [ISO 8601] |
 | `duration` | `int` | No |   | The duration of the media in seconds. |
 | `bitRate` | `int` | No |   | The bitrate of the media. |
 | `bitDepth` | `int` | No | **Yes** | The bit depth of the media. |
 | `samplingRate` | `int` | No | **Yes** | The sampling rate of the media. |
 | `channelCount` | `int` | No | **Yes** | The number of channels of the media. |
 | `path` | `string` | No |   | The full path of the media. |
-| `isVideo` | `boolean` | No |   | Media is a video |
-| `userRating` | `int` | No |   | The user rating of the media [1-5] |
-| `averageRating` | `number` | No |   | The average rating of the media [1.0-5.0] |
 | `playCount` | `long` | No |   | The play count. |
+| `played` | `string` | No | **Yes** | Date the media was last played. [ISO 8601] |
 | `discNumber` | `int` | No |   | The disc number. |
 | `created` | `string` | No |   | Date the media was created. [ISO 8601] |
-| `starred` | `string` | No |   | Date the media was starred. [ISO 8601] |
 | `albumId` | `string` | No |   | The corresponding album id |
 | `artistId` | `string` | No |   | The corresponding artist id |
-| `type` | `string` | No |   | The generic type of media [music/podcast/audiobook/video]|
+| `type` | `string` | No |   | The generic type of media [music/podcast/audiobook/video] |
 | `mediaType` | `string` | No | **Yes** | The actual media type [song/album/artist] **Note**: If you support `musicBrainzId` you must support this field to ensure clients knows what the ID refers to. |
+| `isVideo` | `boolean` | No |   | Media is a video |
+| `bpm` | `int` | No | **Yes** | The BPM of the song. |
+| `comment` | `string` | No | **Yes** | The comment tag of the song. |
+| `sortName` | `string` | No | **Yes** | The song sort name. |
+| `musicBrainzId` | `string` | No | **Yes** | The track MusicBrainzID. |
+| `isrc` | Array of `string` | No | **Yes** | The track ISRC(s). |
+| `genres` | Array of [`ItemGenre`](../itemgenre) | No | **Yes** | The list of all genres of the song. |
+| `artists` | Array of [`ArtistID3`](../artistid3) | No | **Yes** | The list of all song artists of the song. (Note: Only the required [`ArtistID3`](../artistid3) fields should be returned by default) |
+| `displayArtist` | `string` | No | **Yes** | The single value display artist. |
+| `albumArtists` | Array of [`ArtistID3`](../artistid3) | No | **Yes** | The list of all album artists of the song. (Note: Only the required [`ArtistID3`](../artistid3) fields should be returned by default) |
+| `displayAlbumArtist` | `string` | No | **Yes** | The single value display album artist. |
+| `contributors` | Array of [`Contributor`](../contributor) | No | **Yes** | The list of all contributor artists of the song. |
+| `displayComposer` | `string` | No | **Yes** | The single value display composer. |
+| `moods` | Array of `string` | No | **Yes** | The list of all moods of the song. |
+| `explicitStatus` | `string` | No | **Yes** | Returns "explicit", "clean" or "". (For songs extracted from tags "ITUNESADVISORY": 1 = explicit, 2 = clean, MP4 "rtng": 1 or 4 = explicit, 2 = clean. See [`albumID3`](../albumid3) for albums) |
+| `replayGain` | [`ReplayGain`](../replaygain) | No | **Yes** | The replaygain data of the song. |
+| `genre` | `string` | No |   | The media genre |
+| `transcodedContentType` | `string` | No |   | The transcoded mediaType if transcoding should happen. |
+| `transcodedSuffix` | `string` | No |   | The file suffix of the transcoded media. |
+| `userRating` | `int` | No |   | The user rating of the media [1-5] |
+| `averageRating` | `number` | No |   | The average rating of the media [1.0-5.0] |
 | `bookmarkPosition` | `long` | No |   | The bookmark position in seconds |
 | `originalWidth` | `int` | No |   | The video original Width |
 | `originalHeight` | `int` | No |   | The video original Height |
-| `played` | `string` | No | **Yes**  | Date the album was last played. [ISO 8601]|
-| `bpm` | `int` | No |   **Yes**   | The BPM of the song. |
-| `comment` | `string` | No |  **Yes**  | The comment tag of the song. |
-| `sortName` | `string` | No |  **Yes**   | The song sort name. |
-| `musicBrainzId` | `string` | No |  **Yes**   | The track MusicBrainzID. |
-| `isrc` | Array of `string` | No |  **Yes**   | The track ISRC(s). |
-| `genres` | Array of [`ItemGenre`](../itemgenre) | No | **Yes**  | The list of all genres of the song. |
-| `artists` | Array of [`ArtistID3`](../artistid3) | No | **Yes**  | The list of all song artists of the song. (Note: Only the required [`ArtistID3`](../artistid3) fields should be returned by default)|
-| `displayArtist` | `string` | No |  **Yes**   | The single value display artist. |
-| `albumArtists` | Array of [`ArtistID3`](../artistid3) | No | **Yes**  | The list of all album artists of the song. (Note: Only the required [`ArtistID3`](../artistid3) fields should be returned by default)|
-| `displayAlbumArtist` | `string` | No |  **Yes**   | The single value display album artist. |
-| `contributors` | Array of [`Contributor`](../contributor) | No | **Yes**  | The list of all contributor artists of the song. |
-| `displayComposer` | `string` | No |  **Yes**   | The single value display composer. |
-| `moods` | Array of `string` | No | **Yes**  | The list of all moods of the song. |
-| `replayGain` | [`ReplayGain`](../replaygain) | No | **Yes**  | The replaygain data of the song. |
-| `explicitStatus` | `string` | No |  **Yes**    | Returns "explicit", "clean" or "". (For songs extracted from tags "ITUNESADVISORY": 1 = explicit, 2 = clean, MP4 "rtng": 1 or 4 = explicit, 2 = clean. See [`albumID3`](../albumid3) for albums) |
 
 {{< alert color="warning" title="OpenSubsonic" >}}
 New fields are added:

content/en/docs/Responses/user.md

@@ -56,6 +56,7 @@ description: >
 | Field                 | Type           | Req.    | OpenS. | Details                                      |
 | --------------------- | -------------- | ------- | ------ | -------------------------------------------- |
 | `username`            | `string`       | **Yes** |        | Username                                     |
+| `email`               | `string`       | No      |        | The user's email address                     |
 | `scrobblingEnabled`   | `boolean`      | **Yes** |        | Whether scrobling is enabled for the user    |
 | `maxBitRate`          | `int`          | No      |        |                                              |
 | `adminRole`           | `boolean`      | **Yes** |        | Whether the user is an admin                 |

openapi/schemas/AlbumID3.json

@@ -18,17 +18,18 @@
             "type": "string",
             "description": "Artist name."
         },
-        "artistId": {
-            "type": "string",
-            "description": "The id of the artist"
+        "year": {
+            "type": "integer",
+            "description": "The album year"
         },
         "coverArt": {
             "type": "string",
             "description": "A covertArt id."
         },
-        "songCount": {
-            "type": "integer",
-            "description": "Number of songs"
+        "starred": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Date the album was starred. [ISO 8601]"
         },
         "duration": {
             "type": "integer",
@@ -38,23 +39,22 @@
             "type": "integer",
             "description": "Number of play of the album"
         },
+        "genre": {
+            "type": "string",
+            "description": "The album genre"
+        },
         "created": {
             "type": "string",
             "format": "date-time",
             "description": "Date the album was added. [ISO 8601]"
         },
-        "starred": {
+        "artistId": {
             "type": "string",
-            "format": "date-time",
-            "description": "Date the album was added. [ISO 8601]"
+            "description": "The id of the artist"
         },
-        "year": {
+        "songCount": {
             "type": "integer",
-            "description": "The album year"
-        },
-        "genre": {
-            "type": "string",
-            "description": "The album genre"
+            "description": "Number of songs"
         },
         "played": {
             "type": "string",
@@ -115,11 +115,19 @@
             "description": "The album sort name."
         },
         "originalReleaseDate": {
-            "allOf": [{"$ref": "./ItemDate.json"}],
+            "allOf": [
+                {
+                    "$ref": "./ItemDate.json"
+                }
+            ],
             "description": "Date the album was originally released."
         },
         "releaseDate": {
-            "allOf": [{"$ref": "./ItemDate.json"}],
+            "allOf": [
+                {
+                    "$ref": "./ItemDate.json"
+                }
+            ],
             "description": "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": {
@@ -155,4 +163,4 @@
         "description": "AlbumID3",
         "url": "https://opensubsonic.netlify.app/docs/responses/albumid3/"
     }
-}
+}

openapi/schemas/AlbumInfo.json

@@ -10,10 +10,6 @@
             "type": "string",
             "description": "Album musicBrainzId"
         },
-        "lastFmUrl": {
-            "type": "string",
-            "description": "Album lastFmUrl"
-        },
         "smallImageUrl": {
             "type": "string",
             "description": "Album smallImageUrl"
@@ -25,10 +21,14 @@
         "largeImageUrl": {
             "type": "string",
             "description": "Album largeImageUrl"
+        },
+        "lastFmUrl": {
+            "type": "string",
+            "description": "Album lastFmUrl"
         }
     },
     "externalDocs": {
         "description": "AlbumInfo",
         "url": "https://opensubsonic.netlify.app/docs/responses/albuminfo/"
     }
-}
+}

openapi/schemas/Artist.json

@@ -10,15 +10,15 @@
             "type": "string",
             "description": "Artist name"
         },
-        "artistImageUrl": {
-            "type": "string",
-            "description": "Artist image url"
-        },
         "starred": {
             "type": "string",
             "format": "date-time",
             "description": "Artist starred date [ISO 8601]"
         },
+        "artistImageUrl": {
+            "type": "string",
+            "description": "Artist image url"
+        },
         "userRating": {
             "type": "integer",
             "minimum": 1,
@@ -40,4 +40,4 @@
         "description": "Artist",
         "url": "https://opensubsonic.netlify.app/docs/responses/artist/"
     }
-}
+}

openapi/schemas/ArtistID3.json

@@ -14,14 +14,14 @@
             "type": "string",
             "description": "A covertArt id."
         },
-        "artistImageUrl": {
-            "type": "string",
-            "description": "An url to an external image source."
-        },
         "albumCount": {
             "type": "integer",
             "description": "Artist album count."
         },
+        "artistImageUrl": {
+            "type": "string",
+            "description": "An url to an external image source."
+        },
         "starred": {
             "type": "string",
             "format": "date-time",
@@ -51,4 +51,4 @@
         "description": "ArtistID3",
         "url": "https://opensubsonic.netlify.app/docs/responses/artistid3/"
     }
-}
+}

openapi/schemas/ArtistInfo.json

@@ -10,10 +10,6 @@
             "type": "string",
             "description": "Artist musicBrainzId"
         },
-        "lastFmUrl": {
-            "type": "string",
-            "description": "Artist lastFmUrl"
-        },
         "smallImageUrl": {
             "type": "string",
             "description": "Artist smallImageUrl"
@@ -26,6 +22,10 @@
             "type": "string",
             "description": "Artist largeImageUrl"
         },
+        "lastFmUrl": {
+            "type": "string",
+            "description": "Artist lastFmUrl"
+        },
         "similarArtist": {
             "type": "array",
             "items": {
@@ -38,4 +38,4 @@
         "description": "ArtistInfo",
         "url": "https://opensubsonic.netlify.app/docs/responses/artistinfo/"
     }
-}
+}

openapi/schemas/ArtistInfo2.json

@@ -10,10 +10,6 @@
             "type": "string",
             "description": "Artist musicBrainzId"
         },
-        "lastFmUrl": {
-            "type": "string",
-            "description": "Artist lastFmUrl"
-        },
         "smallImageUrl": {
             "type": "string",
             "description": "Artist smallImageUrl"
@@ -26,6 +22,10 @@
             "type": "string",
             "description": "Artist largeImageUrl"
         },
+        "lastFmUrl": {
+            "type": "string",
+            "description": "Artist lastFmUrl"
+        },
         "similarArtist": {
             "type": "array",
             "items": {
@@ -38,4 +38,4 @@
         "description": "ArtistInfo2",
         "url": "https://opensubsonic.netlify.app/docs/responses/artistinfo2/"
     }
-}
+}

openapi/schemas/Bookmark.json

@@ -6,6 +6,14 @@
         "url": "https://opensubsonic.netlify.app/docs/responses/bookmark/"
     },
     "properties": {
+        "entry": {
+            "allOf": [
+                {
+                    "$ref": "./Child.json"
+                }
+            ],
+            "description": "The bookmark file"
+        },
         "position": {
             "type": "integer",
             "description": "Bookmark position in milliseconds"
@@ -27,10 +35,6 @@
             "type": "string",
             "format": "date-time",
             "description": "Bookmark last updated date [ISO 8601]"
-        },
-        "entry": {
-            "allOf": [{"$ref": "./Child.json"}],
-            "description": "The bookmark file"
         }
     },
     "required": [