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

Updated API (markdown)

Kun Deng
2019-07-17 20:32:05 -04:00
parent da3ac61c4d
commit 2372ed59f2
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
API.md
+8 -1
@@ -1,5 +1,12 @@
# API Documentation # 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 ### API Versions
* [Version 1](https://github.com/amazing-username/Icarus/wiki/Version-1.0-API) * [Version 1](https://github.com/amazing-username/Icarus/wiki/Version-1.0-API)