// ==========================================================================
// GFast自动生成api操作代码。
// 生成日期：2024-03-29 10:05:02
// 生成路径: api/v1/system/sys_project_introduce.go
// 生成人：gfast
// desc:项目新闻相关参数
// company:云南奇讯科技有限公司
// ==========================================================================

package system

import (
	"github.com/gogf/gf/v2/frame/g"
	commonApi "github.com/tiger1103/gfast/v3/api/v1/common"
	"github.com/tiger1103/gfast/v3/internal/app/system/model"
)

// SysProjectIntroduceSearchReq 分页请求参数
type SysProjectIntroduceSearchReq struct {
	g.Meta    `path:"/list" tags:"项目新闻" method:"get" summary:"项目新闻列表"`
	ProjectId string `p:"projectId"`                                                    // 项目id
	Headline  string `p:"headline"`                                                     // 标题
	RichText  string `p:"richText"`                                                     // 富文本
	CreatedBy string `p:"createdBy"`                                                    // 创建人
	CreatedAt string `p:"createdAt" v:"createdAt@datetime#创建时间需为YYYY-MM-DD hh:mm:ss格式"` // 创建时间
	commonApi.PageReq
	commonApi.Author
}

// SysProjectIntroduceSearchRes 列表返回结果
type SysProjectIntroduceSearchRes struct {
	g.Meta `mime:"application/json"`
	commonApi.ListRes
	List []*model.SysProjectIntroduceListRes `json:"list"`
}

// SysProjectIntroduceAddReq 添加操作请求参数
type SysProjectIntroduceAddReq struct {
	g.Meta `path:"/add" tags:"项目新闻" method:"post" summary:"项目新闻添加"`
	commonApi.Author
	ProjectId int64  `p:"projectId" v:"required#主键ID不能为空"`
	Headline  string `p:"headline" dc:"标题" v:"max-length:64#最大输入字数为64" `
	RichText  string `p:"richText" `
	CreatedBy uint64
}

// SysProjectIntroduceAddRes 添加操作返回结果
type SysProjectIntroduceAddRes struct {
	commonApi.EmptyRes
}

// SysProjectIntroduceEditReq 修改操作请求参数
type SysProjectIntroduceEditReq struct {
	g.Meta `path:"/edit" tags:"项目新闻" method:"put" summary:"项目新闻修改"`
	commonApi.Author
	Id        int64  `p:"id" v:"required#主键ID不能为空"`
	Headline  string `p:"headline" v:"required#标题不能为空"`
	RichText  string `p:"richText" `
	UpdatedBy uint64
}

// SysProjectIntroduceEditRes 修改操作返回结果
type SysProjectIntroduceEditRes struct {
	commonApi.EmptyRes
}

// SysProjectIntroduceGetReq 获取一条数据请求
type SysProjectIntroduceGetReq struct {
	g.Meta `path:"/get" tags:"项目新闻" method:"get" summary:"获取项目新闻信息"`
	commonApi.Author
	Id int64 `p:"Id" v:"required#主键必须"` // 通过主键获取
}

// SysProjectIntroduceGetRes 获取一条数据结果
type SysProjectIntroduceGetRes struct {
	g.Meta `mime:"application/json"`
	*model.SysProjectIntroduceInfoRes
}

// SysProjectIntroduceDeleteReq 删除数据请求
type SysProjectIntroduceDeleteReq struct {
	g.Meta `path:"/delete" tags:"项目新闻" method:"delete" summary:"删除项目新闻"`
	commonApi.Author
	Ids []int64 `p:"ids" v:"required#主键必须"` // 通过主键删除
}

// SysProjectIntroduceDeleteRes 删除数据返回
type SysProjectIntroduceDeleteRes struct {
	commonApi.EmptyRes
}