From 235dcae4dfc4d822693e2dab4ccdbf6fd37b776b 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 18:45:32 +0100 Subject: [PATCH] documentation of middlewares --- docs/backend/auth.md | 23 +++++++++++++++++++++++ docs/readme.md | 4 ++++ 2 files changed, 27 insertions(+) create mode 100644 docs/backend/auth.md diff --git a/docs/backend/auth.md b/docs/backend/auth.md new file mode 100644 index 0000000..9252e55 --- /dev/null +++ b/docs/backend/auth.md @@ -0,0 +1,23 @@ +Authentikációhoz a `TypeGraphQL` beépített annotiációi vannak használva. +Egy-egy modellnél mezőnként specifikálva van, hogy mikor lehet lekérni. + +Egyes esetekben `middleware`-ek vannak definiálva, melyek: + +> middleware +> ├── field +> │ ├── isMemberOfGroupField.ts +> │ └── isOwnUserField.ts +> └── resolver +> . ├── isAdminOfGroup.ts +> . ├── isAdmin.ts +> . └── isMemberOfGroup.ts + +Ezek Mező és Resolver szintűek lehetnek. +Itt lehet újabbat felvenni. + +Azért vannak ezek külön választva, mivel míg egy Resolver-nél átadásra kerül +egy groupId és az alapján meg lehet állapítani, hogy van-e joga +a felhasználónak, egy field-nél már a jelenlegi modellből kell lekérni. +Például egy `isMemberOfGroupField` -et egy `Rental` mezőre rárakáskor +megállapítja a middleware, hogy milyen típusú a mező és az alapján lekéri +a hozzá kapcsolódó csoportot. diff --git a/docs/readme.md b/docs/readme.md index 3edb321..6d9ba4e 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -22,6 +22,10 @@ használó Single Page Application áll rendelkezésre. !INCLUDE "backend/api.md" +### Authentikáció + +!INCLUDE "backend/auth.md" + ## Frontend ### Követelmények és konfiguráció -- GitLab