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

Documentation

This commit is contained in:
Agate 2020-08-19 19:55:18 +02:00
parent 607e492952
commit f15f9b9d5f
1 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/swagger.yml
View File

@ -14,10 +14,10 @@ info:
Use the "Try it out" button to send a real world payload to the endpoint and inspect Use the "Try it out" button to send a real world payload to the endpoint and inspect
the corresponding response. the corresponding response.
Authentication OAuth Authentication
-------------- --------------------
To authenticate, use OAuth. You can register your own app using the `/api/v1/oauth/apps/` endpoint. Proceed to the standard OAuth flow afterwards: You can register your own OAuth app using the `/api/v1/oauth/apps/` endpoint. Proceed to the standard OAuth flow afterwards:
- Our authorize URL is at `/authorize` - Our authorize URL is at `/authorize`
- Our token acquisition and refresh URL is at `/api/v1/oauth/token` - Our token acquisition and refresh URL is at `/api/v1/oauth/token`
@ -27,6 +27,13 @@ info:
You can use our demo server at `https://demo.funkwhale.audio` for testing purposes. You can use our demo server at `https://demo.funkwhale.audio` for testing purposes.
Application token authentication
--------------------------------
If using OAuth isn't practical and you have an account on the Funkwhale pod, you can create an application by visiting `/settings`.
Once the application is created, you can authenticate using its access token in the `Authorization` header, like this: `Authorization: Bearer <token>`.
Rate limiting Rate limiting
------------- -------------