louis/moviequotebot-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added some info in README

Browse Source 
Signed-off-by: Louis Vallat <louis@louis-vallat.xyz>
This commit is contained in:
Louis Vallat 2021-06-09 16:23:48 +02:00
parent ad5feeb2e3
commit 58f6ddf215
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -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.