mirror of
https://github.com/spl0k/supysonic.git
synced 2024-11-23 10:26:18 +00:00
Created API implementation status (markdown)
Alban
parent
cbab88b611
commit
9f1645827f
77
API-implementation-status.md
Normal file
77
API-implementation-status.md
Normal file
@ -0,0 +1,77 @@
|
|||||||
|
**Current target API version:** 1.8.0
|
||||||
|
|
||||||
|
<table>
|
||||||
|
<tr><th>Module</th><th>API call</th><th>Status</th><th>Comments</th></tr>
|
||||||
|
|
||||||
|
<tr><th rowspan="2">System</th> <td>ping</td> <td style="background-color: green">Done</td> <td></td></tr>
|
||||||
|
<tr> <td>getLicense</td> <td>Done</td> <td>Return we don't have a valid license, but we don't do licensing here ;)</td></tr>
|
||||||
|
|
||||||
|
<tr><th rowspan="9">Browsing</th> <td>getMusicFolders</td> <td>Done</td> <td></td></tr>
|
||||||
|
<tr> <td>getIndexes</td> <td>Done</td> <td></td></tr>
|
||||||
|
<tr> <td>getMusicDirectory</td> <td>Done</td> <td></td></tr>
|
||||||
|
<tr> <td>getGenres</td> <td>N/A</td> <td>From API v1.9.0</td></tr>
|
||||||
|
<tr> <td>getArtists</td> <td>Done</td> <td></td></tr>
|
||||||
|
<tr> <td>getArtist</td> <td>Done</td> <td></td></tr>
|
||||||
|
<tr> <td>getAlbum</td> <td>Done</td> <td></td></tr>
|
||||||
|
<tr> <td>getSong</td> <td>Done</td> <td></td></tr>
|
||||||
|
<tr> <td>getVideos</td> <td>Done</td> <td>Actually returns an error as video support is not planned</td></tr>
|
||||||
|
|
||||||
|
<tr><th rowspan="7">Album/song lists</th> <td>getAlbumList</td> <td><strong>Partial</strong></td> <td>Missing <em>highest</em> and <em>starred</em></td></tr>
|
||||||
|
<tr> <td>getAlbumList2</td> <td><strong>Partial</strong></td> <td>Missing <em>starred</em></td></tr>
|
||||||
|
<tr> <td>getRandomSongs</td> <td>Done</td> <td></td></tr>
|
||||||
|
<tr> <td>getSongsByGenre</td> <td>N/A</td> <td>From API v1.9.0</td></tr>
|
||||||
|
<tr> <td>getNowPlaying</td> <td><strong>Partial</strong></td> <td>Currently only supports SQLite</td></tr>
|
||||||
|
<tr> <td>getStarred</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>getStarred2</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
|
||||||
|
<tr><th rowspan="3">Searching</th> <td>search</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>search2</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>search3</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
|
||||||
|
<tr><th rowspan="5">Playlists</th> <td>getPlaylists</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>getPlaylist</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>createPlaylist</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>updatePlaylist</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>deletePlaylist</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
|
||||||
|
<tr><th rowspan="6">Media retrieval</th> <td>stream</td> <td><strong>Partial</strong></td> <td>Missing transcoding, etc.</td></tr>
|
||||||
|
<tr> <td>download</td> <td>Done</td> <td></td></tr>
|
||||||
|
<tr> <td>hls</td> <td>N/A</td> <td>I need more info to know where it's used</td></tr>
|
||||||
|
<tr> <td>getCoverArt</td> <td>Done</td> <td></td></tr>
|
||||||
|
<tr> <td>getLyrics</td> <td><strong>TODO</strong></td> <td>Might use third-party website providing an API</td></tr>
|
||||||
|
<tr> <td>getAvatar</td> <td><strong>TODO</strong></td> <td>Not that useful for a streaming server, but whatever</td></tr>
|
||||||
|
|
||||||
|
<tr><th rowspan="4">Media annotation</th> <td>star</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>unstar</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>setRating</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>scrobble</td> <td>Done</td> <td></td></tr>
|
||||||
|
|
||||||
|
<tr><th rowspan="4">Sharing</th> <td>getShares</td> <td><strong>TODO</strong></td> <td rowspan="4">Need to look how this works on the official Subsonic server</td></tr>
|
||||||
|
<tr> <td>createShare</td> <td><strong>TODO</strong></td></tr>
|
||||||
|
<tr> <td>updateShare</td> <td><strong>TODO</strong></td></tr>
|
||||||
|
<tr> <td>deleteShare</td> <td><strong>TODO</strong></td></tr>
|
||||||
|
|
||||||
|
<tr><th rowspan="6">Podcast</th> <td>getPodcasts</td> <td>N/A</td> <td>Not planning to support podcasts at the moment</td></tr>
|
||||||
|
<tr> <td>refreshPodcasts</td> <td>N/A</td> <td>From API v1.9.0</td></tr>
|
||||||
|
<tr> <td>createPodcastChannel</td> <td>N/A</td> <td>From API v1.9.0</td></tr>
|
||||||
|
<tr> <td>deletePodcastChannel</td> <td>N/A</td> <td>From API v1.9.0</td></tr>
|
||||||
|
<tr> <td>deletePodcastEpisode</td> <td>N/A</td> <td>From API v1.9.0</td></tr>
|
||||||
|
<tr> <td>downloadPodcastEpisode</td> <td>N/A</td> <td>From API v1.9.0</td></tr>
|
||||||
|
|
||||||
|
<tr><th>Jukebox</th> <td>jukeboxControl</td> <td>N/A</td> <td>Not planning to support the Jukebox feature</td></tr>
|
||||||
|
|
||||||
|
<tr><th>Internet radio</th> <td>getInternetRadioStations </td> <td>N/A</td> <td>From API v1.9.0</td></tr>
|
||||||
|
|
||||||
|
<tr><th rowspan="2">Chat</th> <td>getChatMessages</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>addChatMessage </td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
|
||||||
|
<tr><th rowspan="5">User management</th> <td>getUser</td> <td>Done</td> <td></td></tr>
|
||||||
|
<tr> <td>getUsers</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>createUser</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>deleteUser</td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
<tr> <td>changePassword </td> <td><strong>TODO</strong></td> <td></td></tr>
|
||||||
|
|
||||||
|
<tr><th rowspan="3">Bookmarks</th> <td>getBookmarks</td> <td>N/A</td> <td>From API v1.9.0</td></tr>
|
||||||
|
<tr> <td>createBookmark</td> <td>N/A</td> <td>From API v1.9.0</td></tr>
|
||||||
|
<tr> <td>deleteBookmark</td> <td>N/A</td> <td>From API v1.9.0</td></tr>
|
||||||
|
</table>
|
||||||
Loading…
Reference in New Issue
Block a user