diff options
| author | Alexander Strizhakov <alex.strizhakov@gmail.com> | 2020-01-22 18:08:53 +0300 |
|---|---|---|
| committer | Alexander Strizhakov <alex.strizhakov@gmail.com> | 2020-01-22 18:08:53 +0300 |
| commit | a9c6f119ac8fb2124241a61b26d97bff207218d8 (patch) | |
| tree | 670e4b26d46dabb00d0568d32904a57f64aebf1a /docs/API | |
| parent | d5f8a88a37cb4a2341f11d5e39adfaba024e3486 (diff) | |
| download | pleroma-a9c6f119ac8fb2124241a61b26d97bff207218d8.tar.gz | |
docs update
Diffstat (limited to 'docs/API')
| -rw-r--r-- | docs/API/admin_api.md | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md index 37cd1910d..534c49eed 100644 --- a/docs/API/admin_api.md +++ b/docs/API/admin_api.md @@ -682,11 +682,12 @@ Copies all settings from database to `config/{env}.exported_from_db.secret.exs` ## `GET /api/pleroma/admin/config` -### Get saved config settings +### Get list of merged default settings with saved in database. **Only works when configuration from database is enabled.** -- Params: none +- Params: + - `only_db`: true (*optional*, get only saved in database settings) - Response: - On failure: - 400 Bad Request `"To use this endpoint you need to enable configuration from database."` @@ -734,7 +735,6 @@ Most of the settings will be applied in `runtime`, this means that you don't nee - all settings inside these keys: - `:hackney_pools` - `:chat` - - `Pleroma.Web.Endpoint` - partially settings inside these keys: - `:seconds_valid` in `Pleroma.Captcha` - `:proxy_remote` in `Pleroma.Upload` @@ -763,11 +763,10 @@ Example of setting without keyword in value: config :tesla, :adapter, Tesla.Adapter.Hackney ``` -List of settings which support only full update: +List of settings which support only full update by key: ```elixir @full_key_update [ {:pleroma, :ecto_repos}, - {:pleroma, :assets}, {:quack, :meta}, {:mime, :types}, {:cors_plug, [:max_age, :methods, :expose, :headers]}, @@ -777,6 +776,17 @@ List of settings which support only full update: ] ``` +List of settings which support only full update by subkey: +```elixir +@full_subkey_update [ + {:pleroma, :assets, :mascots}, + {:pleroma, :emoji, :groups}, + {:pleroma, :workers, :retries}, + {:pleroma, :mrf_subchain, :match_actor}, + {:pleroma, :mrf_keyword, :replace} + ] +``` + *Settings without explicit key must be sended in separate config object params.* ```elixir config :quack, |