Mirror/SponsorBlock
1
0
Fork 0
mirror of https://github.com/ajayyy/SponsorBlock.git synced 2025-12-24 16:38:47 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated API Docs (markdown)

Ajay Ramachandran
2020-09-04 12:02:17 -04:00
parent 10d7482534
commit 6b544a5599
1 changed files with 51 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
API-Docs.md

@@ -325,6 +325,56 @@ __________________________________________________________________
These can only be called by the users added to the VIP table.
**GET** `/api/isUserVIP`
**Input**:
```
{
userID: string, // private userID
}
```
**Response**:
```
{
hashedUserID: string,
vip: boolean
}
```
**Error codes**:
400: Bad Request (Your inputs are wrong/impossible)
__________________________________________________________________
**POST** `/api/noSegments`
Will block new segment submissions of the specified category on that video.
**Input** (Request Body):
```
{
videoID: string,
userID: string,
categories: string[]
}
```
**Response**:
```
{
Nothing (status code 200)
}
```
**Error codes**:
400: Bad Request (Your inputs are wrong/impossible)
403: Unauthorized (You are not a VIP)
__________________________________________________________________
**POST** `/api/shadowBanUser`
Shadow banned submissions are hidden for everyone but the IP that originally submitted it. Shadow banning a user shadow bans all future submissions.
@@ -349,7 +399,7 @@ Shadow banned submissions are hidden for everyone but the IP that originally sub
**Error codes**:
400: Bad Request (Your inputs are wrong/impossible)
403: Unauthorized (You are not an admin)
403: Unauthorized (You are not a VIP)
__________________________________________________________________
### Admin Calls