diff options
author | feld <feld@feld.me> | 2021-02-03 14:23:23 +0000 |
---|---|---|
committer | feld <feld@feld.me> | 2021-02-03 14:23:23 +0000 |
commit | 008499f65a33f5d42a98cc3719f6ab5e8def40d6 (patch) | |
tree | 1bcf258f38105267d4f655d8aed68d1ab502523f /docs/development/API | |
parent | 39335d42513e47289fc825d04680531b84862686 (diff) | |
parent | c3dd860a027ef1339285b5b62dc62e0b48bc6855 (diff) | |
download | pleroma-008499f65a33f5d42a98cc3719f6ab5e8def40d6.tar.gz pleroma-008499f65a33f5d42a98cc3719f6ab5e8def40d6.zip |
Merge branch 'develop' into 'fix/2412-filters'
# Conflicts:
# CHANGELOG.md
Diffstat (limited to 'docs/development/API')
-rw-r--r-- | docs/development/API/admin_api.md | 26 | ||||
-rw-r--r-- | docs/development/API/differences_in_mastoapi_responses.md | 23 |
2 files changed, 47 insertions, 2 deletions
diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md index 5253dc668..04a181401 100644 --- a/docs/development/API/admin_api.md +++ b/docs/development/API/admin_api.md @@ -287,7 +287,18 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false) - Response: - On failure: `Not found` - - On success: JSON array of user's latest statuses + - On success: JSON, where: + - `total`: total count of the statuses for the user + - `activities`: list of the statuses for the user + +```json +{ + "total" : 1, + "activities": [ + // activities list + ] +} +``` ## `GET /api/pleroma/admin/instances/:instance/statuses` @@ -300,7 +311,18 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false) - Response: - On failure: `Not found` - - On success: JSON array of instance's latest statuses + - On success: JSON, where: + - `total`: total count of the statuses for the instance + - `activities`: list of the statuses for the instance + +```json +{ + "total" : 1, + "activities": [ + // activities list + ] +} +``` ## `GET /api/pleroma/admin/statuses` diff --git a/docs/development/API/differences_in_mastoapi_responses.md b/docs/development/API/differences_in_mastoapi_responses.md index 84430408b..38d70fa78 100644 --- a/docs/development/API/differences_in_mastoapi_responses.md +++ b/docs/development/API/differences_in_mastoapi_responses.md @@ -16,6 +16,12 @@ Adding the parameter `reply_visibility` to the public and home timelines queries Adding the parameter `instance=lain.com` to the public timeline will show only statuses originating from `lain.com` (or any remote instance). +Home, public, hashtag & list timelines accept these parameters: + +- `only_media`: show only statuses with media attached +- `local`: show only local statuses +- `remote`: show only remote statuses + ## Statuses - `visibility`: has additional possible values `list` and `local` (for local-only statuses) @@ -54,6 +60,23 @@ The `id` parameter can also be the `nickname` of the user. This only works in th - `/api/v1/accounts/:id` - `/api/v1/accounts/:id/statuses` +`/api/v1/accounts/:id/statuses` endpoint accepts these parameters: + +- `pinned`: include only pinned statuses +- `tagged`: with tag +- `only_media`: include only statuses with media attached +- `with_muted`: include statuses/reactions from muted accounts +- `exclude_reblogs`: exclude reblogs +- `exclude_replies`: exclude replies +- `exclude_visibilities`: exclude visibilities + +Endpoints which accept `with_relationships` parameter: + +- `/api/v1/accounts/:id` +- `/api/v1/accounts/:id/followers` +- `/api/v1/accounts/:id/following` +- `/api/v1/mutes` + Has these additional fields under the `pleroma` object: - `ap_id`: nullable URL string, ActivityPub id of the user |