mirror of
https://github.com/tubearchivist/tubearchivist-frontend.git
synced 2024-11-24 20:50:14 +00:00
add documentation for sponsorblock api endpoints
This commit is contained in:
parent
03dd25cff4
commit
a84e657577
@ -70,6 +70,43 @@ POST /api/video/\<video_id>/progress
|
|||||||
### Delete player position of video
|
### Delete player position of video
|
||||||
DELETE /api/video/\<video_id>/progress
|
DELETE /api/video/\<video_id>/progress
|
||||||
|
|
||||||
|
|
||||||
|
## Sponsor Block View
|
||||||
|
/api/video/\<video_id>/sponsor/
|
||||||
|
|
||||||
|
Integrate with sponsorblock
|
||||||
|
|
||||||
|
### Get list of segments
|
||||||
|
GET /api/video/\<video_id>/sponsor/
|
||||||
|
|
||||||
|
|
||||||
|
### Vote on existing segment
|
||||||
|
**This only simulates the request**
|
||||||
|
POST /api/video/\<video_id>/sponsor/
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"vote": {
|
||||||
|
"uuid": "<uuid>",
|
||||||
|
"yourVote": 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
yourVote needs to be *int*: 0 for downvote, 1 for upvote, 20 to undo vote
|
||||||
|
|
||||||
|
### Create new segment
|
||||||
|
**This only simulates the request**
|
||||||
|
POST /api/video/\<video_id>/sponsor/
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"segment": {
|
||||||
|
"startTime": 5,
|
||||||
|
"endTime": 10
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Timestamps either *int* or *float*, end time can't be before start time.
|
||||||
|
|
||||||
|
|
||||||
## Channel List View
|
## Channel List View
|
||||||
/api/channel/
|
/api/channel/
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user