diff --git a/changes/changelog.d/178.doc b/changes/changelog.d/178.doc new file mode 100644 index 0000000000000000000000000000000000000000..419e6984b80460904ec4859d8072554c133ca264 --- /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 0000000000000000000000000000000000000000..650b3885ea73c7192cc17edb5cb9169b5b06ca2f --- /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 </swagger/>`_ +were you can browse available endpoints and try the API. diff --git a/docs/index.rst b/docs/index.rst index 82dcf8c88d475ddf53cea25133ca80c4c4feae2d..cea50ea222e70a1fe7eec9c260de7e11e0bc2ace 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