diff options
| author | feld <feld@feld.me> | 2021-02-02 17:18:07 +0000 |
|---|---|---|
| committer | feld <feld@feld.me> | 2021-02-02 17:18:07 +0000 |
| commit | b36891d1e6f5d4b0874ef19c4418a46d580c4701 (patch) | |
| tree | 726875098c3908b5ebf455c6ea00e9a38e405733 /docs/development | |
| parent | 2012800ed1618eeafddaaaaa05df4d3e10a2afff (diff) | |
| parent | cd5ff7a9430a8e5886983610f1e16f966392a7ee (diff) | |
| download | pleroma-b36891d1e6f5d4b0874ef19c4418a46d580c4701.tar.gz pleroma-b36891d1e6f5d4b0874ef19c4418a46d580c4701.zip | |
Merge branch 'feature/2164-unify-api-arguments' into 'develop'
Unifying timelines api arguments
Closes #2164
See merge request pleroma/pleroma!3281
Diffstat (limited to 'docs/development')
| -rw-r--r-- | docs/development/API/differences_in_mastoapi_responses.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/development/API/differences_in_mastoapi_responses.md b/docs/development/API/differences_in_mastoapi_responses.md index 84430408b..c83be2faa 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,16 @@ 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 + Has these additional fields under the `pleroma` object: - `ap_id`: nullable URL string, ActivityPub id of the user |