From 959a9fbd020958e3e42344e583479691a224a010 Mon Sep 17 00:00:00 2001 From: Omar Roth Date: Wed, 8 Aug 2018 10:36:46 -0500 Subject: [PATCH] Updated API (markdown) --- API.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/API.md b/API.md index 8fe2239..515eb02 100644 --- a/API.md +++ b/API.md @@ -220,6 +220,11 @@ ] ``` +Parameters: +``` +page: Int32 +``` + ##### GET `/api/v1/search` > Schema: ``` @@ -248,6 +253,15 @@ ] ``` +Parameters +``` +q: String, +page: Int32, +sort_by: "relevance", "rating", "upload_date", "view_count" +date: "hour", "today", "week", "month", "year" +duration: "short", "long" +``` + ##### GET `/api/v1/captions/:id` > Schema: ``` @@ -261,6 +275,14 @@ } ``` +Parameters +``` +label: String +``` + +A request with `label` will return the selected captions in WebVTT format. + + ##### GET `/api/v1/comments/:id` > Schema: ``` @@ -290,4 +312,9 @@ ], "continuation": String? } +``` + +Parameters: +``` +continuation: String ``` \ No newline at end of file