diff options
| author | Ivan Tashkinov <ivantashkinov@gmail.com> | 2020-02-18 17:52:31 +0300 |
|---|---|---|
| committer | Ivan Tashkinov <ivantashkinov@gmail.com> | 2020-02-18 17:52:31 +0300 |
| commit | 226f4d5ef93805e2ff93f00d443238ab7afeb3e6 (patch) | |
| tree | 0b551581bedb15b6e90934a2ee51c881b7bac0f9 /docs/API/admin_api.md | |
| parent | 4f8c3462a8821ffcf83f8b65edf48e55eff7080c (diff) | |
| parent | 3fa2ac68df10f6ffe3c1ea76fa10c30da90f4bd0 (diff) | |
| download | pleroma-226f4d5ef93805e2ff93f00d443238ab7afeb3e6.tar.gz pleroma-226f4d5ef93805e2ff93f00d443238ab7afeb3e6.zip | |
Merge remote-tracking branch 'remotes/origin/develop' into tests-clear-config-tweaks
# Conflicts:
# test/web/admin_api/admin_api_controller_test.exs
Diffstat (limited to 'docs/API/admin_api.md')
| -rw-r--r-- | docs/API/admin_api.md | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md index fb6dfcb08..47acd240e 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -682,6 +682,8 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret ### Get list of merged default settings with saved in database. +*If `need_reboot` flag exists in response, instance must be restarted, so reboot time settings can take effect.* + **Only works when configuration from database is enabled.** - Params: @@ -692,20 +694,24 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret ```json { - configs: [ + "configs": [ { "group": ":pleroma", "key": "Pleroma.Upload", "value": [] } - ] + ], + "need_reboot": true } ``` + need_reboot - *optional*, if were changed reboot time settings. ## `POST /api/pleroma/admin/config` ### Update config settings +*If `need_reboot` flag exists in response, instance must be restarted, so reboot time settings can take effect.* + **Only works when configuration from database is enabled.** Some modifications are necessary to save the config settings correctly: @@ -793,7 +799,7 @@ config :quack, ``` ```json { - configs: [ + "configs": [ {"group": ":quack", "key": ":level", "value": ":debug"}, {"group": ":quack", "key": ":meta", "value": [":all"]}, ... @@ -804,7 +810,7 @@ config :quack, ```json { - configs: [ + "configs": [ { "group": ":pleroma", "key": "Pleroma.Upload", @@ -836,15 +842,17 @@ config :quack, - 400 Bad Request `"To use this endpoint you need to enable configuration from database."` ```json { - configs: [ + "configs": [ { "group": ":pleroma", "key": "Pleroma.Upload", "value": [...] } - ] + ], + "need_reboot": true } ``` +need_reboot - *optional*, if were changed reboot time settings. ## ` GET /api/pleroma/admin/config/descriptions` |