diff options
| author | lain <lain@soykaf.club> | 2020-06-22 12:25:12 +0000 |
|---|---|---|
| committer | lain <lain@soykaf.club> | 2020-06-22 12:25:12 +0000 |
| commit | 8b5bdd164e9df666bc12f4389540432b218b8e63 (patch) | |
| tree | f3170bab8b09a82523195202db16a83f3cd88b94 /docs/API | |
| parent | a0762fd5eaa47db38bfe7361d3cfeb9ced6ea2b8 (diff) | |
| parent | c5863438ba9079a01a832fe48e203907fe5b37cd (diff) | |
| download | pleroma-8b5bdd164e9df666bc12f4389540432b218b8e63.tar.gz | |
Merge branch 'fix/1825-admin-api-error-codes' into 'develop'
Proper error codes for error in adminFE
Closes #1825
See merge request pleroma/pleroma!2665
Diffstat (limited to 'docs/API')
| -rw-r--r-- | docs/API/admin_api.md | 56 |
1 files changed, 31 insertions, 25 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md index c7f56cf5f..b6fb43dcb 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -488,35 +488,39 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret ### Change the user's email, password, display and settings-related fields -- Params: - - `email` - - `password` - - `name` - - `bio` - - `avatar` - - `locked` - - `no_rich_text` - - `default_scope` - - `banner` - - `hide_follows` - - `hide_followers` - - `hide_followers_count` - - `hide_follows_count` - - `hide_favorites` - - `allow_following_move` - - `background` - - `show_role` - - `skip_thread_containment` - - `fields` - - `discoverable` - - `actor_type` - -- Response: +* Params: + * `email` + * `password` + * `name` + * `bio` + * `avatar` + * `locked` + * `no_rich_text` + * `default_scope` + * `banner` + * `hide_follows` + * `hide_followers` + * `hide_followers_count` + * `hide_follows_count` + * `hide_favorites` + * `allow_following_move` + * `background` + * `show_role` + * `skip_thread_containment` + * `fields` + * `discoverable` + * `actor_type` + +* Responses: + +Status: 200 ```json {"status": "success"} ``` +Status: 400 + ```json {"errors": {"actor_type": "is invalid"}, @@ -525,8 +529,10 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret } ``` +Status: 404 + ```json -{"error": "Unable to update user."} +{"error": "Not found"} ``` ## `GET /api/pleroma/admin/reports` |