From 8d5b7e1b3bcb6f00c28992d053408ef7dc1c9541 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rafael=20L=C3=A1szl=C3=B3?= <rlacko99@gmail.com>
Date: Wed, 16 Dec 2020 17:59:11 +0100
Subject: [PATCH] all backend models documented

---
 docs/backend/models.md                | 12 +++++++++-
 docs/backend/models/ContainerKind.md  | 12 ++++++++++
 docs/backend/models/ContainerUnion.md |  4 ++++
 docs/backend/models/Document.md       | 21 +++++++++++++++++
 docs/backend/models/Item.md           | 27 +++++++++++++++++++++
 docs/backend/models/ItemDocument.md   | 16 +++++++++++++
 docs/backend/models/Rental.md         | 34 +++++++++++++++++++++++++++
 7 files changed, 125 insertions(+), 1 deletion(-)
 create mode 100644 docs/backend/models/ContainerKind.md
 create mode 100644 docs/backend/models/ContainerUnion.md
 create mode 100644 docs/backend/models/Document.md
 create mode 100644 docs/backend/models/Item.md
 create mode 100644 docs/backend/models/ItemDocument.md
 create mode 100644 docs/backend/models/Rental.md

diff --git a/docs/backend/models.md b/docs/backend/models.md
index 9dca270..0657023 100644
--- a/docs/backend/models.md
+++ b/docs/backend/models.md
@@ -56,14 +56,24 @@ Union pedig:
 
 #### ContainerKind
 
+!INCLUDE "models/ContainerKind.md"
+
 #### ContainerUnion
 
+!INCLUDE "models/ContainerUnion.md"
+
 #### Item
 
+!INCLUDE "models/Item.md"
+
 #### Document
 
+!INCLUDE "models/Document.md"
+
 #### ItemDocument
 
+!INCLUDE "models/ItemDocument.md"
+
 #### Rental
 
