From f0c76f343fc07ebf96575bb8e6e707d66a7592eb Mon Sep 17 00:00:00 2001 From: Kun Deng Date: Thu, 18 Jul 2019 19:39:10 -0400 Subject: [PATCH] Updated Song (markdown) --- Song.md | 105 +++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 104 insertions(+), 1 deletion(-) diff --git a/Song.md b/Song.md index a5d2c35..72a34ae 100644 --- a/Song.md +++ b/Song.md @@ -1 +1,104 @@ -## Song \ No newline at end of file +## Song +### Uploading Song +**URI**: https://icarus-demo.com/api/v1/song/data +**Method**: Post +**Content type**: multipart/form-data +**Authorization**: Bearer ``token`` +**File**: @file=/path/to/song/you/wish/to/upload.mp3 + +### Downloading Song +**URI**: https://icarus-demo.com/api/v1/song/data/id +**Method**: Get +**Authorization**: Bearer ``token`` + +### Delete Song +**URL**: https://icarus-demo.com/api/v1/song/id +**Method**: Delete +**Authorization**: Bearer ``token`` + +### Updating Song Metadata +**URI**: https://icarus-demo.com/api/v1/song/id +**Method**: Update +**Authorization**: Bearer ``token`` +**Request body**: +```Json +{ + "title" : "updated title", + "artist" : "updated artist", + "album" : "updated album", + "genre" : "updated genre", + "year" : "updated year" +} +``` + +### Retrieve Song Metadata +**URI**: https://icarus-demo.com/api/v1/song/id +**Method**: Get +**Authorization**: Bearer ``token`` +**Response body**: +```Json +{ + "id" : 4, + "title" : "King", + "artist" : "XXXTentacion", + "album" : "Revenge", + "genre" : "Hip-Hop/R&B", + "year" : 2017, + "duration" : 113, + "filename" : "track05.mp3", + "song_path" : "/home/phoenix/software/Icarus/Music/XXXTentacion/Revenge/track05.mp3" +} +``` +### Retrieve all Song Metadata +**URI**: https://icarus-demo.com/api/v1/song +**Method**: Get +**Authorization**: Bearer ``token`` +**Response body**: +```Json +[ + { + "id" : 1, + "title" : "Two Steppin'", + "artist" : "Gerald Albright", + "album" : "Giving Myself To You", + "genre" : "Jazz", + "year" : 1995, + "duration" : 387, + "filename" : "track07.mp3", + "song_path" : "/home/phoenix/software/Icarus/Music/Gerald Albright/Giving Myself To You/track07.mp3" + }, + { + "id" : 2, + "title" : "Look Thru My Eyes", + "artist" : "DMX", + "album" : "It's Dark and Hell Is Hot", + "genre" : "Hip-Hop", + "year" : 1998, + "duration" : 231, + "filename" : "track05.mp3", + "song_path" : "/home/phoenix/software/Icarus/Music/DMX/It's Dark and Hell Is Hot/track05.mp3" + }, + { + "id" : 3, + "title" : "The Patient", + "artist" : "Tool", + "album" : "Lateralus", + "genre" : "Progressive Metal", + "year" : 2001, + "duration" : 434, + "filename" : "track03.mp3", + "song_path" : "/home/phoenix/software/Icarus/Music/Tool/Lateralus/track03.mp3" + }, + { + "id" : 4, + "title" : "King", + "artist" : "XXXTentacion", + "album" : "Revenge", + "genre" : "Hip-Hop/R&B", + "year" : 2017, + "duration" : 113, + "filename" : "track05.mp3", + "song_path" : "/home/phoenix/software/Icarus/Music/XXXTentacion/Revenge/track05.mp3" + } +] +``` \ No newline at end of file