X-Git-Url: https://git.squeep.com/?a=blobdiff_plain;f=docs%2FAPI%2Fadmin_api.md;h=7bf13daef5f5251f4119081e0b7ad4e98fb61ab7;hb=9e96c9ae48182d3ae1d00e9475bf0af50cad9f93;hp=7bdbd17aa4a769e31fe7547c738e3de7d940be77;hpb=c361df11b4e31bc6b369a4feebdbaa82987c2eec;p=akkoma

diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md
index 7bdbd17aa..7bf13daef 100644
--- a/docs/API/admin_api.md
+++ b/docs/API/admin_api.md
@@ -349,9 +349,9 @@ Response:
 
 ### Unfollow a Relay
 
-Params:
-
-* `relay_url`
+- Params:
+  - `relay_url`
+  - *optional* `force`: forcefully unfollow a relay even when the relay is not available. (default is `false`)
 
 Response:
 
@@ -1346,7 +1346,12 @@ Loads json generated from `config/descriptions.exs`.
 ```json
 [
    {
-      "account": {
+      "sender": {
+        "id": "someflakeid",
+        "username": "somenick",
+        ...
+      },
+      "receiver": {
         "id": "someflakeid",
         "username": "somenick",
         ...
@@ -1369,7 +1374,12 @@ Loads json generated from `config/descriptions.exs`.
 
 ```json
 {
-  "account": {
+  "sender": {
+    "id": "someflakeid",
+    "username": "somenick",
+    ...
+  },
+  "receiver": {
     "id": "someflakeid",
     "username": "somenick",
     ...
@@ -1385,7 +1395,7 @@ Loads json generated from `config/descriptions.exs`.
 
 ### List the messages in a chat
 
-- Params: None
+- Params: `max_id`, `min_id`
 
 - Response:
 
@@ -1445,3 +1455,45 @@ Loads json generated from `config/descriptions.exs`.
   "unread": false
 }
 ```
+
+## `GET /api/pleroma/admin/instance_document/:document_name`
+
+### Get an instance document
+
+- Authentication: required
+
+- Response:
+
+Returns the content of the document
+
+```html
+<h1>Instance panel</h1>
+```
+
+## `PATCH /api/pleroma/admin/instance_document/:document_name`
+- Params:
+  - `file` (the file to be uploaded, using multipart form data.)
+
+### Update an instance document
+
+- Authentication: required
+
+- Response:
+
+``` json
+{
+  "url": "https://example.com/instance/panel.html"
+}
+```
+
+## `DELETE /api/pleroma/admin/instance_document/:document_name`
+
+### Delete an instance document
+
+- Response:
+
+``` json
+{
+  "url": "https://example.com/instance/panel.html"
+}
+```