Merge branch 'feature/jobs' into 'develop'

[akkoma] / docs / Pleroma-API.md

diff --git a/docs/Pleroma-API.md b/docs/Pleroma-API.md
index 3ebea565cc49ab5a43fc50a954e66ec23b1331fc..379d3dbed9d997b257c57803df94d88bab63716c 100644 (file)
--- a/docs/Pleroma-API.md
+++ b/docs/Pleroma-API.md
@@ -52,6 +52,7 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi
     * `confirm`
     * `captcha_solution`: optional, contains provider-specific captcha solution,
     * `captcha_token`: optional, contains provider-specific captcha token
+    * `token`: invite token required when the registerations aren't public.
 * Response: JSON. Returns a user object on success, otherwise returns `{"error": "error_msg"}`
 * Example response:
 ```
@@ -93,3 +94,17 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi
 
 ## `/api/pleroma/admin/`…
 See [Admin-API](Admin-API.md)
+
+## `/api/v1/pleroma/flavour/:flavour`
+* Method `POST`
+* Authentication: required
+* Response: JSON string. Returns the user flavour or the default one on success, otherwise returns `{"error": "error_msg"}`
+* Example response: "glitch"
+* Note: This is intended to be used only by mastofe
+
+## `/api/v1/pleroma/flavour`
+* Method `GET`
+* Authentication: required
+* Response: JSON string. Returns the user flavour or the default one.
+* Example response: "glitch"
+* Note: This is intended to be used only by mastofe