diff options
| author | Alexander Strizhakov <alex.strizhakov@gmail.com> | 2021-02-18 18:16:23 +0300 |
|---|---|---|
| committer | Alexander Strizhakov <alex.strizhakov@gmail.com> | 2021-02-28 19:33:16 +0300 |
| commit | 66810cf49b211ceb5d9140ff2926089700a57864 (patch) | |
| tree | b15650d20b87d452bce3f777290fc24d274377f8 /docs/development | |
| parent | 6a71aa535b3c30c1f3832e6140a51a46a0f2514c (diff) | |
| download | pleroma-feature/2515-admin-statuses.tar.gz | |
changes for admin status endpointsfeature/2515-admin-statuses
- docs fix, that status endpoints accept `page` parameter
- added total to /api/pleroma/admin/instances/:instance/statuses
- godmode for /api/pleroma/admin/instances/:instance/statuses
Diffstat (limited to 'docs/development')
| -rw-r--r-- | docs/development/API/admin_api.md | 30 |
1 files changed, 29 insertions, 1 deletions
diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md index 8f855d251..5efa8281e 100644 --- a/docs/development/API/admin_api.md +++ b/docs/development/API/admin_api.md @@ -278,11 +278,12 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret - Params: - `nickname` or `id` - *optional* `page_size`: number of statuses to return (default is `20`) + - *optional* `page`: **integer** page number - *optional* `godmode`: `true`/`false` – allows to see private statuses - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false) - Response: - On failure: `Not found` - - On success: JSON, where: + - On success: JSON, where: - `total`: total count of the statuses for the user - `activities`: list of the statuses for the user @@ -302,6 +303,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret - Params: - `instance`: instance name - *optional* `page_size`: number of statuses to return (default is `20`) + - *optional* `page`: **integer** page number - *optional* `godmode`: `true`/`false` – allows to see private statuses - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false) - Response: @@ -325,6 +327,7 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret - Params: - *optional* `page_size`: number of statuses to return (default is `20`) + - *optional* `page`: **integer** page number - *optional* `local_only`: excludes remote statuses - *optional* `godmode`: `true`/`false` – allows to see private statuses - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false) @@ -332,6 +335,31 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret - On failure: `Not found` - On success: JSON array of user's latest statuses +## `GET /api/v2/pleroma/admin/statuses` + +### Retrives all latest statuses with total + +- Params: + - *optional* `page_size`: number of statuses to return (default is `20`) + - *optional* `page`: **integer** page number + - *optional* `local_only`: excludes remote statuses + - *optional* `godmode`: `true`/`false` – allows to see private statuses + - *optional* `with_reblogs`: `true`/`false` – allows to see reblogs (default is false) +- Response: + - On failure: `Not found` + - On success: JSON, where: + - `total`: total count of the statuses + - `activities`: list of the statuses + +```json +{ + "total" : 1, + "activities": [ + // activities list + ] +} +``` + ## `GET /api/v1/pleroma/admin/relay` ### List Relays |