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

API doc introduction

This commit is contained in:
Eliot Berriot 2019-03-26 17:21:44 +01:00
parent f8e30736a2
commit 659c355ad8
No known key found for this signature in database
GPG Key ID: DD6965E2476E5C27
1 changed files with 21 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/swagger.yml
View File

@ -15,6 +15,27 @@ info:
The API is **not** freezed yet, but we will document breaking changes in our changelog, The API is **not** freezed yet, but we will document breaking changes in our changelog,
and try to avoid those as much as possible. and try to avoid those as much as possible.
Usage
-----
Click on an endpoint name to inspect its properties, parameters and responses.
Use the "Try it out" button to send a real world payload to the endpoint and inspect
the corresponding response.
Authentication
--------------
To authenticate, use the `/token/` endpoint with a username and password, and copy/paste
the resulting JWT token in the `Authorize` modal. All subsequent requests made via the interactive
documentation will be authenticated.
If you keep the default server (https://demo.funkwhale.audio), the default username and password
couple is "demo" and "demo".
Resources
---------
For more targeted guides regarding API usage, and especially authentication, please For more targeted guides regarding API usage, and especially authentication, please
refer to [https://docs.funkwhale.audio/api.html](https://docs.funkwhale.audio/api.html) refer to [https://docs.funkwhale.audio/api.html](https://docs.funkwhale.audio/api.html)