diff options
| author | kaniini <nenolod@gmail.com> | 2019-06-04 05:43:43 +0000 |
|---|---|---|
| committer | kaniini <nenolod@gmail.com> | 2019-06-04 05:43:43 +0000 |
| commit | 9d2563a3deb0904b8c7a480479179f10e7849c12 (patch) | |
| tree | 6e51e34637a06fcc0b3860a5cd61fe2c1516f6f3 /docs/api | |
| parent | a536f515dd2334e723f4e4c593724760511c5c1b (diff) | |
| parent | 7591a8928d7ca440dbc2d45428988208ef617bdc (diff) | |
| download | pleroma-9d2563a3deb0904b8c7a480479179f10e7849c12.tar.gz | |
Merge branch 'generic-fe-settings' into 'develop'
Generic settings store for frontend user settings
See merge request pleroma/pleroma!1221
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/differences_in_mastoapi_responses.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/api/differences_in_mastoapi_responses.md b/docs/api/differences_in_mastoapi_responses.md index 36b47608e..21c1b76e5 100644 --- a/docs/api/differences_in_mastoapi_responses.md +++ b/docs/api/differences_in_mastoapi_responses.md @@ -43,6 +43,7 @@ Has these additional fields under the `pleroma` object: - `confirmation_pending`: boolean, true if a new user account is waiting on email confirmation to be activated - `hide_followers`: boolean, true when the user has follower hiding enabled - `hide_follows`: boolean, true when the user has follow hiding enabled +- `settings_store`: A generic map of settings for frontends. Opaque to the backend. Only returned in `verify_credentials` and `update_credentials` ### Source @@ -80,6 +81,14 @@ Additional parameters can be added to the JSON body/Form data: - `hide_favorites` - if true, user's favorites timeline will be hidden - `show_role` - if true, user's role (e.g admin, moderator) will be exposed to anyone in the API - `default_scope` - the scope returned under `privacy` key in Source subentity +- `pleroma_settings_store` - Opaque user settings to be saved on the backend. + +### 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. + +The parameter should have a form of `{frontend_name: {...}}`, with `frontend_name` identifying your type of client, e.g. `pleroma_fe`. It will overwrite everything under this property, but will not overwrite other frontend's settings. + +This information is returned in the `verify_credentials` endpoint. ## Authentication |