From 58f6ddf215e7c254e0ea270f75bb0ac03bc9969f Mon Sep 17 00:00:00 2001 From: Louis Vallat Date: Wed, 9 Jun 2021 16:23:48 +0200 Subject: [PATCH] Added some info in README Signed-off-by: Louis Vallat --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 52a3a19..c2ad9ed 100644 --- a/README.md +++ b/README.md @@ -4,13 +4,23 @@ 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](https://gitlab.com/lovallat/moviesquotebot/-/raw/master/DatabaseSchema.png) + +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: +You can use `/v1/subtitles/list` to list subtitles stored in database. ##### Structure @@ -20,4 +30,6 @@ You can use `/v1/subtitles/list` to list subtitles stored in database: 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. +#### List subtitles + +You can use `/v1/languages/list` to list languages stored in database.