aboutsummaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorrinpatch <rinpatch@sdf.org>2019-06-01 16:29:58 +0300
committerrinpatch <rinpatch@sdf.org>2019-06-01 16:29:58 +0300
commit65db5e9f528a3f8d8b3c81953fd160a6744dfffd (patch)
tree9da5234f8a9dd411b59e839eeb38254822939e2f /docs/api
parent300d94c62829d0ec961f3ed6c0242dea102ab0ad (diff)
parentf8d4c02431aa634dc74074b93d1cb522e47056ce (diff)
downloadpleroma-65db5e9f528a3f8d8b3c81953fd160a6744dfffd.tar.gz
Resolve merge conflicts
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`