Explorar el Código

docs: API: fix update_credentials endpoints path, clarify update/verify_credentials endpoints paths

chores/our-libs-hex-releases
Alibek Omarov hace 4 años
padre
commit
d885540590
Se han modificado 1 ficheros con 4 adiciones y 4 borrados
  1. +4
    -4
      docs/API/differences_in_mastoapi_responses.md

+ 4
- 4
docs/API/differences_in_mastoapi_responses.md Ver fichero

@@ -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



Cargando…
Cancelar
Guardar