Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CommonRequest ¶
type GroupRequest ¶
type GroupRequest struct {
// The ID of the group.
//
// required: false
// example: 1
ID uint `json:"id"`
// The UUID of the group.
//
// required: false
// example: "f3b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
UUID string `json:"uuid"`
// The name of the group.
//
// required: true
// example: "My Group"
Name string `json:"name"`
// The timestamp of when the group was created.
//
// required: false
// example: "2023-01-01T00:00:00Z"
CreatedAt *time.Time `json:"created_at"`
// The timestamp of when the group was last updated.
//
// required: false
// example: "2023-01-01T00:00:00Z"
UpdatedAt *time.Time `json:"updated_at"`
// The timestamp of when the group was deleted.
//
// required: false
// example: "2023-01-01T00:00:00Z"
DeletedAt *time.Time `json:"deleted_at"`
}
GroupRequest represents the request body for group-related operations. swagger:model GroupRequest
type LoginRequest ¶
type LoginRequest struct {
Email string `json:"email" binding:"required"`
Password string `json:"password" binding:"required"`
}
LoginRequest represents login credentials
type MemberRequest ¶
type MemberRequest struct {
// The ID of the member.
//
// required: false
// example: 1
ID uint `json:"id"`
// The UUID of the member.
//
// required: false
// example: "f3b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
UUID string `json:"uuid"`
// The UUID of the group.
//
// required: true
// example: "f3b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
GroupUUID string `json:"group_uuid"`
// The UUID of the user.
//
// required: true
// example: "f3b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
UserUUID string `json:"user_uuid"`
// The role of the member.
//
// required: true
// example: "admin"
Role string `json:"role"`
// The timestamp of when the member was created.
//
// required: false
// example: "2023-01-01T00:00:00Z"
CreatedAt *time.Time `json:"created_at"`
// The timestamp of when the member was last updated.
//
// required: false
// example: "2023-01-01T00:00:00Z"
UpdatedAt *time.Time `json:"updated_at"`
// The timestamp of when the member was deleted.
//
// required: false
// example: "2023-01-01T00:00:00Z"
DeletedAt *time.Time `json:"deleted_at"`
}
MemberRequest represents the request body for member-related operations. swagger:model MemberRequest
type RefreshTokenRequest ¶
type RefreshTokenRequest struct {
RefreshToken string `json:"refresh_token" binding:"required"`
}
RefreshTokenRequest represents refresh token request
type RolePermissionItem ¶
RolePermissionItem: permission element (resource, action) swagger:model RolePermissionItem
type RolePermissionRequest ¶
type RolePermissionRequest struct {
Role string `json:"role"` // role name
Permissions []RolePermissionItem `json:"permissions"` // permissions list
}
RolePermissionRequest: role creation/update request body swagger:model RolePermissionRequest
type UserRequest ¶
type UserRequest struct {
// The ID of the user.
//
// required: false
// example: 1
ID uint `json:"id"`
// The UUID of the user.
//
// required: false
// example: "f3b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
UUID string `json:"uuid"`
// The name of the user.
//
// required: true
// example: "John Doe"
Name string `json:"name"`
// The email of the user.
//
// required: true
// example: "jhon.doe@example.com"
Email string `json:"email"`
// The password of the user.
//
// required: true
// example: "password"
Password string `json:"password"`
// The timestamp of when the user was created.
//
// required: false
// example: "2023-01-01T00:00:00Z"
CreatedAt *time.Time `json:"created_at"`
// The timestamp of when the user was last updated.
//
// required: false
// example: "2023-01-01T00:00:00Z"
UpdatedAt *time.Time `json:"updated_at"`
// The timestamp of when the user was deleted.
//
// required: false
// example: "2023-01-01T00:00:00Z"
DeletedAt *time.Time `json:"deleted_at"`
}
UserRequest represents the request body for user-related operations. swagger:model UserRequest
Click to show internal directories.
Click to hide internal directories.