response

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2025 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Common

type Common struct {
	ID        uint
	UUID      string
	CreatedAt *time.Time
	UpdatedAt *time.Time
	DeletedAt *time.Time
}

type CommonResponse

type CommonResponse struct {
	Code    string
	Message string
	Commons []Common
}

type CountResponse

type CountResponse struct {
	Code    string `json:"code"`
	Message string `json:"message"`
	Count   int64  `json:"count"`
}

CountResponse generic count response swagger:model CountResponse Simple response that returns only count in addition to code and message Example: {"code":"SUCCESS","message":"Count retrieved","count":123}

type Group

type Group struct {
	// The ID of the group.
	//
	// required: true
	// example: 1
	ID uint `json:"id"`
	// The UUID of the group.
	//
	// required: true
	// 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"`
}

Group represents a group in the system. swagger:model Group

type GroupResponse

type GroupResponse struct {
	// The response code.
	//
	// required: true
	// example: "SUCCESS"
	Code string `json:"code"`
	// The response message.
	//
	// required: true
	// example: "Groups retrieved successfully"
	Message string `json:"message"`
	// The list of groups.
	//
	// required: true
	Groups []Group `json:"groups"`
}

GroupResponse represents the response body for group-related operations. swagger:model GroupResponse

type LoginResponse

type LoginResponse struct {
	Code      string           `json:"code"`
	Message   string           `json:"message"`
	TokenPair *model.TokenPair `json:"token_pair,omitempty"`
	User      *User            `json:"user,omitempty"`
}

LoginResponse represents successful login response

type Member

type Member struct {
	// The ID of the member.
	//
	// required: true
	// example: 1
	ID uint `json:"id"`
	// The UUID of the member.
	//
	// required: true
	// 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"`
}

Member represents a member in the system. swagger:model Member

type MemberResponse

type MemberResponse struct {
	// The response code.
	//
	// required: true
	// example: "SUCCESS"
	Code string `json:"code"`
	// The response message.
	//
	// required: true
	// example: "Members retrieved successfully"
	Message string `json:"message"`
	// The list of members.
	//
	// required: true
	Members []Member `json:"members"`
}

MemberResponse represents the response body for member-related operations. swagger:model MemberResponse

type RefreshTokenResponse

type RefreshTokenResponse struct {
	Code      string           `json:"code"`
	Message   string           `json:"message"`
	TokenPair *model.TokenPair `json:"token_pair,omitempty"`
}

RefreshTokenResponse represents refresh token response

type RoleResponse

type RoleResponse struct {
	Code    string      `json:"code"`
	Message string      `json:"message"`
	Roles   interface{} `json:"roles"`
	Detail  interface{} `json:"detail,omitempty"`
}

RoleResponse: role operation response swagger:model RoleResponse

type User

type User struct {
	// The ID of the user.
	//
	// required: true
	// example: 1
	ID uint `json:"id"`
	// The UUID of the user.
	//
	// required: true
	// example: "f3b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b"
	UUID string `json:"uuid"`
	// The email of the user.
	//
	// required: true
	// example: "jhon.doe@example.com"
	Email string `json:"email"`
	// The name of the user.
	//
	// required: true
	// example: "John Doe"
	Name string `json:"name"`
	// 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"`
}

User represents a user in the system. swagger:model User

type UserResponse

type UserResponse struct {
	// The response code.
	//
	// required: true
	// example: "SUCCESS"
	Code string `json:"code"`
	// The response message.
	//
	// required: true
	// example: "Users retrieved successfully"
	Message string `json:"message"`
	// The list of users.
	//
	// required: true
	Users []User `json:"users"`
}

UserResponse represents the response body for user-related operations. swagger:model UserResponse

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL