summaryrefslogtreecommitdiff
path: root/docs/development/API
diff options
context:
space:
mode:
authormarcin mikołajczak <git@mkljczk.pl>2024-04-06 10:54:59 +0200
committermarcin mikołajczak <git@mkljczk.pl>2024-04-06 11:45:19 +0200
commitccc3ac241f5b7c88b36efe60a4f9e5d791d2d49a (patch)
tree8f463989ca84ce2d9af9ff1fb385c35a247404d1 /docs/development/API
parent01a5f839c58d89be802e162280bd02c577bdec89 (diff)
downloadpleroma-ccc3ac241f5b7c88b36efe60a4f9e5d791d2d49a.tar.gz
pleroma-ccc3ac241f5b7c88b36efe60a4f9e5d791d2d49a.zip
Add hint to rules
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
Diffstat (limited to 'docs/development/API')
-rw-r--r--docs/development/API/admin_api.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/development/API/admin_api.md b/docs/development/API/admin_api.md
index 7bbed16d6..5b373b8e1 100644
--- a/docs/development/API/admin_api.md
+++ b/docs/development/API/admin_api.md
@@ -1764,7 +1764,8 @@ Note that this differs from the Mastodon API variant: Mastodon API only returns
{
"id": "1",
"priority": 1,
- "text": "There are no rules"
+ "text": "There are no rules",
+ "hint": null
}
]
```
@@ -1775,6 +1776,7 @@ Note that this differs from the Mastodon API variant: Mastodon API only returns
- Params:
- `text`: string, required, rule content
+ - `hint`: string, optional, rule description
- `priority`: integer, optional, rule ordering priority
- Response: JSON, a single rule
@@ -1785,6 +1787,7 @@ Note that this differs from the Mastodon API variant: Mastodon API only returns
- Params:
- `text`: string, optional, rule content
+ - `hint`: string, optional, rule description
- `priority`: integer, optional, rule ordering priority
- Response: JSON, a single rule