Cutlery/Kyoo
1
0
Fork 0
mirror of https://github.com/zoriya/Kyoo.git synced 2025-06-03 05:34:23 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix api mermaid indentation

Browse Source
This commit is contained in:
Zoe Roux 2025-03-03 00:01:37 +01:00
parent 97a9a406bb
commit 6d2c9958f9
No known key found for this signature in database
1 changed files with 142 additions and 142 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

284
api/README.md
View File

@ -6,159 +6,159 @@ The many-to-many relation between entries (episodes/movies) & videos is NOT a mi
```mermaid ```mermaid
erDiagram erDiagram
shows { shows {
guid id PK guid id PK
kind kind "serie|movie|collection" kind kind "serie|movie|collection"
string(128) slug UK string(128) slug UK
genre[] genres genre[] genres
int rating "From 0 to 100" int rating "From 0 to 100"
status status "NN" status status "NN"
datetime added_date datetime added_date
date start_air date start_air
date end_air "null for movies" date end_air "null for movies"
datetime next_refresh datetime next_refresh
jsonb external_id jsonb external_id
guid studio_id FK guid studio_id FK
string original_language string original_language
guid collection_id FK guid collection_id FK
} }
show_translations { show_translations {
guid id PK, FK guid id PK, FK
string language PK string language PK
string name "NN" string name "NN"
string tagline string tagline
string[] aliases string[] aliases
string description string description
string[] tags string[] tags
string trailerUrl string trailerUrl
jsonb poster jsonb poster
jsonb banner jsonb banner
jsonb logo jsonb logo
jsonb thumbnail jsonb thumbnail
} }
shows ||--|{ show_translations : has shows ||--|{ show_translations : has
shows |o--|| entries : has shows |o--|| entries : has
shows |o--|| shows : has_collection shows |o--|| shows : has_collection
entries { entries {
guid id PK guid id PK
string(256) slug UK string(256) slug UK
guid show_id FK, UK guid show_id FK, UK
%% Order is absolute number. %% Order is absolute number.
uint order "NN" uint order "NN"
uint season_number UK uint season_number UK
uint episode_number UK "NN" uint episode_number UK "NN"
type type "episode|movie|special|extra" type type "episode|movie|special|extra"
date air_date date air_date
uint runtime uint runtime
jsonb thumbnail jsonb thumbnail
datetime next_refresh datetime next_refresh
jsonb external_id jsonb external_id
} }
entry_translations { entry_translations {
guid id PK, FK guid id PK, FK
string language PK string language PK
string name string name
string description string description
} }
entries ||--|{ entry_translations : has entries ||--|{ entry_translations : has
video { video {
guid id PK guid id PK
string path "NN" string path "NN"
uint rendering "dedup for duplicates part1/2" uint rendering "dedup for duplicates part1/2"
uint part uint part
uint version "max version is preferred rendering" uint version "max version is preferred rendering"
} }
video }|--|{ entries : for video }|--|{ entries : for
seasons { seasons {
guid id PK guid id PK
string(256) slug UK string(256) slug UK
guid show_id FK guid show_id FK
uint season_number "NN" uint season_number "NN"
datetime added_date datetime added_date
date start_air date start_air
date end_air date end_air
datetime next_refresh datetime next_refresh
jsonb external_id jsonb external_id
} }
season_translations { season_translations {
guid id PK,FK guid id PK,FK
string language PK string language PK
string name string name
string description string description
jsonb poster jsonb poster
jsonb banner jsonb banner
jsonb logo jsonb logo
jsonb thumbnail jsonb thumbnail
} }
seasons ||--|{ season_translations : has seasons ||--|{ season_translations : has
seasons ||--o{ entries : has seasons ||--o{ entries : has
shows ||--|{ seasons : has shows ||--|{ seasons : has
watched_shows { watched_shows {
guid show_id PK, FK guid show_id PK, FK
guid user_id PK, FK guid user_id PK, FK
status status "completed|watching|droped|planned" status status "completed|watching|droped|planned"
uint seen_entry_count "NN" uint seen_entry_count "NN"
} }
shows ||--|{ watched_shows : has shows ||--|{ watched_shows : has
watched_entries { watched_entries {
guid entry_id PK, FK guid entry_id PK, FK
guid user_id PK, FK guid user_id PK, FK
uint time "in seconds, null of finished" uint time "in seconds, null of finished"
uint progress "NN, from 0 to 100" uint progress "NN, from 0 to 100"
datetime played_date datetime played_date
} }
entries ||--|{ watched_entries : has entries ||--|{ watched_entries : has
roles { roles {
guid show_id PK, FK guid show_id PK, FK
guid staff_id PK, FK guid staff_id PK, FK
uint order uint order
type type "actor|director|writer|producer|music|other" type type "actor|director|writer|producer|music|other"
jsonb character_image jsonb character_image
} }
role_translations { role_translations {
string language PK string language PK
string character_name string character_name
} }
roles||--o{ role_translations : has roles||--o{ role_translations : has
shows ||--|{ roles : has shows ||--|{ roles : has
staff { staff {
guid id PK guid id PK
string(256) slug UK string(256) slug UK
jsonb image jsonb image
datetime next_refresh datetime next_refresh
jsonb external_id jsonb external_id
} }
staff_translations { staff_translations {
guid id PK,FK guid id PK,FK
string language PK string language PK
string name "NN" string name "NN"
} }
staff ||--|{ staff_translations : has staff ||--|{ staff_translations : has
staff ||--|{ roles : has staff ||--|{ roles : has
studios { studios {
guid id PK guid id PK
string(128) slug UK string(128) slug UK
jsonb logo jsonb logo
datetime next_refresh datetime next_refresh
jsonb external_id jsonb external_id
} }
studio_translations { studio_translations {
guid id PK,FK guid id PK,FK
string language PK string language PK
string name string name
} }
studios ||--|{ studio_translations : has studios ||--|{ studio_translations : has
shows }|--|{ studios : has shows }|--|{ studios : has
``` ```