aboutsummaryrefslogtreecommitdiff
path: root/docs/API
diff options
context:
space:
mode:
Diffstat (limited to 'docs/API')
-rw-r--r--docs/API/admin_api.md37
-rw-r--r--docs/API/pleroma_api.md13
2 files changed, 44 insertions, 6 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md
index fb6dfcb08..3882763cd 100644
--- 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.
+*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:
@@ -692,20 +694,24 @@ Note: Available `:permission_group` is currently moderator and admin. 404 is ret
```json
{
- configs: [
+ "configs": [
{
"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
+*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:
@@ -793,7 +799,7 @@ config :quack,
```
```json
{
- configs: [
+ "configs": [
{"group": ":quack", "key": ":level", "value": ":debug"},
{"group": ":quack", "key": ":meta", "value": [":all"]},
...
@@ -804,7 +810,7 @@ config :quack,
```json
{
- configs: [
+ "configs": [
{
"group": ":pleroma",
"key": "Pleroma.Upload",
@@ -836,15 +842,17 @@ config :quack,
- 400 Bad Request `"To use this endpoint you need to enable configuration from database."`
```json
{
- configs: [
+ "configs": [
{
"group": ":pleroma",
"key": "Pleroma.Upload",
"value": [...]
}
- ]
+ ],
+ "need_reboot": true
}
```
+need_reboot - *optional*, if were changed reboot time settings.
## ` GET /api/pleroma/admin/config/descriptions`
@@ -931,3 +939,20 @@ Loads json generated from `config/descriptions.exs`.
- Params:
- `nicknames`
- Response: Array of user nicknames
+
+## `GET /api/pleroma/admin/stats`
+
+### Stats
+
+- Response:
+
+```json
+{
+ "status_visibility": {
+ "direct": 739,
+ "private": 9,
+ "public": 17,
+ "unlisted": 14
+ }
+}
+```
diff --git a/docs/API/pleroma_api.md b/docs/API/pleroma_api.md
index 07e0af5e5..761d5c69c 100644
--- a/docs/API/pleroma_api.md
+++ b/docs/API/pleroma_api.md
@@ -459,3 +459,16 @@ Emoji reactions work a lot like favourites do. They make it possible to react to
{"name": "☕", "count": 1, "me": false, "accounts": [{"id" => "abc..."}]}
]
```
+
+## `GET /api/v1/pleroma/statuses/:id/reactions/:emoji`
+### Get an object of emoji to account mappings with accounts that reacted to the post for a specific emoji`
+* Method: `GET`
+* Authentication: optional
+* Params: None
+* Response: JSON, a list of emoji/account list tuples
+* Example Response:
+```json
+[
+ {"name": "😀", "count": 2, "me": true, "accounts": [{"id" => "xyz.."...}, {"id" => "zyx..."}]}
+]
+```