pleroma

commit: 90b442727e4e2e56b4b68a15172a5ef7516531df
parent f6fee39e42e633ff4298291dca0db656c92dad81
Author: marcin mikołajczak <git@mkljczk.pl>
Date:   Fri, 19 Jan 2024 17:53:37 +0100

Update Admin API docs

Signed-off-by: marcin mikołajczak <git@mkljczk.pl>

Diffstat:
M
docs/development/API/admin_api.md
47
+++++++++++++++++++++++++++++++++++++++++++++++

1 file changed, 47 insertions(+), 0 deletions(-)
diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md
@@ -1751,3 +1751,50 @@ 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"
+  }
+]
+```
+
+## `POST /api/v1/pleroma/admin/rules`
+
+### Create a rule
+
+- Params:
+  - `text`: string, required, rule content
+  - `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
+  - `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
+{}
+```