From fe139572fcdf57cc4ca8f6cb80b7e02011780b88 Mon Sep 17 00:00:00 2001
From: Simon <simobilleter@gmail.com>
Date: Fri, 8 Nov 2024 15:00:36 +0700
Subject: [PATCH] add custom playlist actions, #48

---
 mkdocs/docs/api/playlist.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/mkdocs/docs/api/playlist.md b/mkdocs/docs/api/playlist.md
index ea4b37f..8c9ae77 100644
--- a/mkdocs/docs/api/playlist.md
+++ b/mkdocs/docs/api/playlist.md
@@ -22,6 +22,15 @@ Subscribe/Unsubscribe to a list of playlists:
 
 **POST**: Update Playlist item, only valid for custom playlists
 
+This expects an object with a key `video_id` to indicate the video in the playlist to modify and a key `action` to represent what to do. The action can be:
+
+- `create`: Create a video entry in the playlist
+- `remove`: Remove a video from the playlist
+- `up`: Move a video up
+- `down`: Move a video down
+- `top`: Move a video to the top
+- `bottom`: Move a video to the bottom
+
 Delete playlist, metadata only:  
 **DELETE** `/api/playlist/<playlist_id>/`  
 Delete playlist, also delete all videos in playlist: