diff options
| author | marcin mikołajczak <me@mkljczk.pl> | 2024-09-14 17:46:33 +0000 |
|---|---|---|
| committer | marcin mikołajczak <me@mkljczk.pl> | 2024-09-14 17:46:33 +0000 |
| commit | c1a1150888f48448d353897327d4d3f050bec9b4 (patch) | |
| tree | 1215315593855ef6be10085b8f164954d79b1211 /docs | |
| parent | 0111659a1f8e637b046c905551d7d5251d6c2efa (diff) | |
| parent | 917ac89b4f944a80b1d168fd07d94c762ee04ed9 (diff) | |
| download | pleroma-c1a1150888f48448d353897327d4d3f050bec9b4.tar.gz pleroma-c1a1150888f48448d353897327d4d3f050bec9b4.zip | |
Merge branch 'profile-image-descriptions' into 'develop'
Allow providing avatar/header descriptions
See merge request pleroma/pleroma!4227
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development/API/differences_in_mastoapi_responses.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/development/API/differences_in_mastoapi_responses.md b/docs/development/API/differences_in_mastoapi_responses.md index 3bf8637f8..cbd0d6bce 100644 --- a/docs/development/API/differences_in_mastoapi_responses.md +++ b/docs/development/API/differences_in_mastoapi_responses.md @@ -104,7 +104,7 @@ Has these additional fields under the `pleroma` object: - `background_image`: nullable URL string, background image of the user - `tags`: Lists an array of tags for the user - `relationship` (object): Includes fields as documented for Mastodon API https://docs.joinmastodon.org/entities/relationship/ -- `is_moderator`: boolean, nullable, true if user is a moderator +- `is_moderator`: boolean, nullable, true if user is a moderator - `is_admin`: boolean, nullable, true if user is an admin - `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated - `hide_favorites`: boolean, true when the user has hiding favorites enabled @@ -121,6 +121,8 @@ Has these additional fields under the `pleroma` object: - `notification_settings`: object, can be absent. See `/api/v1/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 +- `avatar_description`: string, image description for user avatar, defaults to empty string +- `header_description`: string, image description for user banner, defaults to empty string ### Source @@ -256,6 +258,8 @@ Additional parameters can be added to the JSON body/Form data: - `actor_type` - the type of this account. - `accepts_chat_messages` - if false, this account will reject all chat messages. - `language` - user's preferred language for receiving emails (digest, confirmation, etc.) +- `avatar_description` - image description for user avatar +- `header_description` - image description for user banner All images (avatar, banner and background) can be reset to the default by sending an empty string ("") instead of a file. |