diff options
| author | Alibek Omarov <a1ba.omarov@gmail.com> | 2020-07-11 11:02:13 +0000 |
|---|---|---|
| committer | Alibek Omarov <a1ba.omarov@gmail.com> | 2020-07-11 11:02:13 +0000 |
| commit | d8855405902b57980ce1f7bc65f25daba6b565e2 (patch) | |
| tree | ac43fff501c1fc94645a072d29b64e81800a7f92 | |
| parent | d6f67fa91b00b28d7be9f82bb300f9d650c73744 (diff) | |
| download | pleroma-d8855405902b57980ce1f7bc65f25daba6b565e2.tar.gz | |
docs: API: fix update_credentials endpoints path, clarify update/verify_credentials endpoints paths
| -rw-r--r-- | docs/API/differences_in_mastoapi_responses.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/API/differences_in_mastoapi_responses.md b/docs/API/differences_in_mastoapi_responses.md index 65f9f1aef..c4a9c6dad 100644 --- a/docs/API/differences_in_mastoapi_responses.md +++ b/docs/API/differences_in_mastoapi_responses.md @@ -64,8 +64,8 @@ Has these additional fields under the `pleroma` object: - `hide_follows`: boolean, true when the user has follow hiding enabled - `hide_followers_count`: boolean, true when the user has follower stat hiding enabled - `hide_follows_count`: boolean, true when the user has follow stat hiding enabled -- `settings_store`: A generic map of settings for frontends. Opaque to the backend. Only returned in `verify_credentials` and `update_credentials` -- `chat_token`: The token needed for Pleroma chat. Only returned in `verify_credentials` +- `settings_store`: A generic map of settings for frontends. Opaque to the backend. Only returned in `/api/v1/accounts/verify_credentials` and `/api/v1/accounts/update_credentials` +- `chat_token`: The token needed for Pleroma chat. Only returned in `/api/v1/accounts/verify_credentials` - `deactivated`: boolean, true when the user is deactivated - `allow_following_move`: boolean, true when the user allows automatically follow moved following accounts - `unread_conversation_count`: The count of unread conversations. Only returned to the account owner. @@ -169,7 +169,7 @@ Returns: array of Status. The maximum number of statuses is limited to 100 per request. -## PATCH `/api/v1/update_credentials` +## PATCH `/api/v1/accounts/update_credentials` Additional parameters can be added to the JSON body/Form data: @@ -197,7 +197,7 @@ Pleroma has mechanism that allows frontends to save blobs of json for each user 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. +This information is returned in the `/api/v1/accounts/verify_credentials` endpoint. ## Authentication |