Integrated models directly into docs
This commit is contained in:
@@ -1,26 +0,0 @@
|
|||||||
@startuml ApiModels
|
|
||||||
|
|
||||||
namespace HopFrame.Security {
|
|
||||||
class UserLogin {
|
|
||||||
+Email: string
|
|
||||||
+Password: string
|
|
||||||
}
|
|
||||||
|
|
||||||
class UserRegister {
|
|
||||||
+Username: string
|
|
||||||
+Email: string
|
|
||||||
+Password: string
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
namespace HopFrame.Api {
|
|
||||||
class SingleValueResult<TValue> {
|
|
||||||
+Value: TValue
|
|
||||||
}
|
|
||||||
|
|
||||||
class UserPasswordValidation {
|
|
||||||
+Password: string
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@enduml
|
|
||||||
@@ -1,37 +0,0 @@
|
|||||||
@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
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
@startuml DatabaseModels
|
|
||||||
set namespaceSeparator none
|
|
||||||
|
|
||||||
namespace HopFrame.Database {
|
|
||||||
class UserEntry {
|
|
||||||
+Id: string
|
|
||||||
+Username: string
|
|
||||||
+Email: string
|
|
||||||
+Password: string
|
|
||||||
+CreatedAt: DateTime
|
|
||||||
}
|
|
||||||
|
|
||||||
class TokenEntry {
|
|
||||||
+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
|
|
||||||
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 12 KiB |
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 13 KiB |
File diff suppressed because one or more lines are too long
|
Before Width: | Height: | Size: 14 KiB |
100
docs/models.md
100
docs/models.md
@@ -6,16 +6,110 @@ This page shows all models that HopFrame uses.
|
|||||||
## Base Models
|
## Base Models
|
||||||
These are the models used by the various database services.
|
These are the models used by the various database services.
|
||||||
|
|
||||||

|
```plantuml
|
||||||
|
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
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## API Models
|
## API Models
|
||||||
These are the models used by the REST API and the Blazor API.
|
These are the models used by the REST API and the Blazor API.
|
||||||
|
|
||||||

|
```plantuml
|
||||||
|
namespace HopFrame.Security {
|
||||||
|
class UserLogin {
|
||||||
|
+Email: string
|
||||||
|
+Password: string
|
||||||
|
}
|
||||||
|
|
||||||
|
class UserRegister {
|
||||||
|
+Username: string
|
||||||
|
+Email: string
|
||||||
|
+Password: string
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
namespace HopFrame.Api {
|
||||||
|
class SingleValueResult<TValue> {
|
||||||
|
+Value: TValue
|
||||||
|
}
|
||||||
|
|
||||||
|
class UserPasswordValidation {
|
||||||
|
+Password: string
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Database Models
|
## Database Models
|
||||||
These are the models that correspond to the scheme in the Database
|
These are the models that correspond to the scheme in the Database
|
||||||
|
|
||||||

|
```plantuml
|
||||||
|
set namespaceSeparator none
|
||||||
|
|
||||||
|
namespace HopFrame.Database {
|
||||||
|
class UserEntry {
|
||||||
|
+Id: string
|
||||||
|
+Username: string
|
||||||
|
+Email: string
|
||||||
|
+Password: string
|
||||||
|
+CreatedAt: DateTime
|
||||||
|
}
|
||||||
|
|
||||||
|
class TokenEntry {
|
||||||
|
+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
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user