summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTusooa Zhu <tusooa@kazv.moe>2022-07-16 01:27:16 -0400
committerTusooa Zhu <tusooa@kazv.moe>2022-07-16 01:27:16 -0400
commit8113dd31ee5d4d50c2b864d46242e1c3b6e889be (patch)
tree466340a999ebfa45c29b522f976c873e79c2ec8f /docs
parent8371fd8ca20d7aaa16e082fd7ed39d603b9731d1 (diff)
Add api docs for settings endpoint
Diffstat (limited to 'docs')
-rw-r--r--docs/development/API/pleroma_api.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/development/API/pleroma_api.md b/docs/development/API/pleroma_api.md
index 0d15384b9..09ffba2e6 100644
--- a/docs/development/API/pleroma_api.md
+++ b/docs/development/API/pleroma_api.md
@@ -695,3 +695,42 @@ Emoji reactions work a lot like favourites do. They make it possible to react to
* Authentication: required
* Params: none
* Response: HTTP 200 on success, 500 on error
+
+## `/api/v1/pleroma/settings/:app`
+### Gets settings for some application
+* Method `GET`
+* Authentication: `read:accounts`
+
+* Response: JSON. The settings for that application, or empty object if there is none.
+* Example response:
+```json
+{
+ "some key": "some value"
+}
+```
+
+### Updates settings for some application
+* Method `PATCH`
+* Authentication: `write:accounts`
+* Request body: JSON object. The object will be merged recursively with old settings. If some field is set to null, it is removed.
+* Example request:
+```json
+{
+ "some key": "some value",
+ "key to remove": null,
+ "nested field": {
+ "some key": "some value",
+ "key to remove": null
+ }
+}
+```
+* Response: JSON. Updated (merged) settings for that application.
+* Example response:
+```json
+{
+ "some key": "some value",
+ "nested field": {
+ "some key": "some value",
+ }
+}
+```