diff options
| author | Maksim Pechnikov <parallel588@gmail.com> | 2019-06-04 09:49:08 +0300 |
|---|---|---|
| committer | Maksim Pechnikov <parallel588@gmail.com> | 2019-06-04 09:49:08 +0300 |
| commit | 4f2e359687b8866a26130314315415a787678881 (patch) | |
| tree | 51e29be10335dab73962952c2f1b0407cbd52ecb /docs/api | |
| parent | 64ada7f960eb45d5e06d431c0c27be1014106ff9 (diff) | |
| parent | 0f8f63c6bb4a26615277f43ed4f30f032d71df83 (diff) | |
| download | pleroma-4f2e359687b8866a26130314315415a787678881.tar.gz | |
Merge branch 'develop' into issue/941
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/differences_in_mastoapi_responses.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/docs/api/differences_in_mastoapi_responses.md b/docs/api/differences_in_mastoapi_responses.md index ed156836d..88a43de38 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,8 +81,17 @@ 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. - `skip_thread_containment` - if true, skip filtering out broken threads +### 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. +>>>>>>> develop + ## Authentication *Pleroma supports refreshing tokens. |