Chewing_Bever
/
jos
Archived
1
0
Fork 0
Code Issues 5 Pull Requests 18 Projects 1 Releases Wiki Activity

Started api design

pull/3/head
Jef Roosens 2021-04-02 15:29:36 +02:00
parent 5287fd818e
commit 15d8879b75
Signed by: Jef Roosens
GPG Key ID: B580B976584B5F30
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
ideation.md 100644
View File

@ -0,0 +1,26 @@
# Ideation
This file just serves as a central point for all the ideas I have for this
project.
## Used software/services
* Spotify API to look up album information
* YouTubeDL to download the videos
* Something to set the mp3 tags, not sure about this one yet
## API Design
### Endpoints
* `GET /search?q=`
* search for albums & tracks, given a search query
* returns a list of albums/tracks (basically the same as the API, just
cleaned up a bit)
* `GET /albums?ids=`: get detailed information about an album/a list of albums.
I'm not actually sure if I need this one.
* `GET /tracks?ids=`: get detailed information about a track/a list of tracks.
* `GET /tracks/videos?id=`: given a track, search YouTube for videos about the
track. Returns a list of youtube ids
* `POST /tracks/download`: download a track. The data should contain the wanted
metadata in the file & the id of the youtube video