summaryrefslogtreecommitdiff
path: root/docs/development/API/admin_api.md
diff options
context:
space:
mode:
authormarcin mikołajczak <git@mkljczk.pl>2024-05-18 11:16:33 +0200
committermarcin mikołajczak <git@mkljczk.pl>2024-05-18 11:16:33 +0200
commit7620b520c13a1c204810cf0cfe6a7b70b9a1c59d (patch)
treec4a24d0f0a513c697db8d0197e179a70108063d4 /docs/development/API/admin_api.md
parent03d4e7eeccc7fc69c731ada8a7bd049ad52a9d6f (diff)
parent99eab1fa2a39b7a7fba6cdbb92c01e9c7c81aa88 (diff)
downloadpleroma-7620b520c13a1c204810cf0cfe6a7b70b9a1c59d.tar.gz
pleroma-7620b520c13a1c204810cf0cfe6a7b70b9a1c59d.zip
Merge remote-tracking branch 'origin/develop' into post-languages
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
Diffstat (limited to 'docs/development/API/admin_api.md')
-rw-r--r--docs/development/API/admin_api.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md
index 182a760fa..5b373b8e1 100644
--- a/docs/development/API/admin_api.md
+++ b/docs/development/API/admin_api.md
@@ -1751,3 +1751,53 @@ Note that this differs from the Mastodon API variant: Mastodon API only returns
```json
{}
```
+
+
+## `GET /api/v1/pleroma/admin/rules`
+
+### List rules
+
+- Response: JSON, list of rules
+
+```json
+[
+ {
+ "id": "1",
+ "priority": 1,
+ "text": "There are no rules",
+ "hint": null
+ }
+]
+```
+
+## `POST /api/v1/pleroma/admin/rules`
+
+### Create a rule
+
+- Params:
+ - `text`: string, required, rule content
+ - `hint`: string, optional, rule description
+ - `priority`: integer, optional, rule ordering priority
+
+- Response: JSON, a single rule
+
+## `PATCH /api/v1/pleroma/admin/rules/:id`
+
+### Update a rule
+
+- Params:
+ - `text`: string, optional, rule content
+ - `hint`: string, optional, rule description
+ - `priority`: integer, optional, rule ordering priority
+
+- Response: JSON, a single rule
+
+## `DELETE /api/v1/pleroma/admin/rules/:id`
+
+### Delete a rule
+
+- Response: JSON, empty object
+
+```json
+{}
+```