// ==========================================================================
// GFast自动生成api操作代码。
// 生成日期：2023-07-29 16:31:29
// 生成路径: api/v1/system/bus_design_document.go
// 生成人：gfast
// desc:设计管理相关参数
// company:云南奇讯科技有限公司
// ==========================================================================

package system

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

// BusDesignDocumentSearchReq 分页请求参数
type BusDesignDocumentSearchReq struct {
	g.Meta      `path:"/list" tags:"设计管理" method:"get" summary:"设计管理列表"`
	DocumenName string `p:"documenName"`                                                  //文档名称
	CreatedAt   string `p:"createdAt" v:"createdAt@datetime#上传时间需为YYYY-MM-DD hh:mm:ss格式"` //上传时间
	commonApi.PageReq
	commonApi.Author
}

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

// BusDesignDocumentAddReq 添加操作请求参数
type BusDesignDocumentAddReq struct {
	g.Meta `path:"/add" tags:"设计管理" method:"post" summary:"设计管理添加"`
	commonApi.Author
	FileId    int64              `p:"fileId" `
	ProjectId int64              `p:"projectId" `
	FileUrl   []*comModel.UpFile `p:"fileUrl" `
}

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

// BusDesignDocumentEditReq 修改操作请求参数
type BusDesignDocumentEditReq struct {
	g.Meta `path:"/edit" tags:"设计管理" method:"put" summary:"设计管理修改"`
	commonApi.Author
	Id        int64              `p:"id" v:"required#主键ID不能为空"`
	FileId    int64              `p:"fileId" `
	ProjectId int64              `p:"projectId" `
	FileUrl   []*comModel.UpFile `p:"fileUrl" `
}

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

// BusDesignDocumentGetReq 获取一条数据请求
type BusDesignDocumentGetReq struct {
	g.Meta `path:"/get" tags:"设计管理" method:"get" summary:"获取设计管理信息"`
	commonApi.Author
	Id int64 `p:"id" v:"required#主键必须"` //通过主键获取
}

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

// BusDesignDocumentDeleteReq 删除数据请求
type BusDesignDocumentDeleteReq struct {
	g.Meta `path:"/delete" tags:"设计管理" method:"delete" summary:"删除设计管理"`
	commonApi.Author
	Ids []int64 `p:"ids" v:"required#主键必须"` //通过主键删除
}

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