feat: added entry id field on tracks resource (#103)

This commit is contained in:
Kyrch
2024-08-19 01:59:14 -03:00
committed by GitHub
parent 0a533bed99
commit c6e33c1d5b
5 changed files with 23 additions and 20 deletions
+3 -3
View File
@@ -30,9 +30,9 @@ GET /playlist/{playlist:id}/track/{track:id}/backward
## Allowed Include Paths
* video
* video.animethemeentries.animetheme.anime.images
* video.animethemeentries.animetheme.group
* video.animethemeentries.animetheme.song.artists
* animethemeentry.animetheme.anime.images
* animethemeentry.animetheme.group
* animethemeentry.animetheme.song.artists
* video.audio
## Response
+3 -3
View File
@@ -30,9 +30,9 @@ GET /playlist/{playlist:id}/track/{track:id}/forward
## Allowed Include Paths
* video
* video.animethemeentries.animetheme.anime.images
* video.animethemeentries.animetheme.group
* video.animethemeentries.animetheme.song.artists
* animethemeentry.animetheme.anime.images
* animethemeentry.animetheme.group
* animethemeentry.animetheme.song.artists
* video.audio
## Response
+3 -2
View File
@@ -25,8 +25,9 @@ For example, a "/r/anime's Best OPs and EDs of 2022" playlist may contain a trac
* playlist
* previous
* video
* video.animethemeentries.animetheme.anime.images
* video.animethemeentries.animetheme.song.artists
* animethemeentry.animetheme.group
* animethemeentry.animetheme.anime.images
* animethemeentry.animetheme.song.artists
* video.audio
## Endpoints
+8 -7
View File
@@ -6,7 +6,7 @@ title: Playlist Track Store
The playlist track store endpoint creates a new playlist track and returns the new playlist track resource.
For example, the `/playlist/N4hG/track?video_id=2712` endpoint will create a new playlist track for the Bakemonogatari-OP1.webm video and return the new playlist track resource.
For example, the `/playlist/N4hG/track?video_id=2712&entry_id=3814` endpoint will create a new playlist track for the Bakemonogatari-OP1.webm video and return the new playlist track resource.
If `next` is set, the new track will be inserted before the next track in the playlist.
@@ -28,12 +28,13 @@ POST /playlist/{id}/track
## Parameters
| Name | Required | Rules |
| :------: | :------: | :------------------------------------------------------ |
| name | Yes | string, max:192 |
| next | No | string, Track ID Exists in Playlist, prohibits:previous |
| previous | No | string, Track ID Exists in Playlist, prohibits:next |
| video_id | Yes | Video ID Exists |
| Name | Required | Rules |
| :------: | :------: | :--------------------------------------------------------------------------------- |
| name | Yes | string, max:192 |
| next | No | string, Track ID Exists in Playlist, prohibits:previous |
| previous | No | string, Track ID Exists in Playlist, prohibits:next |
| entry_id | Yes | integer, Entry ID Exists, Anime Theme Entry Video Exists when video_id is provided |
| video_id | Yes | integer, Video ID Exists, Anime Theme Entry Video Exists when entry_id is provided |
## Response
+6 -5
View File
@@ -26,11 +26,12 @@ PUT|PATCH /playlist/{id}/track/{id}
## Parameters
| Name | Required | Rules |
| :------: | :------: | :-------------------------------------------------- |
| next | No | string, Track ID exists & Track Playlist ID matches |
| previous | No | string, Track ID exists & Track Playlist ID matches |
| video_id | No | Video ID Exists |
| Name | Required | Rules |
| :------: | :------: | :--------------------------------------------------------------------------------- |
| next | No | string, Track ID exists & Track Playlist ID matches |
| previous | No | string, Track ID exists & Track Playlist ID matches |
| entry_id | No | integer, Entry ID Exists, Anime Theme Entry Video Exists when video_id is provided |
| video_id | No | integer, Video ID Exists, Anime Theme Entry Video Exists when entry_id is provided |
## Response