summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorrinpatch <rinpatch@sdf.org>2019-09-13 19:42:53 +0300
committerrinpatch <rinpatch@sdf.org>2019-09-13 19:42:53 +0300
commitba70a8cae6c0d00963dc1d9e80f915186397ad06 (patch)
treed0cfb4e9b6c8771b84f38b9d6175b47fbf4e442d /docs/api
parentac4a748fad34c02647bf72e802cd9d74205681fe (diff)
parent53a3ad60435d4f7eab2dbf1235e5974bac275aa0 (diff)
downloadpleroma-ba70a8cae6c0d00963dc1d9e80f915186397ad06.tar.gz
pleroma-ba70a8cae6c0d00963dc1d9e80f915186397ad06.zip
Merge branch 'develop' into feature/delivery-tracking
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/admin_api.md10
-rw-r--r--docs/api/pleroma_api.md14
2 files changed, 19 insertions, 5 deletions
diff --git a/docs/api/admin_api.md b/docs/api/admin_api.md
index d79c342be..fd608c459 100644
--- a/docs/api/admin_api.md
+++ b/docs/api/admin_api.md
@@ -60,9 +60,13 @@ Authentication is required and the user must be an admin.
- Method: `POST`
- Params:
- - `nickname`
- - `email`
- - `password`
+ `users`: [
+ {
+ `nickname`,
+ `email`,
+ `password`
+ }
+ ]
- Response: User’s nickname
## `/api/pleroma/admin/users/follow`
diff --git a/docs/api/pleroma_api.md b/docs/api/pleroma_api.md
index 7d343e97a..30fac77da 100644
--- a/docs/api/pleroma_api.md
+++ b/docs/api/pleroma_api.md
@@ -252,7 +252,7 @@ See [Admin-API](Admin-API.md)
* Params:
* `email`: email of that needs to be verified
* Authentication: not required
-* Response: 204 No Content
+* Response: 204 No Content
## `/api/v1/pleroma/mascot`
### Gets user mascot image
@@ -321,11 +321,21 @@ See [Admin-API](Admin-API.md)
}
```
+## `/api/pleroma/change_email`
+### Change account email
+* Method `POST`
+* Authentication: required
+* Params:
+ * `password`: user's password
+ * `email`: new email
+* Response: JSON. Returns `{"status": "success"}` if the change was successful, `{"error": "[error message]"}` otherwise
+* Note: Currently, Mastodon has no API for changing email. If they add it in future it might be incompatible with Pleroma.
+
# Pleroma Conversations
Pleroma Conversations have the same general structure that Mastodon Conversations have. The behavior differs in the following ways when using these endpoints:
-1. Pleroma Conversations never add or remove recipients, unless explicitly changed by the user.
+1. Pleroma Conversations never add or remove recipients, unless explicitly changed by the user.
2. Pleroma Conversations statuses can be requested by Conversation id.
3. Pleroma Conversations can be replied to.