aboutsummaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorSachin Joshi <satchin.joshi@gmail.com>2019-05-23 09:45:12 +0200
committerSachin Joshi <satchin.joshi@gmail.com>2019-05-23 09:45:12 +0200
commit0c53d91f3bfe7bbd8d8b9ffd332ac2f57b6aba34 (patch)
tree724bd17a5ed9d89827b3095e149cfda4fb10fe61 /docs/api
parent17bfd000d7d44ff13cf7becbfd9ce08b896d66eb (diff)
parent75e78d4e239a5c999306e92b181b0e29c52dc9db (diff)
downloadpleroma-0c53d91f3bfe7bbd8d8b9ffd332ac2f57b6aba34.tar.gz
fix merge conflict
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/pleroma_api.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/api/pleroma_api.md b/docs/api/pleroma_api.md
index dd0b6ca73..4d99a2d2b 100644
--- a/docs/api/pleroma_api.md
+++ b/docs/api/pleroma_api.md
@@ -252,6 +252,45 @@ See [Admin-API](Admin-API.md)
]
```
+## `/api/v1/pleroma/mascot`
+### Gets user mascot image
+* Method `GET`
+* Authentication: required
+
+* Response: JSON. Returns a mastodon media attachment entity.
+* Example response:
+```json
+{
+ "id": "abcdefg",
+ "url": "https://pleroma.example.org/media/abcdefg.png",
+ "type": "image",
+ "pleroma": {
+ "mime_type": "image/png"
+ }
+}
+```
+
+### Updates user mascot image
+* Method `PUT`
+* Authentication: required
+* Params:
+ * `image`: Multipart image
+* Response: JSON. Returns a mastodon media attachment entity
+ when successful, otherwise returns HTTP 415 `{"error": "error_msg"}`
+* Example response:
+```json
+{
+ "id": "abcdefg",
+ "url": "https://pleroma.example.org/media/abcdefg.png",
+ "type": "image",
+ "pleroma": {
+ "mime_type": "image/png"
+ }
+}
+```
+* Note: Behaves exactly the same as `POST /api/v1/upload`.
+ Can only accept images - any attempt to upload non-image files will be met with `HTTP 415 Unsupported Media Type`.
+
## `/api/pleroma/notification_settings`
### Updates user notification settings
* Method `PUT`