Files
zmkgC/api/v1/system/manage_workspace.go
2025-07-07 20:11:59 +08:00

93 lines
3.6 KiB
Go
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// ==========================================================================
// GFast自动生成api操作代码。
// 生成日期2023-11-14 10:53:20
// 生成路径: api/v1/system/manage_workspace.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"
)
// ManageWorkspaceSearchReq 分页请求参数
type ManageWorkspaceSearchReq struct {
g.Meta `path:"/list" tags:"工作空间" method:"get" summary:"工作空间列表"`
ProjectId string `p:"projectId" dc:"项目id"`
BindCode string `p:"bindCode" dc:"绑定码"`
WorkspaceName string `p:"workspaceName" dc:"工作空间名称"`
commonApi.PageReq
commonApi.Author
}
// ManageWorkspaceSearchRes 列表返回结果
type ManageWorkspaceSearchRes struct {
g.Meta `mime:"application/json"`
commonApi.ListRes
List []*model.ManageWorkspaceListRes `json:"list"`
}
// ManageWorkspaceAddReq 添加操作请求参数
type ManageWorkspaceAddReq struct {
g.Meta `path:"/add" tags:"工作空间" method:"post" summary:"工作空间添加"`
commonApi.Author
WorkspaceName string `p:"workspaceName" dc:"工作区名称" v:"required#工作区的名称不能为空"`
WorkspaceDesc string `p:"workspaceDesc" dc:"工作区描述" v:"required#工作区描述不能为空"`
PlatformName string `p:"platformName" dc:"工作区平台名称" v:"required#工作区的平台名称不能为空"`
BindCode string `p:"bindCode" dc:"工作区绑定码" v:"required#工作区绑定码不能为空"`
ProjectId int64 `p:"projectId" dc:"项目ID" v:"required#项目ID必须"`
}
// ManageWorkspaceAddRes 添加操作返回结果
type ManageWorkspaceAddRes struct {
commonApi.EmptyRes
}
// ManageWorkspaceEditReq 修改操作请求参数
type ManageWorkspaceEditReq struct {
g.Meta `path:"/edit" tags:"工作空间" method:"put" summary:"工作空间修改"`
commonApi.Author
Id uint64 `p:"id" v:"required#主键ID不能为空"`
//WorkspaceId string `p:"workspaceId" `
WorkspaceName string `p:"workspaceName" dc:"工作区名称" v:"required#工作区的名称不能为空"`
WorkspaceDesc string `p:"workspaceDesc" dc:"工作区描述" v:"required#工作区描述不能为空"`
PlatformName string `p:"platformName" dc:"工作区平台名称" v:"required#工作区的平台名称不能为空"`
//BindCode string `p:"bindCode" dc:"工作区绑定码" v:"required#工作区绑定码不能为空"`
//ProjectId int64 `p:"projectId" dc:"项目ID" v:"required#项目ID必须"`
}
// ManageWorkspaceEditRes 修改操作返回结果
type ManageWorkspaceEditRes struct {
commonApi.EmptyRes
}
// ManageWorkspaceGetReq 获取一条数据请求
type ManageWorkspaceGetReq struct {
g.Meta `path:"/get" tags:"工作空间" method:"get" summary:"获取工作空间信息"`
commonApi.Author
Id uint64 `p:"id" v:"required#主键必须"` //通过主键获取
}
// ManageWorkspaceGetRes 获取一条数据结果
type ManageWorkspaceGetRes struct {
g.Meta `mime:"application/json"`
*model.ManageWorkspaceInfoRes
}
// ManageWorkspaceDeleteReq 删除数据请求
type ManageWorkspaceDeleteReq struct {
g.Meta `path:"/delete" tags:"工作空间" method:"delete" summary:"删除工作空间"`
commonApi.Author
Ids []uint64 `p:"ids" v:"required#主键必须"` //通过主键删除
}
// ManageWorkspaceDeleteRes 删除数据返回
type ManageWorkspaceDeleteRes struct {
commonApi.EmptyRes
}