diff options
| author | Haelwenn <contact+git.pleroma.social@hacktivis.me> | 2020-04-17 08:55:46 +0000 |
|---|---|---|
| committer | rinpatch <rinpatch@sdf.org> | 2020-05-01 01:38:25 +0300 |
| commit | fb9ec885cc96e51bd7703d98d8e41305ead56b9e (patch) | |
| tree | 80a51213024adda2453f4c77fa41ec00ba2f90f1 /docs | |
| parent | a4afeed4266e75279422a6721f0a9a2aece0b9ea (diff) | |
| download | pleroma-fb9ec885cc96e51bd7703d98d8e41305ead56b9e.tar.gz | |
Merge branch 'feature/1677-need_reboot-flag-endpoint' into 'develop'
Added need_reboot endpoint to admin api
Closes #1677
See merge request pleroma/pleroma!2373
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/API/admin_api.md | 21 |
1 files changed, 17 insertions, 4 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md index edcf73e14..26f3b1932 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -773,6 +773,8 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret ### Restarts pleroma application +**Only works when configuration from database is enabled.** + - Params: none - Response: - On failure: @@ -782,11 +784,24 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret {} ``` +## `GET /api/pleroma/admin/need_reboot` + +### Returns the flag whether the pleroma should be restarted + +- Params: none +- Response: + - `need_reboot` - boolean +```json +{ + "need_reboot": false +} +``` + ## `GET /api/pleroma/admin/config` ### 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.* +*If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.* **Only works when configuration from database is enabled.** @@ -808,13 +823,12 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret "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.* +*If `need_reboot` is `true`, instance must be restarted, so reboot time settings can take effect.* **Only works when configuration from database is enabled.** @@ -956,7 +970,6 @@ config :quack, "need_reboot": true } ``` -need_reboot - *optional*, if were changed reboot time settings. ## ` GET /api/pleroma/admin/config/descriptions` |