mirror of
https://github.com/spl0k/supysonic.git
synced 2024-11-12 21:22:17 +00:00
Rework API-INFO.md
Using GFM and not HTML tables, keeping it under 80 cols
This commit is contained in:
Alban
GitHub
parent
5e51468246
commit
fb79fc3f18
174
API-INFOS.md
174
API-INFOS.md
@ -2,78 +2,130 @@
|
||||
|
||||
At the moment, the current target API version is 1.8.0
|
||||
|
||||
<table>
|
||||
<tr><th>Module</th><th>API call</th><th>Status</th><th>Comments</th></tr>
|
||||
## System
|
||||
|
||||
<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></td></tr>
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `ping` | Done | |
|
||||
| `getLicense` | Done | |
|
||||
|
||||
<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>
|
||||
## Browsing
|
||||
|
||||
<tr><th rowspan="7">Album/song lists</th> <td>getAlbumList</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>getAlbumList2</td> <td>Done</td> <td></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>Done</td> <td></td></tr>
|
||||
<tr> <td>getStarred</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>getStarred2</td> <td>Done</td> <td></td></tr>
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `getMusicFolders` | Done | |
|
||||
| `getIndexes` | Done | |
|
||||
| `getMusicDirectory` | Done | |
|
||||
| `getGenres` | N/A | From API v1.9.0 |
|
||||
| `getArtists` | Done | |
|
||||
| `getArtist` | Done | |
|
||||
| `getAlbum` | Done | |
|
||||
| `getSong` | Done | |
|
||||
| `getVideos` | Done | Not planned, returns an error |
|
||||
|
||||
<tr><th rowspan="3">Searching</th> <td>search</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>search2</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>search3</td> <td>Done</td> <td></td></tr>
|
||||
## Album/song lists
|
||||
|
||||
<tr><th rowspan="5">Playlists</th> <td>getPlaylists</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>getPlaylist</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>createPlaylist</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>updatePlaylist</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>deletePlaylist</td> <td>Done</td> <td></td></tr>
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `getAlbumList` | Done | |
|
||||
| `getAlbumList2` | Done | |
|
||||
| `getRandomSongs` | Done | |
|
||||
| `getSongsByGenre` | N/A | From API v1.9.0 |
|
||||
| `getNowPlaying` | Done | |
|
||||
| `getStarred` | Done | |
|
||||
| `getStarred2` | Done | |
|
||||
|
||||
<tr><th rowspan="6">Media retrieval</th> <td>stream</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>download</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>hls</td> <td>N/A</td> <td>Video related stuff, not planned</td></tr>
|
||||
<tr> <td>getCoverArt</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>getLyrics</td> <td>Done</td> <td>Use either text files or ChartLyrics API</td></tr>
|
||||
<tr> <td>getAvatar</td> <td><strong>TODO</strong></td> <td>Not that useful for a streaming server, but whatever</td></tr>
|
||||
## Searching
|
||||
|
||||
<tr><th rowspan="4">Media annotation</th> <td>star</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>unstar</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>setRating</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>scrobble</td> <td>Done</td> <td></td></tr>
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `search` | Done | |
|
||||
| `search2` | Done | |
|
||||
| `search3` | Done | |
|
||||
|
||||
<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>
|
||||
## Playlists
|
||||
|
||||
<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>
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `getPlaylists` | Done | |
|
||||
| `getPlaylist` | Done | |
|
||||
| `createPlaylist` | Done | |
|
||||
| `updatePlaylist` | Done | |
|
||||
| `deletePlaylist` | Done | |
|
||||
|
||||
<tr><th>Jukebox</th> <td>jukeboxControl</td> <td>N/A</td> <td>Not planning to support the Jukebox feature</td></tr>
|
||||
## Media retrieval
|
||||
|
||||
<tr><th>Internet radio</th> <td>getInternetRadioStations </td> <td>N/A</td> <td>From API v1.9.0</td></tr>
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `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 | |
|
||||
|
||||
<tr><th rowspan="2">Chat</th> <td>getChatMessages</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>addChatMessage </td> <td>Done</td> <td></td></tr>
|
||||
## Media annotation
|
||||
|
||||
<tr><th rowspan="5">User management</th> <td>getUser</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>getUsers</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>createUser</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>deleteUser</td> <td>Done</td> <td></td></tr>
|
||||
<tr> <td>changePassword </td> <td>Done</td> <td></td></tr>
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `star` | Done | |
|
||||
| `unstar` | Done | |
|
||||
| `setRating` | Done | |
|
||||
| `scrobble` | Done | |
|
||||
|
||||
<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>
|
||||
## Sharing
|
||||
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `getShares` | TODO | |
|
||||
| `createShare` | TODO | |
|
||||
| `updateShare` | TODO | |
|
||||
| `deleteShare` | TODO | |
|
||||
|
||||
## Podcast
|
||||
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `getPodcasts` | N/A | Not planned |
|
||||
| `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
|
||||
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `jukeboxControl` | N/A | Not planned |
|
||||
|
||||
## Internet radio
|
||||
|
||||
| API call | Status | Comments |
|
||||
|----------------------------|--------|----------------------------------------|
|
||||
| `getInternetRadioStations` | N/A | From API v1.9.0 |
|
||||
|
||||
## Chat
|
||||
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `getChatMessages` | Done | |
|
||||
| `addChatMessage` | Done | |
|
||||
|
||||
## User management
|
||||
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `getUser` | Done | |
|
||||
| `getUsers` | Done | |
|
||||
| `createUser` | Done | |
|
||||
| `deleteUser` | Done | |
|
||||
| `changePassword` | Done | |
|
||||
|
||||
## Bookmarks
|
||||
|
||||
| API call | Status | Comments |
|
||||
|--------------------------|--------|------------------------------------------|
|
||||
| `getBookmarks` | N/A | From API v1.9.0 |
|
||||
| `createBookmark` | N/A | From API v1.9.0 |
|
||||
| `deleteBookmark` | N/A | From API v1.9.0 |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user