diff --git a/docs/backend/models.md b/docs/backend/models.md index 1a223a45f0bb1b8c0f99a4e96b37d5cb85c27194..9dca2700b0c8b546ef9bc54bd07600fe73f23599 100644 --- a/docs/backend/models.md +++ b/docs/backend/models.md @@ -40,12 +40,20 @@ Union pedig: #### Member +!INCLUDE "models/Group.md" + #### MemberState +!INCLUDE "models/MemberState.md" + #### GroupRole +!INCLUDE "models/GroupRole.md" + #### Storage +!INCLUDE "models/Storage.md" + #### ContainerKind #### ContainerUnion diff --git a/docs/backend/models/GroupRole.md b/docs/backend/models/GroupRole.md new file mode 100644 index 0000000000000000000000000000000000000000..2750a1e02f3062e1708a8dcc91f9c0d317ac9bcc --- /dev/null +++ b/docs/backend/models/GroupRole.md @@ -0,0 +1,7 @@ +Egy enum, mely egy felhasználó jogkörét reprezentálja. +Adatbázisban szövegként képződik le. + +##### Mezői, és azok értékei az adatbázisban: + +- `ADMIN`, `"admin"` : Teljes jogköre van a csoportban +- `NORMAL`, `"normal"` : Minimális hozzáférése van a csoporthoz diff --git a/docs/backend/models/MemberState.md b/docs/backend/models/MemberState.md new file mode 100644 index 0000000000000000000000000000000000000000..26db3dd4cc55820f9e4828915e5ae81c366366ae --- /dev/null +++ b/docs/backend/models/MemberState.md @@ -0,0 +1,8 @@ +Egy enum, mely egy felhasználó státuszát reprezentálja egy csoportban. +Adatbázisban szövegként képződik le. + +##### Mezői, és azok értékei az adatbázisban: + +- `APPLIED`, `"applied"` : Jelentkezett +- `BANNED`, `"banned"` : Kitiltott +- `ACCEPTED`, `"accepted"` : Felvett diff --git a/docs/backend/models/Storage.md b/docs/backend/models/Storage.md new file mode 100644 index 0000000000000000000000000000000000000000..dd14979ae96bc654da7a19ec5f339717e52bb1a3 --- /dev/null +++ b/docs/backend/models/Storage.md @@ -0,0 +1,36 @@ +Egy Tároló modellje. Egy csoportban több tároló is lehet, továbbá +tárolóban is lehetnek tárolók. Ahhoz, hogy egy tárolóról eldönthessük, +hogy mely csoportban van, anélkül, hogy bejárnánk az összes őt +tartalmazó tárolót, letároljuk, hogy mely csoporthoz tartozik. + +Ez azt jelenti, hogy tároló másik csoportba helyezésekor be kell járni az +összes benne lévő tárolót, tárgyat, dokumentumot, kölcsönzést, +hogy frissítsük a csoportjukat. +Ez a lekérdezéshez képest sokkal ritkábban fordul elő és gyorsabb lekéréseket +érhetünk el. + +`storage` táblára képződik le és tároló adatait, benne lévő dolgokra mutató +idegen kulcsokat tartalmaz + +##### Adatbázis Mezői: + +- `id`: Autó inkrementált Egész típusú azonosító szám +- `name`: Tároló neve +- `description`: Leírás +- `location`: Helyzetét meghatározó szöveg +- `parent_id`: Adott tárolót tároló objektum ID-ja +- `parent_type`: Adott tárolót tároló objektum típusa + [[ContainerKind](#ContainerKind)] +- `items`: Tárolóban lévő tárgyak. [[Item](#Item)] +- `group_id`: Csoport ID-ja, amiben benne van + +##### Metódusok: + +- `container`: Adott tárolót tartalmazó tároló vagy csoport. Visszatérési + értéke egy a GraphQL-ben használt Union típusú. + [[ContainerUnion](#ContainerUnion)] +- `contains`: Adott tárolóban lévő tárolók + +##### További mezők: + +- `group`: Visszatér a csoporttal, amelyikhez tartozik diff --git a/docs/backend/models/template.md b/docs/backend/models/template.md new file mode 100644 index 0000000000000000000000000000000000000000..191931b65520d07e907e112fec1fc131bbef9227 --- /dev/null +++ b/docs/backend/models/template.md @@ -0,0 +1,22 @@ +Egy csoport modellje. + +`` 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 +- ``: + +##### Metódusok: + +- ``: + +##### További mezők: + +- ``: + +##### Segéd funkciók: + +- ``: + +##### Fejlesztési lehetőség: