Finished documentation

docs/README.md

@@ -1,13 +0,0 @@
-# HopFrame Documentation
-
-- [x] In code documentation
-- [x] Installation
-- [x] Database usage
-- [x] Authorization usage
-- [x] LogicResult usage
-- [x] Repositories usage
-- [x] AuthService usage
-- [x] AuthMiddleware usage
-- [x] AdminPages usage
-- [x] Endpoints usage
-- [x] Blazor pages usage

docs/api/endpoints.md

@@ -14,8 +14,8 @@ Base endpoint: `/api/v1/authentication`\
 
 | Method | Endpoint      | Payload                                                      | Returns               |
 |--------|---------------|--------------------------------------------------------------|-----------------------|
-| PUT    | /login        | [UserLogin](./models.md#UserLogin)                           | access token (string) |
+| PUT    | /login        | [UserLogin](../models.md#UserLogin)                          | access token (string) |
-| POST   | /register     | [UserRegister](./models#UserRegister)                        | access token (string) |
+| POST   | /register     | [UserRegister](../models.md#UserRegister)                    | access token (string) |
 | GET    | /authenticate |                                                              | access token (string) |
 | DELETE | /logout       |                                                              |                       |
 | DELETE | /delete       | [UserPasswordValidation](./models.md#UserPasswordValidation) |                       |

docs/api/models.md

@@ -8,23 +8,6 @@ public struct SingleValueResult<TValue>(TValue value) {
 }
 ```
 
-## UserLogin
-```csharp
-public class UserLogin {
-    public string Email { get; set; }
-    public string Password { get; set; }
-}
-```
-
-## UserRegister
-```csharp
-public class UserRegister {
-    public string Username { get; set; }
-    public string Email { get; set; }
-    public string Password { get; set; }
-}
-```
-
 ## UserPasswordValidation
 ```csharp
 public sealed class UserPasswordValidation {

docs/models.md

@@ -0,0 +1,71 @@
+# HopFrame base models
+All models listed below are part of the core HopFrame components and accessible in all installation variations
+
+> **Note:** All properties of the models that are `virtual` are relational properties and don't directly correspond to columns in the database.
+
+## User
+```csharp
+public class User : IPermissionOwner {
+    public Guid Id { get; init; }
+    public string Username { get; set; }
+    public string Email { get; set; }
+    public string Password { get; set; }
+    public DateTime CreatedAt { get; set; }
+    public virtual List<Permission> Permissions { get; set; }
+    public virtual List<Token> Tokens { get; set; }
+}
+```
+
+## PermissionGroup
+```csharp
+public class PermissionGroup : IPermissionOwner {
+    public string Name { get; init; }
+    public bool IsDefaultGroup { get; set; }
+    public string Description { get; set; }
+    public DateTime CreatedAt { get; set; }
+    public virtual List<Permission> Permissions { get; set; }
+}
+```
+
+## Permission
+```csharp
+public class Permission {
+    public long Id { get; init; }
+    public string PermissionName { get; set; }
+    public DateTime GrantedAt { get; set; }
+    public virtual User User { get; set; }
+    public virtual PermissionGroup Group { get; set; }
+}
+```
+
+## Token
+```csharp
+public class Token {
+    public int Type { get; set; }
+    public Guid Content { get; set; }
+    public DateTime CreatedAt { get; set; }
+    public virtual User Owner { get; set; }
+}
+```
+
+## UserLogin
+```csharp
+public class UserLogin {
+    public string Email { get; set; }
+    public string Password { get; set; }
+}
+```
+
+## UserRegister
+```csharp
+public class UserRegister {
+    public string Username { get; set; }
+    public string Email { get; set; }
+    public string Password { get; set; }
+}
+```
+
+## IPermissionOwner
+```csharp
+public interface IPermissionOwner;
+```

docs/readme.md

@@ -0,0 +1,25 @@
+# HopFrame Documentation
+
+The HopFrame comes in two variations, you can eiter only use the backend with some basic endpoints or with fully fledged blazor pages for managing HopFrame components.
+
+## Shared HopFrame Modules
+
+- [Database](./database.md)
+- [Repositories](./repositories.md)
+- [Base Models](./models.md)
+
+## HopFrame Web API
+
+- [Installation](./api/installation.md)
+- [Endpoints](./api/endpoints.md)
+- [Authorization](./api/authorization.md)
+- [Models](./api/models.md)
+- [LogicResults](./api/logicresults.md)
+
+## HopFrame Blazor library
+
+- [Installation](./blazor/installation.md)
+- [Pages](./blazor/pages.md)
+- [Authorization](./blazor/authorization.md)
+- [Auth Service](./blazor/auth.md)
+- [Admin Context](./blazor/admin.md)