matthew/satyr
1
0
Fork 0
mirror of https://git.waldn.net/git/knotteye/satyr.git synced 2025-10-23 04:32:41 +00:00
Code Issues Projects Releases Wiki Activity

Change API to set content-type headers.

Browse Source 
Rework some responses to make all responses in JSON.
Increment version because of major API changes.
This commit is contained in:
knotteye
2020-08-03 05:01:20 -05:00
parent 0b7b040ade
commit 654b65640f
4 changed files with 61 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/REST.md
View File

@@ -68,9 +68,11 @@ sort is the optional way to sort results. current options are "alphabet" and "al
page is the page number (i.e. skip the first num * page results)
**Response**: Returns an array of objects containing the username and title of each stream. Returns an empty array if no one is streaming. Returns `{"error":"error code"}` in the event of an error. Will attempt to correct malformed requests to default values.
**Response**: Returns an array of JSON objects containing the username and title of each stream. Returns an empty array if no one is streaming. Returns `{"error":"error code"}` in the event of an error. Will attempt to correct malformed requests to default values.
**Example**: `[{username:"foo", title:"bar"}]`
The array will be wrapped in a JSON object under the key 'users'.
**Example**: `{users: [{username:"foo", title:"bar"}] }`
## /api/users/all
@@ -194,7 +196,7 @@ Get a list of the named users VODs
**Parameters**: user
**Response**: Returns an array of VODs with the format `[{"name":"yote.mp4"},{"name":"yeet.mp4"}]`
**Response**: Returns an array of VODs inside a JSON object with the format `{"vods": [{"name":"yote.mp4"},{"name":"yeet.mp4"}] }`
**Notes**: VODs are always available at http://domain.com/publicEndpoint/username/filename.mp4