Upstream/invidious
1
0
Fork 0
mirror of https://github.com/iv-org/invidious.git synced 2024-11-04 08:39:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix youtube API function's documentation

Browse Source
This commit is contained in:
Samantaz Fox 2021-05-24 15:20:26 +02:00
parent cbabf0ae7e
commit b7fe212a18
No known key found for this signature in database
GPG Key ID: F42821059186176E
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
src/invidious/helpers/youtube_api.cr
View File

@ -19,7 +19,7 @@ def make_youtube_api_context(region : String | Nil) : Hash
"gl" => region || "US", # Can't be empty! "gl" => region || "US", # Can't be empty!
"clientName" => "WEB", "clientName" => "WEB",
"clientVersion" => HARDCODED_CLIENT_VERS, "clientVersion" => HARDCODED_CLIENT_VERS,
} },
} }
end end
@ -27,8 +27,9 @@ end
# request_youtube_api_browse(continuation) # request_youtube_api_browse(continuation)
# request_youtube_api_browse(browse_id, params) # request_youtube_api_browse(browse_id, params)
# #
# Requests the youtubei/vi/browse endpoint with the required headers # Requests the youtubei/v1/browse endpoint with the required headers
# to get JSON in en-US (english US). # and POST data in order to get a JSON reply in english US that can
# be easily parsed.
# #
# The requested data can either be: # The requested data can either be:
# #
@ -67,8 +68,10 @@ end
#################################################################### ####################################################################
# request_youtube_api_search(search_query, params, region) # request_youtube_api_search(search_query, params, region)
# #
# Requests the youtubei/vi/search endpoint with the required headers # Requests the youtubei/v1/search endpoint with the required headers
# to get JSON in en-US (english US). # and POST data in order to get a JSON reply. As the search results
# vary depending on the region, a region code can be specified in
# order to get non-US results.
# #
# The requested data is a search string, with some additional # The requested data is a search string, with some additional
# paramters, formatted as a base64 string. # paramters, formatted as a base64 string.