chore(docs): update api documentation
This commit is contained in:
@@ -1,18 +1,13 @@
|
||||
## Albums
|
||||
|
||||
Open an album from search or artist page.
|
||||
- Open from Search or an Artist page.
|
||||
- Actions:
|
||||
- Download full album or any track
|
||||
- Browse tracklist (order, artists, duration)
|
||||
- Large albums: tracks load in pages as you scroll
|
||||
- Explicit filter hides explicit tracks when enabled in Config
|
||||
|
||||
- Download
|
||||
- Download full album
|
||||
- Download individual tracks from the tracklist
|
||||
- Tracklist
|
||||
- Shows order, artists, and duration
|
||||
- Respects explicit filter (hidden if enabled)
|
||||
- Large albums
|
||||
- Tracks load progressively as you scroll
|
||||
|
||||
Backend endpoints used:
|
||||
|
||||
- GET `/api/album/info?id=...&limit=50&offset=...` (metadata + paged tracks)
|
||||
- GET `/api/album/download/{album_id}` (queue download)
|
||||
- GET `/api/progress/stream` (live queue updates)
|
||||
Endpoints:
|
||||
- GET `/api/album/info?id=...&limit=50&offset=...` — album metadata + paged tracks
|
||||
- GET `/api/album/download/{album_id}` — queue album download
|
||||
- GET `/api/prgs/stream` — live progress via SSE
|
||||
@@ -1,31 +1,26 @@
|
||||
## Artists
|
||||
|
||||
Open an artist from search.
|
||||
|
||||
- Discography
|
||||
- Albums, Singles, Compilations, Appears On sections
|
||||
- Infinite loading as you scroll
|
||||
- Download
|
||||
- Download all (queues albums respecting filters)
|
||||
- Open from Search.
|
||||
- Discography sections: Albums, Singles, Compilations, Appears On (infinite scroll)
|
||||
- Download:
|
||||
- Download all (queues albums by selected types)
|
||||
- Download any album individually
|
||||
- Watch
|
||||
- Add/remove artist to Watchlist (auto-download new releases when enabled)
|
||||
- Watch:
|
||||
- Add/remove artist to Watchlist
|
||||
- Configure release types and intervals in Configuration → Watch
|
||||
|
||||
How-to: monitor an artist
|
||||
|
||||
1. Search for the artist and open their page
|
||||
How to monitor an artist:
|
||||
1. Search the artist and open their page
|
||||
2. Click Watch
|
||||
3. Configure release types and intervals in Configuration → Watch
|
||||
|
||||
How-to: download discography
|
||||
3. Configure in Configuration → Watch
|
||||
|
||||
How to download discography:
|
||||
1. Open the artist page
|
||||
2. Choose release types (e.g., Albums, Singles, Compilations)
|
||||
3. Click Download All; track progress in Queue and History
|
||||
2. Select release types (Albums, Singles, Compilations)
|
||||
3. Click Download All; track in Queue and History
|
||||
|
||||
Backend endpoints used:
|
||||
|
||||
- GET `/api/artist/info?id=...&limit=20&offset=...` (metadata + paged albums)
|
||||
- GET `/api/artist/download/{artist_id}?album_type=album,single,compilation` (queue discography)
|
||||
Endpoints:
|
||||
- GET `/api/artist/info?id=...&limit=10&offset=...` — metadata + paged albums
|
||||
- GET `/api/artist/download/{artist_id}?album_type=album,single,compilation` — queue discography
|
||||
- PUT `/api/artist/watch/{artist_id}` / DELETE `/api/artist/watch/{artist_id}`
|
||||
- GET `/api/artist/watch/{artist_id}/status`
|
||||
@@ -9,7 +9,7 @@ Open Configuration in the web UI. Tabs:
|
||||
- Downloads (admin)
|
||||
- Concurrent downloads, retry behavior
|
||||
- Quality/format defaults and conversion
|
||||
- Real-time mode (Spotify only): aligns download time with track length
|
||||
- Real-time mode: aligns download time with track length
|
||||
- Formatting (admin)
|
||||
- File/folder naming patterns (examples)
|
||||
- `%artist%/%album%/%tracknum%. %title%`
|
||||
@@ -17,8 +17,8 @@ Open Configuration in the web UI. Tabs:
|
||||
- Accounts (admin)
|
||||
- Spotify: use `spotizerr-auth` to add credentials
|
||||
- Deezer ARL (optional):
|
||||
- Chrome/Edge: devtools → Application → Cookies → https://www.deezer.com → copy `arl`
|
||||
- Firefox: devtools → Storage → Cookies → https://www.deezer.com → copy `arl`
|
||||
- Chrome/Edge: DevTools → Application → Cookies → https://www.deezer.com → copy `arl`
|
||||
- Firefox: DevTools → Storage → Cookies → https://www.deezer.com → copy `arl`
|
||||
- Paste ARL in Accounts
|
||||
- Select main account when multiple exist
|
||||
- Watch (admin)
|
||||
@@ -31,17 +31,14 @@ Open Configuration in the web UI. Tabs:
|
||||
- Change password, view role and email
|
||||
|
||||
Quality formats (reference):
|
||||
|
||||
- Spotify: OGG 96k/160k/320k (320k requires Premium)
|
||||
- Deezer: MP3 128k/320k (320k may require Premium), FLAC (Premium)
|
||||
- Conversion: MP3/FLAC/AAC/OGG/OPUS/WAV/ALAC with custom bitrate
|
||||
|
||||
Fallback system:
|
||||
|
||||
- Configure primary and fallback services
|
||||
- Automatically switches if primary fails (useful for geo/account limits)
|
||||
|
||||
Notes:
|
||||
|
||||
- Explicit content filter applies in pages (e.g., hides explicit tracks on album/playlist views)
|
||||
- Watch system must be enabled before adding items
|
||||
Reference in New Issue
Block a user