summaryrefslogtreecommitdiff
path: root/docs/development/API/pleroma_api.md
diff options
context:
space:
mode:
authormarcin mikołajczak <git@mkljczk.pl>2024-05-18 11:16:33 +0200
committermarcin mikołajczak <git@mkljczk.pl>2024-05-18 11:16:33 +0200
commit7620b520c13a1c204810cf0cfe6a7b70b9a1c59d (patch)
treec4a24d0f0a513c697db8d0197e179a70108063d4 /docs/development/API/pleroma_api.md
parent03d4e7eeccc7fc69c731ada8a7bd049ad52a9d6f (diff)
parent99eab1fa2a39b7a7fba6cdbb92c01e9c7c81aa88 (diff)
downloadpleroma-7620b520c13a1c204810cf0cfe6a7b70b9a1c59d.tar.gz
pleroma-7620b520c13a1c204810cf0cfe6a7b70b9a1c59d.zip
Merge remote-tracking branch 'origin/develop' into post-languages
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`