`/api/v1/accounts/:id/statuses` docs update
authorAlexander Strizhakov <alex.strizhakov@gmail.com>
Tue, 26 Jan 2021 14:55:43 +0000 (17:55 +0300)
committerAlexander Strizhakov <alex.strizhakov@gmail.com>
Mon, 1 Feb 2021 11:11:12 +0000 (14:11 +0300)
docs/development/API/differences_in_mastoapi_responses.md
lib/pleroma/web/api_spec/operations/account_operation.ex

index e9ab896b7d2824ed97a745db1da9deb84335d486..7a4979154a3a3abbd6ed8cd50f8a8a50f2afbb72 100644 (file)
@@ -16,7 +16,7 @@ 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 can filter statuses by accepting these parameters:
+Home, public, hashtag & list timelines accept these parameters:
 
 - `only_media`: show only statuses with media attached
 - `local`: show only local statuses
@@ -60,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
index 80acee2f7a21fb689ad62a538105adffac8c438f..a301ce090fa45c0cd55473e3c5f532710f4f514c 100644 (file)
@@ -130,7 +130,7 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
             :with_muted,
             :query,
             BooleanLike,
-            "Include statuses from muted acccounts."
+            "Include statuses from muted accounts."
           ),
           Operation.parameter(:exclude_reblogs, :query, BooleanLike, "Exclude reblogs"),
           Operation.parameter(:exclude_replies, :query, BooleanLike, "Exclude replies"),
@@ -144,7 +144,7 @@ defmodule Pleroma.Web.ApiSpec.AccountOperation do
             :with_muted,
             :query,
             BooleanLike,
-            "Include reactions from muted acccounts."
+            "Include reactions from muted accounts."
           )
         ] ++ pagination_params(),
       responses: %{