From 659c355ad849608e1f8b410b5caefffaee36b3f6 Mon Sep 17 00:00:00 2001 From: Eliot Berriot Date: Tue, 26 Mar 2019 17:21:44 +0100 Subject: [PATCH] API doc introduction --- docs/swagger.yml | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/swagger.yml b/docs/swagger.yml index 4a1327e94..d83171698 100644 --- a/docs/swagger.yml +++ b/docs/swagger.yml @@ -15,6 +15,27 @@ info: The API is **not** freezed yet, but we will document breaking changes in our changelog, 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 refer to [https://docs.funkwhale.audio/api.html](https://docs.funkwhale.audio/api.html)