diff options
| author | Sadposter <hannah+pleroma@coffee-and-dreams.uk> | 2019-04-10 10:44:54 +0100 |
|---|---|---|
| committer | Sadposter <hannah+pleroma@coffee-and-dreams.uk> | 2019-04-10 10:44:54 +0100 |
| commit | be8350baa2f8c9cf9be3f53ee4a0041dada1386f (patch) | |
| tree | 8414fc2108941ccadd9b9fd4dd37c9d3cf731399 /docs/api/pleroma_api.md | |
| parent | 589629cf3e1bee9a4f6e92b8456d8614eff73c89 (diff) | |
| parent | c8440b5e0c97c5d5c03e4b99e30a61df6ab95319 (diff) | |
| download | pleroma-be8350baa2f8c9cf9be3f53ee4a0041dada1386f.tar.gz | |
Merge branch 'develop' into feature/user-status-subscriptions
Diffstat (limited to 'docs/api/pleroma_api.md')
| -rw-r--r-- | docs/api/pleroma_api.md | 39 |
1 files changed, 36 insertions, 3 deletions
diff --git a/docs/api/pleroma_api.md b/docs/api/pleroma_api.md index 75569e092..dbe250300 100644 --- a/docs/api/pleroma_api.md +++ b/docs/api/pleroma_api.md @@ -10,7 +10,29 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi * Authentication: not required * Params: none * Response: JSON -* Example response: `{"kalsarikannit_f":"/finmoji/128px/kalsarikannit_f-128.png","perkele":"/finmoji/128px/perkele-128.png","blobdab":"/emoji/blobdab.png","happiness":"/finmoji/128px/happiness-128.png"}` +* Example response: +```json +{ + "girlpower": { + "tags": [ + "Finmoji" + ], + "image_url": "/finmoji/128px/girlpower-128.png" + }, + "education": { + "tags": [ + "Finmoji" + ], + "image_url": "/finmoji/128px/education-128.png" + }, + "finnishlove": { + "tags": [ + "Finmoji" + ], + "image_url": "/finmoji/128px/finnishlove-128.png" + } +} +``` * Note: Same data as Mastodon API’s `/api/v1/custom_emojis` but in a different format ## `/api/pleroma/follow_import` @@ -27,14 +49,14 @@ Request parameters can be passed via [query strings](https://en.wikipedia.org/wi * Method: `GET` * Authentication: not required * Params: none -* Response: Provider specific JSON, the only guaranteed parameter is `type` +* Response: Provider specific JSON, the only guaranteed parameter is `type` * Example response: `{"type": "kocaptcha", "token": "whatever", "url": "https://captcha.kotobank.ch/endpoint"}` ## `/api/pleroma/delete_account` ### Delete an account * Method `POST` * Authentication: required -* Params: +* Params: * `password`: user's password * Response: JSON. Returns `{"status": "success"}` if the deletion was successful, `{"error": "[error message]"}` otherwise * Example response: `{"error": "Invalid password."}` @@ -164,3 +186,14 @@ See [Admin-API](Admin-API.md) "endorsed": false } ``` + +## `/api/pleroma/notification_settings` +### Updates user notification settings +* Method `PUT` +* Authentication: required +* Params: + * `followers`: BOOLEAN field, receives notifications from followers + * `follows`: BOOLEAN field, receives notifications from people the user follows + * `remote`: BOOLEAN field, receives notifications from people on remote instances + * `local`: BOOLEAN field, receives notifications from people on the local instance +* Response: JSON. Returns `{"status": "success"}` if the update was successful, otherwise returns `{"error": "error_msg"}` |