louis/moviequotebot-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
7 Commits 1 Branch 0 Tags 63 KiB
Rust 93.8%
Dockerfile 6.2%
58f6ddf215
Go to file
Louis Vallat 58f6ddf215 Added some info in README 
Signed-off-by: Louis Vallat <louis@louis-vallat.xyz>
2021-06-09 16:23:48 +02:00
migrations Initial commit 2021-06-09 11:53:04 +02:00
src Initial commit 2021-06-09 11:53:04 +02:00
.gitignore Initial commit 2021-06-09 11:53:04 +02:00
.gitlab-ci.yml Update .gitlab-ci.yml file to fix mismatched tabulation causing bad parent: artifact child of cache 2021-06-09 12:31:13 +00:00
Cargo.lock Initial commit 2021-06-09 11:53:04 +02:00
Cargo.toml Initial commit 2021-06-09 11:53:04 +02:00
diesel.toml Initial commit 2021-06-09 11:53:04 +02:00
Dockerfile added Dockerfile to build project 2021-06-09 14:18:46 +02:00
LICENSE Add LICENSE 2021-06-09 12:32:44 +00:00
README.md Added some info in README 2021-06-09 16:23:48 +02:00

README.md

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.

The data Structures are like:

this image describing the data Structures in MoviesQuoteBot's database

Except the user ids that have been redacted and removed from the API.

Endpoints

Health

You can query /health and if Healthy is returned, the API is alive.

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.

List subtitles

You can use /v1/languages/list to list languages stored in database.