From e14b33239e8517016b9af6b63a33ea6c4103b031 Mon Sep 17 00:00:00 2001 From: Kun Deng Date: Thu, 18 Jul 2019 19:31:45 -0400 Subject: [PATCH] Updated Version 1.0 API (markdown) --- Version-1.0-API.md | 103 +++++++++++++++++++++++++++++++++------------ 1 file changed, 75 insertions(+), 28 deletions(-) diff --git a/Version-1.0-API.md b/Version-1.0-API.md index 2114354..591d76e 100644 --- a/Version-1.0-API.md +++ b/Version-1.0-API.md @@ -18,18 +18,18 @@ This page contains API documentation regarding version 1.0 if the API. For the s **Request body**: ```Json { - "username":"usr", - "password":"secret" + "username" : "phoenix", + "password" : "Flame" } ``` **Response body**: ```Json { - "id":1, - "username":"usr", - "token":"dsfsdfnisdnosnfwefh923hr329hf29fb293fhn20jf20f", - "token_type":"Bearer", - "expiration":8000 + "id" : 1, + "username" : "phoenix", + "token" : "dsfsdfnisdnosnfwefh923hr329hf29fb293fhn20jf20f", + "token_type" : "Bearer", + "expiration" : 8000 } ``` ### Register @@ -39,21 +39,21 @@ This page contains API documentation regarding version 1.0 if the API. For the s **Request body**: ```Json { - "first_name":"Atman", - "last_name":"Heron", - "username":"ateron", - "nickname":"heron", - "password":"secret", - "email":"elysium@aaru.org", - "phone_number":"(789) 555-841" + "first_name" : "Atman", + "last_name" : "Heron", + "username" : "ateron", + "nickname" : "heron", + "password" : "secret", + "email" : "elysium@aaru.org", + "phone_number" : "(789) 555-841" } ``` **Response body**: ```Json { - "username":"ateron", - "successfully_registered":true, - "message":"User successfully registered" + "username" : "ateron", + "successfully_registered" : true, + "message" : "User successfully registered" } ``` @@ -83,11 +83,11 @@ This page contains API documentation regarding version 1.0 if the API. For the s **Request body**: ```Json { - "title":"updated title", - "artist":"updated artist", - "album":"updated album", - "genre":"updated genre", - "year":"updated year" + "title" : "updated title", + "artist" : "updated artist", + "album" : "updated album", + "genre" : "updated genre", + "year" : "updated year" } ``` @@ -98,11 +98,15 @@ This page contains API documentation regarding version 1.0 if the API. For the s **Response body**: ```Json { - "title":"Song Title", - "artist":"Artist or Band", - "album":"Album Name", - "genre":"Genre", - "year":1970 + "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 @@ -112,6 +116,49 @@ This page contains API documentation regarding version 1.0 if the API. For the s **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