diff options
| author | Lain Soykaf <lain@lain.com> | 2024-03-19 16:26:02 +0400 |
|---|---|---|
| committer | Lain Soykaf <lain@lain.com> | 2024-03-19 16:26:02 +0400 |
| commit | 4e8a1b40cb7014a14d209d4438491a66246802b1 (patch) | |
| tree | 25db7854e3d1b017a4abe2ae7b7687a744da82c6 /docs/development/API/pleroma_api.md | |
| parent | 8a14fdbe479ca0ffb3419a83cf3c637b72dd54e0 (diff) | |
| parent | 4e37cd85ef5b1134913441166219f09220fd4942 (diff) | |
| download | pleroma-4e8a1b40cb7014a14d209d4438491a66246802b1.tar.gz pleroma-4e8a1b40cb7014a14d209d4438491a66246802b1.zip | |
Merge branch 'develop' of git.pleroma.social:pleroma/pleroma into transient-validators-defaults
Diffstat (limited to 'docs/development/API/pleroma_api.md')
| -rw-r--r-- | docs/development/API/pleroma_api.md | 46 |
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` |