summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorMaksim Pechnikov <parallel588@gmail.com>2019-09-16 07:34:22 +0300
committerMaksim Pechnikov <parallel588@gmail.com>2019-09-16 07:34:22 +0300
commitd75bc728e7e309174373e234079aa4825c81ab3e (patch)
tree1ac6b44f5758ff028103c37d3712520f45a0695e /docs/api
parent4f548cb2b7b4a16a956a4f4a0ff64d279777925e (diff)
parent2990c0a53b14646eab19b57d068ac8aa7e17ea4e (diff)
downloadpleroma-d75bc728e7e309174373e234079aa4825c81ab3e.tar.gz
pleroma-d75bc728e7e309174373e234079aa4825c81ab3e.zip
Merge branch 'develop' into issue/733
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.