Add a note about compatibility with Mastodon
authorEgor Kislitsyn <egor@kislitsyn.com>
Wed, 28 Aug 2019 07:50:58 +0000 (14:50 +0700)
committerEgor Kislitsyn <egor@kislitsyn.com>
Fri, 13 Sep 2019 06:09:37 +0000 (13:09 +0700)
docs/api/pleroma_api.md

index 8a726a7cbec1a3bc0acad253cd003b16c0eda2c1..30fac77dad7d20b1af3c70b7d83d1fe2cb6c82d4 100644 (file)
@@ -329,12 +329,13 @@ See [Admin-API](Admin-API.md)
     * `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.