moviequotebot-api/README.md
2021-06-09 12:44:14 +00:00

24 lines
881 B
Markdown

# MovieQuoteBot API
A simple API written in Rust for MovieQuoteBot that returns JSON data via HTTP.
> This API is in an unstable state: it will surely change a lot.
## Endpoints
### V1
#### List subtitles
You can use `/v1/subtitles/list` to list subtitles stored in database:
##### Structure
- `subtitles`: all subtitles stored in database
- `films`: the films associated with these subtitles, linked by their id: `subtitles.film_id` -> `films.id`
- `languages`: the languages associated with these subtitles, linked by their id: `subtitles.language_id` -> `languages.id`
The time is represented using the UTC Timezone.
The data Structures are like ![this image describing the data Structures in MoviesQuoteBot's database](https://gitlab.com/lovallat/moviesquotebot/-/blob/master/DatabaseSchema.png), except the user ids that have been redacted and removed from the API.