Skip to content

Reorganize OpenAPI schema properties for consistency #207

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.

Sign up for GitHub

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

Open
deluan wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Reorganize OpenAPI schema properties for consistency #207

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
98d82e2
Sync OpenAPI schema property order with documentation examples
claude Feb 8, 2026
965b07e
Fix description inconsistencies from PR review feedback
deluan Feb 11, 2026
a3ba94d
Fix JukeboxStatus: rename volume to gain and fix type
deluan Feb 11, 2026
1aacec4
Fix Child averageRating minimum: 0 -> 1 to match XSD
deluan Feb 11, 2026
c79da7e
Reorder Child.md doc table to match schema property order
deluan Feb 12, 2026
6933fa4
Add missing email field to User schema and doc table
deluan Feb 12, 2026
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
44 changes: 26 additions & 18 deletions openapi/schemas/AlbumID3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 added. [ISO 8601]"
Comment thread
deluan marked this conversation as resolved.
Outdated
},
"duration": {
"type": "integer",
Expand All @@ -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",
Expand Down Expand Up @@ -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": {
Expand Down Expand Up @@ -155,4 +163,4 @@
"description": "AlbumID3",
"url": "https://opensubsonic.netlify.app/docs/responses/albumid3/"
}
}
}
10 changes: 5 additions & 5 deletions openapi/schemas/AlbumInfo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@
"type": "string",
"description": "Album musicBrainzId"
},
"lastFmUrl": {
"type": "string",
"description": "Album lastFmUrl"
},
"smallImageUrl": {
"type": "string",
"description": "Album smallImageUrl"
Expand All @@ -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/"
}
}
}
10 changes: 5 additions & 5 deletions openapi/schemas/Artist.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand All @@ -40,4 +40,4 @@
"description": "Artist",
"url": "https://opensubsonic.netlify.app/docs/responses/artist/"
}
}
}
10 changes: 5 additions & 5 deletions openapi/schemas/ArtistID3.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down Expand Up @@ -51,4 +51,4 @@
"description": "ArtistID3",
"url": "https://opensubsonic.netlify.app/docs/responses/artistid3/"
}
}
}
10 changes: 5 additions & 5 deletions openapi/schemas/ArtistInfo.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@
"type": "string",
"description": "Artist musicBrainzId"
},
"lastFmUrl": {
"type": "string",
"description": "Artist lastFmUrl"
},
"smallImageUrl": {
"type": "string",
"description": "Artist smallImageUrl"
Expand All @@ -26,6 +22,10 @@
"type": "string",
"description": "Artist largeImageUrl"
},
"lastFmUrl": {
"type": "string",
"description": "Artist lastFmUrl"
},
"similarArtist": {
"type": "array",
"items": {
Expand All @@ -38,4 +38,4 @@
"description": "ArtistInfo",
"url": "https://opensubsonic.netlify.app/docs/responses/artistinfo/"
}
}
}
10 changes: 5 additions & 5 deletions openapi/schemas/ArtistInfo2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@
"type": "string",
"description": "Artist musicBrainzId"
},
"lastFmUrl": {
"type": "string",
"description": "Artist lastFmUrl"
},
"smallImageUrl": {
"type": "string",
"description": "Artist smallImageUrl"
Expand All @@ -26,6 +22,10 @@
"type": "string",
"description": "Artist largeImageUrl"
},
"lastFmUrl": {
"type": "string",
"description": "Artist lastFmUrl"
},
"similarArtist": {
"type": "array",
"items": {
Expand All @@ -38,4 +38,4 @@
"description": "ArtistInfo2",
"url": "https://opensubsonic.netlify.app/docs/responses/artistinfo2/"
}
}
}
12 changes: 8 additions & 4 deletions openapi/schemas/Bookmark.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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": [
Expand Down
Loading