From ab3a3f280686dc97966341c50ba39e99aecd5828 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Mon, 26 Jun 2017 11:47:33 -0400 Subject: [PATCH] separate API infos from the README --- API-INFOS.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 81 ---------------------------------------------------- 2 files changed, 79 insertions(+), 81 deletions(-) create mode 100644 API-INFOS.md diff --git a/API-INFOS.md b/API-INFOS.md new file mode 100644 index 0000000..1805140 --- /dev/null +++ b/API-INFOS.md @@ -0,0 +1,79 @@ +# Current target API version + +At the moment, the current target API version is 1.8.0 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ModuleAPI callStatusComments
System ping Done
getLicense Done
Browsing getMusicFolders Done
getIndexes Done
getMusicDirectory Done
getGenres N/A From API v1.9.0
getArtists Done
getArtist Done
getAlbum Done
getSong Done
getVideos Done Actually returns an error as video support is not planned
Album/song lists getAlbumList Done
getAlbumList2 Done
getRandomSongs Done
getSongsByGenre N/A From API v1.9.0
getNowPlaying Done
getStarred Done
getStarred2 Done
Searching search Done
search2 Done
search3 Done
Playlists getPlaylists Done
getPlaylist Done
createPlaylist Done
updatePlaylist Done
deletePlaylist Done
Media retrieval stream Done
download Done
hls N/A Video related stuff, not planned
getCoverArt Done
getLyrics Done Use either text files or ChartLyrics API
getAvatar TODO Not that useful for a streaming server, but whatever
Media annotation star Done
unstar Done
setRating Done
scrobble Done
Sharing getShares TODO Need to look how this works on the official Subsonic server
createShare TODO
updateShare TODO
deleteShare TODO
Podcast getPodcasts N/A Not planning to support podcasts at the moment
refreshPodcasts N/A From API v1.9.0
createPodcastChannel N/A From API v1.9.0
deletePodcastChannel N/A From API v1.9.0
deletePodcastEpisode N/A From API v1.9.0
downloadPodcastEpisode N/A From API v1.9.0
Jukebox jukeboxControl N/A Not planning to support the Jukebox feature
Internet radio getInternetRadioStations N/A From API v1.9.0
Chat getChatMessages Done
addChatMessage Done
User management getUser Done
getUsers Done
createUser Done
deleteUser Done
changePassword Done
Bookmarks getBookmarks N/A From API v1.9.0
createBookmark N/A From API v1.9.0
deleteBookmark N/A From API v1.9.0
diff --git a/README.md b/README.md index f8acdcb..742be9f 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,6 @@ For more details, go check the [API implementation status][api]. * [Quickstart](#quickstart) * [Scanner daemon](#scanner-daemon) * [Upgrading](#upgrading) -* [Current target API version](#current-target-api-version) ## Installation @@ -368,83 +367,3 @@ the case migration scripts will be provided in the `schema/migration` folder, prefixed by the date of commit that introduced the changes. Those scripts shouldn't be used when initializing a new database, only when upgrading from a previous schema. - -## Current target API version - -At the moment, the current target API version is 1.8.0 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ModuleAPI callStatusComments
System ping Done
getLicense Done
Browsing getMusicFolders Done
getIndexes Done
getMusicDirectory Done
getGenres N/A From API v1.9.0
getArtists Done
getArtist Done
getAlbum Done
getSong Done
getVideos Done Actually returns an error as video support is not planned
Album/song lists getAlbumList Done
getAlbumList2 Done
getRandomSongs Done
getSongsByGenre N/A From API v1.9.0
getNowPlaying Done
getStarred Done
getStarred2 Done
Searching search Done
search2 Done
search3 Done
Playlists getPlaylists Done
getPlaylist Done
createPlaylist Done
updatePlaylist Done
deletePlaylist Done
Media retrieval stream Done
download Done
hls N/A Video related stuff, not planned
getCoverArt Done
getLyrics Done Use either text files or ChartLyrics API
getAvatar TODO Not that useful for a streaming server, but whatever
Media annotation star Done
unstar Done
setRating Done
scrobble Done
Sharing getShares TODO Need to look how this works on the official Subsonic server
createShare TODO
updateShare TODO
deleteShare TODO
Podcast getPodcasts N/A Not planning to support podcasts at the moment
refreshPodcasts N/A From API v1.9.0
createPodcastChannel N/A From API v1.9.0
deletePodcastChannel N/A From API v1.9.0
deletePodcastEpisode N/A From API v1.9.0
downloadPodcastEpisode N/A From API v1.9.0
Jukebox jukeboxControl N/A Not planning to support the Jukebox feature
Internet radio getInternetRadioStations N/A From API v1.9.0
Chat getChatMessages Done
addChatMessage Done
User management getUser Done
getUsers Done
createUser Done
deleteUser Done
changePassword Done
Bookmarks getBookmarks N/A From API v1.9.0
createBookmark N/A From API v1.9.0
deleteBookmark N/A From API v1.9.0