summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoreugenijm <eugenijm@protonmail.com>2020-08-30 15:15:14 +0300
committereugenijm <eugenijm@protonmail.com>2020-09-17 16:48:07 +0300
commit582ad5d4e1587b3dba9d879bd68dd9a315c8446e (patch)
treeb65929cb8afe3bfa939ffc4bb71379b98d69a8cf /docs
parent5426eb59976044f88247486da86a91b8f9eb35b5 (diff)
AdminAPI: Allow to modify Terms of Service and Instance Panel via Admin API
Diffstat (limited to 'docs')
-rw-r--r--docs/API/admin_api.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/API/admin_api.md b/docs/API/admin_api.md
index bc96abbf0..eba92dd1f 100644
--- a/docs/API/admin_api.md
+++ b/docs/API/admin_api.md
@@ -1455,3 +1455,45 @@ Loads json generated from `config/descriptions.exs`.
"unread": false
}
```
+
+## `GET /api/pleroma/admin/instance_document/:document_name`
+
+### Gets an instance document
+
+- Authentication: required
+
+- Response:
+
+``` json
+{
+ "url": "https://example.com/instance/panel.html"
+}
+```
+
+## `PATCH /api/pleroma/admin/instance_document/:document_name`
+- Params:
+ - `file` (the file to be uploaded, using multipart form data.)
+
+### Updates 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"
+}
+```