iv-org/documentation
1
0
Fork 0
mirror of https://github.com/iv-org/documentation.git synced 2025-05-02 14:56:21 -04:00
Code Issues Projects Releases Packages Wiki Activity

Fix various api documentation issues (#616)

Browse source 
* Fix various documentation issues

* improve documentation for videos api endpoint

* Add badges to video common_type and add sort_by for channel shorts and streams
This commit is contained in:
ChunkyProgrammer 2024-12-16 09:21:49 -05:00 • committed by GitHub
parent 0486c7553f
commit c0a7d6abd9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 53 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/api/channels_endpoint.md
View file

@ -124,6 +124,7 @@ This is the same as requesting `/api/v1/channels/:id/videos` without URL paramet
> URL parameters:
* `continuation`: A continuation token to get the next chunk of items. The token is provided each time this API is requested.
* `sort_by`: Sort order filter. Accepted values: `newest`, `popular` or `oldest`
> Response:
@ -135,6 +136,7 @@ See: GET `/api/v1/channels/:id/videos`
> URL parameters:
* `continuation`: A continuation token to get the next chunk of items. The token is provided each time this API is requested.
* `sort_by`: Sort order filter. Accepted values: `newest`, `popular` or `oldest`
> Response:

10
docs/api/common_types.md
View file

@ -57,7 +57,15 @@
"liveNow": Boolean,
"premium": Boolean,
"isUpcoming": Boolean
"isUpcoming": Boolean,
"isNew" Boolean,
"is4k": Boolean,
"is8k": Boolean,
"isVr180": Boolean,
"isVr360": Boolean,
"is3d": Boolean,
"hasCaptions": Boolean
}
```