projects
/
akkoma
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
Merge branch 'features/remote-follow-userpage-redirect' into 'develop'
[akkoma]
/
docs
/
API
/
admin_api.md
diff --git
a/docs/API/admin_api.md
b/docs/API/admin_api.md
index e445583cbf3aa12a09dedd3293d8c6c537c0e2d2..47acd240e05325b13d409c5a347de49cfb435584 100644
(file)
--- 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.
### 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:
**Only works when configuration from database is enabled.**
- Params:
@@
-689,24
+691,27
@@
Note: Available `:permission_group` is currently moderator and admin. 404 is ret
- Response:
- On failure:
- 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
- Response:
- On failure:
- 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
- - 400 Bad Request `"To use configuration from database migrate your settings to database."`
```json
{
```json
{
-
configs
: [
+
"configs"
: [
{
"group": ":pleroma",
"key": "Pleroma.Upload",
"value": []
}
{
"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
## `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:
**Only works when configuration from database is enabled.**
Some modifications are necessary to save the config settings correctly:
@@
-794,7
+799,7
@@
config :quack,
```
```json
{
```
```json
{
-
configs
: [
+
"configs"
: [
{"group": ":quack", "key": ":level", "value": ":debug"},
{"group": ":quack", "key": ":meta", "value": [":all"]},
...
{"group": ":quack", "key": ":level", "value": ":debug"},
{"group": ":quack", "key": ":meta", "value": [":all"]},
...
@@
-805,7
+810,7
@@
config :quack,
```json
{
```json
{
-
configs
: [
+
"configs"
: [
{
"group": ":pleroma",
"key": "Pleroma.Upload",
{
"group": ":pleroma",
"key": "Pleroma.Upload",
@@
-837,15
+842,17
@@
config :quack,
- 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
```json
{
- 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
```json
{
-
configs
: [
+
"configs"
: [
{
"group": ":pleroma",
"key": "Pleroma.Upload",
"value": [...]
}
{
"group": ":pleroma",
"key": "Pleroma.Upload",
"value": [...]
}
- ]
+ ],
+ "need_reboot": true
}
```
}
```
+need_reboot - *optional*, if were changed reboot time settings.
## ` GET /api/pleroma/admin/config/descriptions`
## ` GET /api/pleroma/admin/config/descriptions`