summaryrefslogtreecommitdiff
path: root/docs/development/API/pleroma_api.md
diff options
context:
space:
mode:
authormarcin mikołajczak <git@mkljczk.pl>2024-05-18 11:30:25 +0200
committermarcin mikołajczak <git@mkljczk.pl>2024-05-18 11:30:25 +0200
commit2e76ceb5b4c8abf860f9d078c80ae0fcbe1a4ffd (patch)
tree6a803ea5efa8f6a93f04d657f3cb56a0b9ff5b17 /docs/development/API/pleroma_api.md
parent1ed8ae2d8e86ed26d4e21f59e95995795bcb282b (diff)
parent99eab1fa2a39b7a7fba6cdbb92c01e9c7c81aa88 (diff)
downloadpleroma-2e76ceb5b4c8abf860f9d078c80ae0fcbe1a4ffd.tar.gz
pleroma-2e76ceb5b4c8abf860f9d078c80ae0fcbe1a4ffd.zip
Merge remote-tracking branch 'origin/develop' into status-notification-type
Signed-off-by: marcin mikołajczak <git@mkljczk.pl>
Diffstat (limited to 'docs/development/API/pleroma_api.md')
-rw-r--r--docs/development/API/pleroma_api.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/development/API/pleroma_api.md b/docs/development/API/pleroma_api.md
index 060af5c14..267dfc1ec 100644
--- a/docs/development/API/pleroma_api.md
+++ b/docs/development/API/pleroma_api.md
@@ -283,6 +283,52 @@ See [Admin-API](admin_api.md)
* `id`: the id of the status
* Response: JSON, returns a list of Mastodon Status entities
+## `GET /api/v1/pleroma/bookmark_folders`
+### Gets user bookmark folders
+* Authentication: required
+
+* Response: JSON. Returns a list of bookmark folders.
+* Example response:
+```json
+[
+ {
+ "id": "9umDrYheeY451cQnEe",
+ "name": "Read later",
+ "emoji": "🕓",
+ "source": {
+ "emoji": "🕓"
+ }
+ }
+]
+```
+
+## `POST /api/v1/pleroma/bookmark_folders`
+### Creates a bookmark folder
+* Authentication: required
+
+* Params:
+ * `name`: folder name
+ * `emoji`: folder emoji (optional)
+* Response: JSON. Returns a single bookmark folder.
+
+## `PATCH /api/v1/pleroma/bookmark_folders/:id`
+### Updates a bookmark folder
+* Authentication: required
+
+* Params:
+ * `id`: folder id
+ * `name`: folder name (optional)
+ * `emoji`: folder emoji (optional)
+* Response: JSON. Returns a single bookmark folder.
+
+## `DELETE /api/v1/pleroma/bookmark_folders/:id`
+### Deletes a bookmark folder
+* Authentication: required
+
+* Params:
+ * `id`: folder id
+* Response: JSON. Returns a single bookmark folder.
+
## `/api/v1/pleroma/mascot`
### Gets user mascot image
* Method `GET`