Updated Song (markdown)

2019-07-18 19:39:10 -04:00
parent f2602265af
commit f0c76f343f
1 changed files with 104 additions and 1 deletions
@@ -1 +1,104 @@
 ## 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"
+   }
+]
+```