summaryrefslogtreecommitdiff
path: root/docs/API
diff options
context:
space:
mode:
authorlain <lain@soykaf.club>2020-07-10 12:26:53 +0200
committerlain <lain@soykaf.club>2020-07-10 12:26:53 +0200
commitb39eb6ecc573c310801fe49f35d92246ddcb6226 (patch)
tree32b20b5a0ec3f5c8d44f1157087868adfaa549b0 /docs/API
parent208baf157ad0c8be470566d5d51d0214c229e6a5 (diff)
parent8aa7143f464562ca2a0572087c526f26d1a3b7ef (diff)
downloadpleroma-b39eb6ecc573c310801fe49f35d92246ddcb6226.tar.gz
pleroma-b39eb6ecc573c310801fe49f35d92246ddcb6226.zip
Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into chat-federation-information
Diffstat (limited to 'docs/API')
-rw-r--r--docs/API/differences_in_mastoapi_responses.md7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/API/differences_in_mastoapi_responses.md b/docs/API/differences_in_mastoapi_responses.md
index 4514a7d59..65f9f1aef 100644
--- a/docs/API/differences_in_mastoapi_responses.md
+++ b/docs/API/differences_in_mastoapi_responses.md
@@ -72,6 +72,7 @@ Has these additional fields under the `pleroma` object:
- `unread_notifications_count`: The count of unread notifications. Only returned to the account owner.
- `notification_settings`: object, can be absent. See `/api/pleroma/notification_settings` for the parameters/keys returned.
- `accepts_chat_messages`: boolean, but can be null if we don't have that information about a user
+- `favicon`: nullable URL string, Favicon image of the user's instance
### Source
@@ -183,11 +184,13 @@ Additional parameters can be added to the JSON body/Form data:
- `pleroma_settings_store` - Opaque user settings to be saved on the backend.
- `skip_thread_containment` - if true, skip filtering out broken threads
- `allow_following_move` - if true, allows automatically follow moved following accounts
-- `pleroma_background_image` - sets the background image of the user.
+- `pleroma_background_image` - sets the background image of the user. Can be set to "" (an empty string) to reset.
- `discoverable` - if true, discovery of this account in search results and other services is allowed.
- `actor_type` - the type of this account.
- `accepts_chat_messages` - if false, this account will reject all chat messages.
+All images (avatar, banner and background) can be reset to the default by sending an empty string ("") instead of a file.
+
### Pleroma Settings Store
Pleroma has mechanism that allows frontends to save blobs of json for each user on the backend. This can be used to save frontend-specific settings for a user that the backend does not need to know about.
@@ -222,6 +225,8 @@ Has theses additional parameters (which are the same as in Pleroma-API):
`GET /api/v1/instance` has additional fields
- `max_toot_chars`: The maximum characters per post
+- `chat_limit`: The maximum characters per chat message
+- `description_limit`: The maximum characters per image description
- `poll_limits`: The limits of polls
- `upload_limit`: The maximum upload file size
- `avatar_upload_limit`: The same for avatars