phoenix/icarus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 33 Wiki Activity

Updated Version 1.0 API (markdown)

Kun Deng
2019-07-18 19:31:45 -04:00
parent be6a7d3b91
commit e14b33239e
1 changed files with 75 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Version-1.0-API.md
+75 -28
@@ -18,18 +18,18 @@ This page contains API documentation regarding version 1.0 if the API. For the s
**Request body**: **Request body**:
```Json ```Json
{ {
"username":"usr", "username" : "phoenix",
"password":"secret" "password" : "Flame"
} }
``` ```
**Response body**: **Response body**:
```Json ```Json
{ {
"id":1, "id" : 1,
"username":"usr", "username" : "phoenix",
"token":"dsfsdfnisdnosnfwefh923hr329hf29fb293fhn20jf20f", "token" : "dsfsdfnisdnosnfwefh923hr329hf29fb293fhn20jf20f",
"token_type":"Bearer", "token_type" : "Bearer",
"expiration":8000 "expiration" : 8000
} }
``` ```
### Register ### Register
@@ -39,21 +39,21 @@ This page contains API documentation regarding version 1.0 if the API. For the s
**Request body**: **Request body**:
```Json ```Json
{ {
"first_name":"Atman", "first_name" : "Atman",
"last_name":"Heron", "last_name" : "Heron",
"username":"ateron", "username" : "ateron",
"nickname":"heron", "nickname" : "heron",
"password":"secret", "password" : "secret",
"email":"elysium@aaru.org", "email" : "elysium@aaru.org",
"phone_number":"(789) 555-841" "phone_number" : "(789) 555-841"
} }
``` ```
**Response body**: **Response body**:
```Json ```Json
{ {
"username":"ateron", "username" : "ateron",
"successfully_registered":true, "successfully_registered" : true,
"message":"User successfully registered" "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**: **Request body**:
```Json ```Json
{ {
"title":"updated title", "title" : "updated title",
"artist":"updated artist", "artist" : "updated artist",
"album":"updated album", "album" : "updated album",
"genre":"updated genre", "genre" : "updated genre",
"year":"updated year" "year" : "updated year"
} }
``` ```
@@ -98,11 +98,15 @@ This page contains API documentation regarding version 1.0 if the API. For the s
**Response body**: **Response body**:
```Json ```Json
{ {
"title":"Song Title", "id" : 4,
"artist":"Artist or Band", "title" : "King",
"album":"Album Name", "artist" : "XXXTentacion",
"genre":"Genre", "album" : "Revenge",
"year":1970 "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 ### 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**: **Response body**:
```Json ```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"
}
] ]
``` ```