Fix #178: Foundations for API documentation with Swagger

56d9c587 · Eliot Berriot · c4777532 · 56d9c587 · 56d9c587 · 56d9c587
Verified Commit 56d9c587 authored 6 years ago by Eliot Berriot
--- a/changes/changelog.d/178.doc
+++ b/changes/changelog.d/178.doc
+Foundations for API documentation with Swagger (#178)
--- a/docs/api.rst
+++ b/docs/api.rst
+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.
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,6 +16,7 @@ Funkwhale is a self-hosted, modern free and open-source music server, heavily in
   configuration
   importing-music
   federation
+   api
   upgrading
   changelog