From 56d9c5873c04b29b612a482e273fab637b2c42b0 Mon Sep 17 00:00:00 2001 From: Eliot Berriot Date: Thu, 26 Apr 2018 18:23:50 +0200 Subject: [PATCH] Fix #178: Foundations for API documentation with Swagger --- changes/changelog.d/178.doc | 1 + docs/api.rst | 6 ++++++ docs/index.rst | 1 + 3 files changed, 8 insertions(+) create mode 100644 changes/changelog.d/178.doc create mode 100644 docs/api.rst diff --git a/changes/changelog.d/178.doc b/changes/changelog.d/178.doc new file mode 100644 index 000000000..419e6984b --- /dev/null +++ b/changes/changelog.d/178.doc @@ -0,0 +1 @@ +Foundations for API documentation with Swagger (#178) diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 000000000..650b3885e --- /dev/null +++ b/docs/api.rst @@ -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 `_ +were you can browse available endpoints and try the API. diff --git a/docs/index.rst b/docs/index.rst index 82dcf8c88..cea50ea22 100644 --- 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