iv-org/documentation
1
0
Fork 0
mirror of https://github.com/iv-org/documentation.git synced 2025-01-03 11:30:52 -05:00
Code Issues Packages Projects Releases Wiki Activity

Remove references to fields and pretty (#500)

Browse Source
This commit is contained in:
ChunkyProgrammer 2024-04-15 12:12:56 -04:00 committed by GitHub
parent 7914e9b17f
commit 4d7250c23c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 1 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/api.md
View File

@ -4,14 +4,6 @@
All endpoints that return a JSON body support `&hl=LANGUAGE` for translating fields into the desired language. A list of languages are provided in [List of URL parameters](./url-parameters.md). All endpoints that return a JSON body support `&hl=LANGUAGE` for translating fields into the desired language. A list of languages are provided in [List of URL parameters](./url-parameters.md).
### Pretty
All endpoints that return a JSON body support `&pretty=1` for printing the response as formatted JSON.
### Fields
All endpoints that return a JSON body support the [fields API](https://developers.google.com/youtube/v3/getting-started#fields) for specifying desired fields to reduce bandwidth consumption. This can be used by adding `&fields=FIELDS` with the desired fields, for example [`/api/v1/videos/aqz-KE-bpKQ?fields=videoId,title,description&pretty=1`](https://invidio.us/api/v1/videos/aqz-KE-bpKQ?fields=videoId,title,description&pretty=1).
##### GET `/api/v1/stats` ##### GET `/api/v1/stats`
> Schema: > Schema:

2
docs/api/authenticated-endpoints.md
View File

@ -114,7 +114,7 @@ Provides an [EventSource](https://developer.mozilla.org/en-US/docs/Web/API/Event
Important to note is that an event will also be sent when a channel _changes_ an already uploaded video, for example changing description or title. Important to note is that an event will also be sent when a channel _changes_ an already uploaded video, for example changing description or title.
Each event is a JSON object with the same schema as `/api/v1/videos`. The `fields` API can be used, which will be applied to each object. Each event is a JSON object with the same schema as `/api/v1/videos`.
A `debug` topic can also provided which will return a (psuedo-)randomly selected video every minute. A `debug` topic can also provided which will return a (psuedo-)randomly selected video every minute.