Compare commits

...

4 Commits

Author SHA1 Message Date
Simon ccea275c30
add custom playlist user docs 2024-04-10 18:35:05 +02:00
Simon 5f4dea216b
bump requirements 2024-04-10 18:23:15 +02:00
Simon e262948291
[API] add custom playlist docs 2024-04-10 18:23:04 +02:00
Simon c13ffcaafd
fix version string parsing docs 2024-04-10 18:22:39 +02:00
5 changed files with 17 additions and 11 deletions

View File

@ -129,18 +129,14 @@ Change watched state, where the `id` can be a single video, or channel/playlist
```
## Ping
Validate your connection with the API
Validate your connection and authentication with the API
**GET** `/api/ping/`
When valid returns message with user id and parsed TubeArchivist version (Family, Major, Minor):
When valid returns message with user id and TubeArchivist version:
```json
{
"response": "pong",
"user": 1,
"version": [
0,
3,
6
]
"version": "v0.4.7"
}
```

View File

@ -3,6 +3,10 @@
## Playlist List
**GET** `/api/playlist/`
Parameter:
- playlist_type: filter py playlist type.
Subscribe/Unsubscribe to a list of playlists:
**POST** `/api/playlist/`
```json
@ -16,6 +20,8 @@ Subscribe/Unsubscribe to a list of playlists:
## Playlist Item
**GET** `/api/playlist/<playlist_id>/`
**POST**: Update Playlist item, only valid for custom playlists
Delete playlist, metadata only:
**DELETE** `/api/playlist/<playlist_id>/`
Delete playlist, also delete all videos in playlist:

View File

@ -12,11 +12,14 @@ Accessible at `/playlist/` of your Tube Archivist, this **Overview Page** shows
You can index playlists of a channel from the channel detail page as described [here](channels.md#channel-detail).
The **Subscribe to Playlist** button <img src="/assets/icon-add.png?raw=true" alt="add icon" width="20px" style="margin:0 5px;"> opens a text field to subscribe to playlists. You have a few options:
To add a playlist click on the <img src="/assets/icon-add.png?raw=true" alt="add icon" width="20px" style="margin:0 5px;"> button. There you can **Subscribe to Playlist**:
- Enter a playlist [playlist](urls.md#playlist)
- Enter a playlist [playlist](urls.md#playlist).
- Add one per line.
*or* you can **Create Custom Playlist**. That is a local only playlist. Add videos from their [video detail page](video.md).
!!! note
It doesn't make sense to subscribe to a playlist if you are already subscribed the corresponding channel as this will slow down the **Rescan Subscriptions** [task](downloads.md#rescan-subscriptions).

View File

@ -10,6 +10,7 @@ Clicking on the channel name or the channel icon will bring you to the dedicated
- The button **Reindex** will reindex the metadata of this video.
- The button **Download File** will download the media file in the browser.
- The button **Delete Video** will delete that video including the media file.
- The button **Add to Playlist** opens a list of your available [custom playlists](playlists.md/#playlist-overview). Check the box to add the video to the list.
If available, a tag cloud will show, representing the tags set by the uploader.

View File

@ -1,4 +1,4 @@
cairosvg==2.7.1
mkdocs==1.5.3
mkdocs-material==9.5.13
pillow==10.2.0
mkdocs-material==9.5.17
pillow==10.3.0