docs update

This commit is contained in:
Alexander Strizhakov 2020-01-22 18:08:53 +03:00
commit a9c6f119ac
No known key found for this signature in database
GPG key ID: 022896A53AEF1381
3 changed files with 46 additions and 14 deletions

View file

@ -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,