From 2372ed59f2868140bceb6b4e4b0438173ac9b322 Mon Sep 17 00:00:00 2001 From: Kun Deng Date: Wed, 17 Jul 2019 20:32:05 -0400 Subject: [PATCH] Updated API (markdown) --- API.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/API.md b/API.md index 9d63a79..a1199c5 100644 --- a/API.md +++ b/API.md @@ -1,5 +1,12 @@ # API Documentation -Icarus provides users with functionality to upload, download, and stream their own music collection. In addition to that one can read information of a their collection such as how many songs do you own by an artist, how many genres of a song do you own, updating the title of a song. This is achieved by the API. This portion of the documentation will list all API HTTP endpoints and how to use them. +Icarus provides users with functionality to upload, download, and stream their own music collection. In addition to that one can read information of a their music collection such as how many songs do you own by an artist, how many genres of a song do you own, and updating the title of a song. This is achieved via the HTTP endpoints provided by the API. + +Though Icarus versioning convention may not exactly coincide the versioning of the API endpoints, they still apply. What is meant by this is if there is an Icarus version of ``v.0.1.4`` then the documentation of that version would be ``v1``. + +The naming convention of the API HTTP endpoints will follow this naming convention: +``https://domain-name.com/api/v[**api version number**]/`` + + This portion of the documentation will list all versions of the API and how to use the endpoints ### API Versions * [Version 1](https://github.com/amazing-username/Icarus/wiki/Version-1.0-API) \ No newline at end of file