diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development/API/admin_api.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md index 902403a40..45f470b2c 100644 --- a/docs/development/API/admin_api.md +++ b/docs/development/API/admin_api.md @@ -1107,6 +1107,7 @@ Loads json generated from `config/descriptions.exs`. "type": "group", // string or list with possible values, "description": "Upload general settings", // string "tab": "mrf", + "label": "MRF", "children": [ { "key": ":uploader", // string or module name `Pleroma.Upload` @@ -1126,6 +1127,47 @@ Loads json generated from `config/descriptions.exs`. }] ``` +## `GET /api/v2/pleroma/admin/config/descriptions` + +### Get tabs and config descriptions + +Loads json generated from `config/descriptions.exs`. + +- Params: none +- Response: + +```json +{ + "tabs": [{"tab": "activity_pub", "label": "ActivityPub"}], + "descriptions": [ + { + "group": ":pleroma", // string + "key": "ModuleName", // string + "type": "group", // string or list with possible values, + "description": "Upload general settings", // string + "tab": "mrf", + "label": "MRF", + "children": [ + { + "key": ":uploader", // string or module name `Pleroma.Upload` + "type": "module", + "description": "Module which will be used for uploads", + "suggestions": ["module1", "module2"] + }, + { + "key": ":filters", + "type": ["list", "module"], + "description": "List of filter modules for uploads", + "suggestions": [ + "module1", "module2", "module3" + ] + } + ] + } + ] +} +``` + ## `GET /api/v1/pleroma/admin/moderation_log` ### Get moderation log |