diff options
author | marcin mikołajczak <git@mkljczk.pl> | 2024-04-06 10:42:23 +0200 |
---|---|---|
committer | marcin mikołajczak <git@mkljczk.pl> | 2024-04-06 10:42:23 +0200 |
commit | 01a5f839c58d89be802e162280bd02c577bdec89 (patch) | |
tree | 8655b5bc8221f4dd0e1086c5d6dd1b8c97c0abc8 /docs/development/API/pleroma_api.md | |
parent | 918c406a914d49b15beb3611e1c780d0e0d253cd (diff) | |
parent | 987f44d81142e11b008659f3fbdf9baf69a1e9d8 (diff) | |
download | pleroma-01a5f839c58d89be802e162280bd02c577bdec89.tar.gz pleroma-01a5f839c58d89be802e162280bd02c577bdec89.zip |
Merge remote-tracking branch 'origin/develop' into instance_rules
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` |