-## Frontend
+!INCLUDE "models/Rental.md"
diff --git a/docs/backend/models/ContainerKind.md b/docs/backend/models/ContainerKind.md
new file mode 100644
index 0000000..0711795
--- /dev/null
+++ b/docs/backend/models/ContainerKind.md
@@ -0,0 +1,12 @@
+Egy enum, mely egy tároló típusát jelöli.
+Tárolók tárolóinak jelöléséhez használatos.
+Adatbázisban szövegként képződik le.
+
+##### Mezői, és azok értékei az adatbázisban:
+
+- `Group`, `"group"` : Csoport
+- `Storage`, `"storage"` : Tároló
+
+##### Fejlesztési lehetőség:
+
+Group és Storage mező átfaktorálása GROUP és STORAGE-re.
diff --git a/docs/backend/models/ContainerUnion.md b/docs/backend/models/ContainerUnion.md
new file mode 100644
index 0000000..a40ef8f
--- /dev/null
+++ b/docs/backend/models/ContainerUnion.md
@@ -0,0 +1,4 @@
+Egy Union, mely lehetővé teszi, hogy [[Storage](#Storage)]-el vagy
+[[Group](#Group)]-al térjünk vissza mikor a tárolót tároló objektumot
+kérjük le.
+Adatbázisban szövegként képződik le.
diff --git a/docs/backend/models/Document.md b/docs/backend/models/Document.md
new file mode 100644
index 0000000..0e2cc39
--- /dev/null
+++ b/docs/backend/models/Document.md
@@ -0,0 +1,21 @@
+Egy dokumentum modellje.
+
+`documents` táblára képződik le és egy csoport adatait tartalmazza
+
+##### Adatbázis Mezői:
+
+- `id`: Autó inkrementált Egész típusú azonosító szám
+- `description`: Leírás
+- `location`: Egy szöveg, melyből azonosítható a hely ahol van
+- `purchase_date`: Vásárlási dátum
+- `end_of_warranty`: Garancia vége
+- `group_id`: Csoport ID-ja, melyhez tartozik
+
+##### Metódusok:
+
+- `items`: Kapcsolódó tárgyak [[Item](#Item)]
+
+##### További mezők:
+
+- `itemConnection`: Kapcsolódó [[ItemDocument](#ItemDocument)] -ek
+- `group`: Csoport, melyhez tartozik
diff --git a/docs/backend/models/Item.md b/docs/backend/models/Item.md
new file mode 100644
index 0000000..5451230
--- /dev/null
+++ b/docs/backend/models/Item.md
@@ -0,0 +1,27 @@
+Egy tárgy modellje.
+
+`items` táblára képződik le és egy csoport adatait tartalmazza
+
+##### Adatbázis Mezői:
+
+- `id`: Autó inkrementált Egész típusú azonosító szám
+- `name`: Tárgy neve
+- `description`: Tárgy leírása
+- `is_lost`: Elveszett-e a tárgy
+- `last_seen_date`: Utoljára mikor látták
+- `added_date`: Mikor került hozzáadásra
+- `container_id`: Tartalmazó tároló id-ja
+- `groupId`: Csoport ID-ja, melyhez tartozik
+
+##### Metódusok:
+
+- `activeRental`: Aktív kölcsönzés [[Rental](#Rental)]
+- `isRented`: Jelenleg kölcsönzött-e?
+- `documents`: Kapcsolódó dokumentumok
+
+##### További mezők:
+
+- `container`: Tártalmazó tároló [[Storage](#Storage)]
+- `rentalConnection`: Kapcsolódó kölcsönzések [[Rental](#Rental)]
+- `documentConnection`: Kapcsolódó dokumentumokkal való kapcsolat
+- `group`: Csoport melyhez tartozik
diff --git a/docs/backend/models/ItemDocument.md b/docs/backend/models/ItemDocument.md
new file mode 100644
index 0000000..b0619b9
--- /dev/null
+++ b/docs/backend/models/ItemDocument.md
@@ -0,0 +1,16 @@
+[[Item](#Item)] és [[Document](#Document)] közti kapcsoló tábla.
+Azért kell külön kapcsoló tábla, mert egy dokumentumhoz
+több tárgy és több tárgyhoz egy dokumentum is kapcsolódhat.
+
+`item_documents` táblára képződik le. Kapcsolódó tárgy és dokumentum együtt
+az egyedi kulcs
+
+##### Adatbázis Mezői:
+
+- `item_id`: Tárgy id-ja
+- `document_id`: Dokumentum id-ja
+
+##### További mezők:
+
+- `item`: Tárgy amire az ID mutat
+- `document`: Dokumentum amire az ID mutat
diff --git a/docs/backend/models/Rental.md b/docs/backend/models/Rental.md
new file mode 100644
index 0000000..f340620
--- /dev/null
+++ b/docs/backend/models/Rental.md
@@ -0,0 +1,34 @@
+Egy kölcsönzés modellje.
+
+`rentals` táblára képződik le és egy kölcsönzés adatait tartalmazza
+
+##### Adatbázis Mezői:
+
+- `id`: Autó inkrementált Egész típusú azonosító szám
+- `reposession_date`: Mikor került visszavételre
+- `reposession_comment`: Megjegyzés a visszavételhez
+- `rent_date`: Kölcsönzés dátuma
+- `rent_comment`: Megjegyzés a kölcsönzéshez
+- `rented_from_id`: Felhasználó ID-ja, akitől kölcsönözték
+- `renter_id`: Kölcsönző felhasználó ID-ja
+- `deadline`: Határidő amíg vissza kell hoznia
+- `item_id`: Tárgy ID-ja ami kölcsönzésre került
+- `recipient_id`: Átvevő felhasználó ID-ja
+- `group_id`: Csoport ID, melyhez tartozik
+
+##### Metódusok:
+
+- `isRented`: Jelenleg kölcsönzés alatt van-e
+
+##### További mezők:
+
+- `renter`: Kölcsönző felhasználó [[User](#User)]
+- `item`: Kölcsönzőtt tárgy [[Item](#Item)]
+- `recipient`: Átvevő felhasználó [[User](#Group)]
+- `group`: Csoport, melyhez tartozik [[User](#Group)]
+
+##### Segéd funkciók:
+
+- ``:
+
+##### Fejlesztési lehetőség:
-- 
GitLab