Documentation
¶
Overview ¶
Package userapp maintains the app layer api for the user domain.
Index ¶
- type App
- func (a *App) Create(ctx context.Context, app NewUser) (User, error)
- func (a *App) Delete(ctx context.Context) error
- func (a *App) Query(ctx context.Context, qp QueryParams) (page.Document[User], error)
- func (a *App) QueryByID(ctx context.Context) (User, error)
- func (a *App) Update(ctx context.Context, app UpdateUser) (User, error)
- func (a *App) UpdateRole(ctx context.Context, app UpdateUserRole) (User, error)
- type NewUser
- type QueryParams
- type UpdateUser
- type UpdateUserRole
- type User
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type App ¶
type App struct {
// contains filtered or unexported fields
}
App manages the set of app layer api functions for the user domain.
func NewAppWithAuth ¶
NewAppWithAuth constructs a user app API for use with auth support.
func (*App) UpdateRole ¶
UpdateRole updates an existing user's role.
type NewUser ¶
type NewUser struct {
Name string `json:"name" validate:"required"`
Email string `json:"email" validate:"required,email"`
Roles []string `json:"roles" validate:"required"`
Department string `json:"department"`
Password string `json:"password" validate:"required"`
PasswordConfirm string `json:"passwordConfirm" validate:"eqfield=Password"`
}
NewUser defines the data needed to add a new user.
type QueryParams ¶
type QueryParams struct {
Page string
Rows string
OrderBy string
ID string
Name string
Email string
StartCreatedDate string
EndCreatedDate string
}
QueryParams represents the set of possible query strings.
type UpdateUser ¶
type UpdateUser struct {
Name *string `json:"name"`
Email *string `json:"email" validate:"omitempty,email"`
Department *string `json:"department"`
Password *string `json:"password"`
PasswordConfirm *string `json:"passwordConfirm" validate:"omitempty,eqfield=Password"`
Enabled *bool `json:"enabled"`
}
UpdateUser defines the data needed to update a user.
func (*UpdateUser) Decode ¶
func (app *UpdateUser) Decode(data []byte) error
Decode implments the decoder interface.
func (UpdateUser) Validate ¶
func (app UpdateUser) Validate() error
Validate checks the data in the model is considered clean.
type UpdateUserRole ¶
type UpdateUserRole struct {
Roles []string `json:"roles" validate:"required"`
}
UpdateUserRole defines the data needed to update a user role.
func (*UpdateUserRole) Decode ¶
func (app *UpdateUserRole) Decode(data []byte) error
Decode implments the decoder interface.
func (UpdateUserRole) Validate ¶
func (app UpdateUserRole) Validate() error
Validate checks the data in the model is considered clean.
type User ¶
type User struct {
ID string `json:"id"`
Name string `json:"name"`
Email string `json:"email"`
Roles []string `json:"roles"`
PasswordHash []byte `json:"-"`
Department string `json:"department"`
Enabled bool `json:"enabled"`
DateCreated string `json:"dateCreated"`
DateUpdated string `json:"dateUpdated"`
}
User represents information about an individual user.
Source Files