knotteye
/
satyr
Archived
1
0
Fork 0
Code Issues Pull Requests Releases 5 Wiki Activity

Fix typo and add functions to be implemented.

merge-requests/14/head
knotteye 2020-07-29 03:40:53 -05:00
parent bd40c30114
commit fb6538a757
1 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/REST.md
View File

@ -132,7 +132,7 @@ Response: Returns `{error: "error code"}` or `{success: ""}`
## /api/user/vods/delete ### /api/user/vods/delete
Delete the specified vods of the current user Delete the specified vods of the current user
@ -144,7 +144,7 @@ Paramters: A string array of the names of vods to be deleted.
Response: Returns `{error: "error code"}` or `{success: ""}` Response: Returns `{error: "error code"}` or `{success: ""}`
## /api/user/password ### /api/user/password
Change the current user's password Change the current user's password
@ -158,7 +158,7 @@ Response: Returns `{error: "error code"}` or `{success: ""}`
## /api/user/streamkey ### /api/user/streamkey
Change the current user's stream key. This will not affect the stream if the user is currently live. Change the current user's stream key. This will not affect the stream if the user is currently live.
@ -170,7 +170,7 @@ Parameters: A valid JWT cookie. No other parameters.
Response: Returns `{error: "error code"}` or `{success: "new_stream_key"}` Response: Returns `{error: "error code"}` or `{success: "new_stream_key"}`
## /api/:user/vods/list ### /api/:user/vods/list
Get a list of the named users VODs Get a list of the named users VODs
@ -182,4 +182,21 @@ Parameters: none
Response: Returns an array of VODs with the format `[{"name":"yote.mp4"},{"name":"yeet.mp4"}]` Response: Returns an array of VODs with the format `[{"name":"yote.mp4"},{"name":"yeet.mp4"}]`
Notes: VODs are always available at http://domain.com/publicEndpoint/username/filename.mp4 Notes: VODs are always available at http://domain.com/publicEndpoint/username/filename.mp4
## Not Yet Implemented
#### /api/:user/info
List bio, stream title. If authenticated, list all settings.
#### /api/user/streamkey/current
Return current stream key
#### /api/users/live
Paging and sorting coming Soon(tm)