Updated API (markdown)

This commit is contained in:
Omar Roth 2018-08-08 10:36:46 -05:00
parent c50902f5cc
commit 959a9fbd02

27
API.md
View File

@ -220,6 +220,11 @@
] ]
``` ```
Parameters:
```
page: Int32
```
##### GET `/api/v1/search` ##### GET `/api/v1/search`
> Schema: > 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` ##### GET `/api/v1/captions/:id`
> Schema: > 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` ##### GET `/api/v1/comments/:id`
> Schema: > Schema:
``` ```
@ -290,4 +312,9 @@
], ],
"continuation": String? "continuation": String?
} }
```
Parameters:
```
continuation: String
``` ```