MirrorMirror
/
funkwhale
mirror of https://dev.funkwhale.audio/funkwhale/funkwhale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix #178: Foundations for API documentation with Swagger

This commit is contained in:
Eliot Berriot 2018-04-26 18:23:50 +02:00
parent c4777532eb
commit 56d9c5873c
No known key found for this signature in database
GPG Key ID: DD6965E2476E5C27
3 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changes/changelog.d/178.doc Normal file
View File

@ -0,0 +1 @@
Foundations for API documentation with Swagger (#178)

6
docs/api.rst Normal file
View File

@ -0,0 +1,6 @@
Funkwhale API
=============
Funkwhale API is still a work in progress and should not be considered as
stable. We offer an `interactive documentation using swagger </swagger/>`_
were you can browse available endpoints and try the API.

1
docs/index.rst
View File

@ -16,6 +16,7 @@ Funkwhale is a self-hosted, modern free and open-source music server, heavily in
configuration configuration
importing-music importing-music
federation federation
api
upgrading upgrading
changelog changelog