Started creating the docs
This commit is contained in:
34
docs/Diagrams/Models/ApiModels.puml
Normal file
34
docs/Diagrams/Models/ApiModels.puml
Normal file
@@ -0,0 +1,34 @@
|
||||
@startuml ApiModels
|
||||
|
||||
namespace HopFrame.Security {
|
||||
class UserLogin {
|
||||
+Email: string
|
||||
+Password: string
|
||||
}
|
||||
|
||||
class UserRegister {
|
||||
+Username: string
|
||||
+Email: string
|
||||
+Password: string
|
||||
}
|
||||
}
|
||||
|
||||
namespace HopFrame.Web {
|
||||
class RegisterData {
|
||||
+RepeatedPassword: string
|
||||
}
|
||||
}
|
||||
|
||||
namespace HopFrame.Api {
|
||||
class SingleValueResult<TValue> {
|
||||
+Value: TValue
|
||||
}
|
||||
|
||||
class UserPasswordValidation {
|
||||
+Password: string
|
||||
}
|
||||
}
|
||||
|
||||
UserRegister <|-- RegisterData
|
||||
|
||||
@enduml
|
||||
37
docs/Diagrams/Models/BaseModels.puml
Normal file
37
docs/Diagrams/Models/BaseModels.puml
Normal file
@@ -0,0 +1,37 @@
|
||||
@startuml BaseModels
|
||||
set namespaceSeparator none
|
||||
|
||||
namespace HopFrame.Database {
|
||||
class User {
|
||||
+Id: Guid
|
||||
+Username: string
|
||||
+Email: string
|
||||
+CreatedAt: DateTime
|
||||
+Permissions: IList<Permission>
|
||||
}
|
||||
|
||||
class Permission {
|
||||
+Id: long
|
||||
+PermissionName: string
|
||||
+Owner: Guid
|
||||
+GrantedAt: DateTime
|
||||
}
|
||||
|
||||
class PermissionGroup {
|
||||
+Name: string
|
||||
+IsDefaultGroup: bool
|
||||
+Description: string
|
||||
+CreatedAt: DateTime
|
||||
+Permissions: IList<Permission>
|
||||
}
|
||||
|
||||
interface IPermissionOwner {}
|
||||
}
|
||||
|
||||
IPermissionOwner <|-- User
|
||||
IPermissionOwner <|-- PermissionGroup
|
||||
|
||||
User .. Permission
|
||||
PermissionGroup .. Permission
|
||||
|
||||
@enduml
|
||||
41
docs/Diagrams/Models/DatabaseModels.puml
Normal file
41
docs/Diagrams/Models/DatabaseModels.puml
Normal file
@@ -0,0 +1,41 @@
|
||||
@startuml DatabaseModels
|
||||
set namespaceSeparator none
|
||||
|
||||
namespace HopFrame.Database {
|
||||
class UserEntry {
|
||||
+Id: string
|
||||
+Username: string
|
||||
+Email: string
|
||||
+Password: string
|
||||
+CreatedAt: DateTime
|
||||
}
|
||||
|
||||
class TokenEntry {
|
||||
{static} +RefreshTokenType: int = 0
|
||||
{static} +AccessTokenType: int = 1
|
||||
|
||||
+Type: int
|
||||
+Token: string
|
||||
+UserId: string
|
||||
+CreatedAt: DateTime
|
||||
}
|
||||
|
||||
class PermissionEntry {
|
||||
+RecordId: long
|
||||
+PermissionText: string
|
||||
+UserId: string
|
||||
+GrantedAt: DateTime
|
||||
}
|
||||
|
||||
class GroupEntry {
|
||||
+Name: string
|
||||
+Default: bool
|
||||
+Description: string
|
||||
+CreatedAt: DateTime
|
||||
}
|
||||
}
|
||||
|
||||
UserEntry *-- TokenEntry
|
||||
UserEntry *-- PermissionEntry
|
||||
|
||||
@enduml
|
||||
21
docs/Diagrams/Models/README.md
Normal file
21
docs/Diagrams/Models/README.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Models for HopFrame
|
||||
|
||||
This page shows all models that HopFrame uses.
|
||||
|
||||
|
||||
## Base Models
|
||||
These are the models used by the various database services.
|
||||
|
||||

|
||||
|
||||
|
||||
## API Models
|
||||
These are the models used by the REST API and the Blazor API.
|
||||
|
||||

|
||||
|
||||
|
||||
## Database Models
|
||||
These are the models that correspond to the scheme in the Database
|
||||
|
||||

|
||||
1
docs/Diagrams/Models/img/ApiModels.svg
Normal file
1
docs/Diagrams/Models/img/ApiModels.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 15 KiB |
1
docs/Diagrams/Models/img/BaseModels.svg
Normal file
1
docs/Diagrams/Models/img/BaseModels.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 13 KiB |
1
docs/Diagrams/Models/img/DatabaseModels.svg
Normal file
1
docs/Diagrams/Models/img/DatabaseModels.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 14 KiB |
Reference in New Issue
Block a user