Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

api definition for business tag #405

Merged
merged 7 commits into from
Apr 3, 2025
Merged

api definition for business tag #405

merged 7 commits into from
Apr 3, 2025

Conversation

winfredLIN
Copy link
Collaborator

@winfredLIN winfredLIN commented Apr 1, 2025 •
edited
Loading

User description

issue

https://github.com/actiontech/sqle-ee/issues/2306
actiontech/sqle#3008

变更内容：

增加项目的所属业务标签路由组API定义，包括：

  • 创建所属业务标签
  • 更新所属业务标签
  • 删除所属业务标签
  • 分页列出所属业务标签
  • 根据所属业务标签ID筛选项目列表（在删除业务标签之前，调用该接口如果存在项目具有该标签，显示这些项目并且阻止删除）

原型参考

image

Description

  • 添加业务标签API定义

  • 引入项目管理V2端点

  • 更新Swagger文档以支持新API

  • 废弃旧的业务字段

Changes walkthrough 📝

Relevant files
Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
    •

    @actiontech-bot actiontech-bot requested a review from iwanghc April 1, 2025 07:36
    @github-actions GitHub Actions
    Copy link

    github-actions bot commented Apr 1, 2025 •
    edited
    Loading

    PR Reviewer Guide 🔍

    (Review updated until commit 8354bab)

    ⏱️ Estimated effort to review: 4 🔵🔵🔵🔵⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    参数已弃用

    多个参数被标记为弃用，即将移除，请确保相关逻辑和文档已更新以使用新的替代方案。

     
    	// TODO This parameter is deprecated and will be removed soon.
	// is fixed business
	IsFixedBusiness bool `json:"is_fixed_business"`
	// TODO This parameter is deprecated and will be removed soon.
	// project business
	Business []string `json:"business"`
	// project business tag
	BusinessTag *BusinessTag `json:"business_tag"`
	// project priority
	ProjectPriority dmsCommonV1.ProjectPriority `json:"project_priority"  enums:"high,medium,low"`
}

// swagger:model
type AddProjectReq struct {
    Swagger弃用标记

    多个Swagger操作被标记为弃用，需验证这些变更是否正确反映了API的版本升级，并确保客户端兼容性。

     
    // deprecated: true
func (d *DMSController) ListProjects(c echo.Context) error {
	req := new(dmsV1.ListProjectReq)
	err := bindAndValidateReq(c, req)
	if nil != err {
		return NewErrResp(c, err, apiError.BadRequestErr)
	}

	// get current user id
	currentUserUid, err := jwt.GetUserUidStrFromContext(c)
	if err != nil {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}

	reply, err := d.DMS.ListProjects(c.Request().Context(), req, currentUserUid)
	if nil != err {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}
	return NewOkRespWithReply(c, reply)
}

// swagger:operation POST /v1/dms/projects/business_tags Project CreateBusinessTag
//
// Create a new business tag.
//
// ---
// parameters:
//   - name: business_tag
//     description: business tag to be created
//     in: body
//     required: true
//     schema:
//       "$ref": "#/definitions/CreateBusinessTagReq"
// responses:
//   '200':
//     description: GenericResp
//     schema:
//       "$ref": "#/definitions/GenericResp"
//   default:
//     description: GenericResp
//     schema:
//       "$ref": "#/definitions/GenericResp"
func (d *DMSController) CreateBusinessTag(c echo.Context) error {
	return nil
}

// swagger:operation PUT /v1/dms/projects/business_tags/{business_tag_id} Project UpdateBusinessTag
//
// Update an existing business tag.
//
// ---
// parameters:
//   - name: business_tag_id
//     description: business tag id
//     in: path
//     required: true
//     type: string
//   - name: business_tag
//     description: the business tag to be updated
//     required: true
//     in: body
//     schema:
//       "$ref": "#/definitions/UpdateBusinessTagReq"
// responses:
//   '200':
//     description: GenericResp
//     schema:
//       "$ref": "#/definitions/GenericResp"
//   default:
//     description: GenericResp
//     schema:
//       "$ref": "#/definitions/GenericResp"
func (d *DMSController) UpdateBusinessTag(c echo.Context) error {
	return nil
}

// swagger:route DELETE /v1/dms/projects/business_tags/{business_tag_id} Project DeleteBusinessTag
//
// Delete an existing business tag.
//
//	responses:
//	  200: body:GenericResp
//	  default: body:GenericResp
func (a *DMSController) DeleteBusinessTag(c echo.Context) error {
	return nil
}

// swagger:route GET /v1/dms/projects/business_tags Project ListBusinessTags
//
// List business tags.
//
//	responses:
//	  200: body:ListBusinessTagsReply
//	  default: body:GenericResp
func (d *DMSController) ListBusinessTags(c echo.Context) error{
	return nil
}

// swagger:operation POST /v1/dms/projects Project AddProject
//
// Add project.
//
// ---
// deprecated: true
// parameters:
//   - name: project
//     description: Add new Project
//     in: body
//     required: true
//     schema:
//       "$ref": "#/definitions/AddProjectReq"
// responses:
//   '200':
//     description: AddProjectReply
//     schema:
//       "$ref": "#/definitions/AddProjectReply"
//   default:
//     description: GenericResp
//     schema:
//       "$ref": "#/definitions/GenericResp"
func (d *DMSController) AddProject(c echo.Context) error {
	req := new(aV1.AddProjectReq)
	err := bindAndValidateReq(c, req)
	if nil != err {
		return NewErrResp(c, err, apiError.BadRequestErr)
	}
	// get current user id
	currentUserUid, err := jwt.GetUserUidStrFromContext(c)
	if err != nil {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}

	reply, err := d.DMS.AddProject(c.Request().Context(), currentUserUid, req)
	if nil != err {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}
	return NewOkRespWithReply(c, reply)
}

// swagger:route DELETE /v1/dms/projects/{project_uid} Project DelProject
//
// Delete a project
//
//	responses:
//	  200: body:GenericResp
//	  default: body:GenericResp
func (a *DMSController) DelProject(c echo.Context) error {
	req := &aV1.DelProjectReq{}
	err := bindAndValidateReq(c, req)
	if nil != err {
		return NewErrResp(c, err, apiError.BadRequestErr)
	}
	// get current user id
	currentUserUid, err := jwt.GetUserUidStrFromContext(c)
	if err != nil {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}
	err = a.DMS.DeleteProject(c.Request().Context(), currentUserUid, req)
	if nil != err {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}
	return NewOkResp(c)
}

// swagger:operation PUT /v1/dms/projects/{project_uid} Project UpdateProject
//
// update a project.
//
// ---
// parameters:
//   - name: project_uid
//     description: project id
//     in: path
//     required: true
//     type: string
//   - name: project
//     description: Update a project
//     required: true
//     in: body
//     schema:
//       "$ref": "#/definitions/UpdateProjectReq"
// responses:
//   '200':
//     description: GenericResp
//     schema:
//       "$ref": "#/definitions/GenericResp"
//   default:
//     description: GenericResp
//     schema:
//       "$ref": "#/definitions/GenericResp"
func (a *DMSController) UpdateProject(c echo.Context) error {
	req := &aV1.UpdateProjectReq{}
	err := bindAndValidateReq(c, req)
	if nil != err {
		return NewErrResp(c, err, apiError.BadRequestErr)
	}
	// get current user id
	currentUserUid, err := jwt.GetUserUidStrFromContext(c)
	if err != nil {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}
	err = a.DMS.UpdateProject(c.Request().Context(), currentUserUid, req)
	if nil != err {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}
	return NewOkResp(c)
}

// swagger:route PUT /v1/dms/projects/{project_uid}/archive Project ArchiveProject
//
// Archive a project.
//
//	responses:
//	  200: body:GenericResp
//	  default: body:GenericResp
func (a *DMSController) ArchiveProject(c echo.Context) error {
	req := &aV1.ArchiveProjectReq{}
	err := bindAndValidateReq(c, req)
	if nil != err {
		return NewErrResp(c, err, apiError.BadRequestErr)
	}
	// get current user id
	currentUserUid, err := jwt.GetUserUidStrFromContext(c)
	if err != nil {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}

	err = a.DMS.ArchivedProject(c.Request().Context(), currentUserUid, req)
	if nil != err {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}
	return NewOkResp(c)
}

// swagger:route PUT /v1/dms/projects/{project_uid}/unarchive Project UnarchiveProject
//
// Unarchive a project.
//
//	responses:
//	  200: body:GenericResp
//	  default: body:GenericResp
func (a *DMSController) UnarchiveProject(c echo.Context) error {
	req := &aV1.UnarchiveProjectReq{}
	err := bindAndValidateReq(c, req)
	if nil != err {
		return NewErrResp(c, err, apiError.BadRequestErr)
	}
	// get current user id
	currentUserUid, err := jwt.GetUserUidStrFromContext(c)
	if err != nil {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}

	err = a.DMS.UnarchiveProject(c.Request().Context(), currentUserUid, req)
	if nil != err {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}
	return NewOkResp(c)
}

// swagger:operation POST /v1/dms/projects/import Project ImportProjects
//
// Import projects.
//
// ---
// deprecated: true
// parameters:
//   - name: projects
//     description: import projects
//     in: body
//     required: true
//     schema:
//       "$ref": "#/definitions/ImportProjectsReq"
// responses:
//   '200':
//     description: GenericResp
//     schema:
//       "$ref": "#/definitions/GenericResp"
//   default:
//     description: GenericResp
//     schema:
//       "$ref": "#/definitions/GenericResp"
func (a *DMSController) ImportProjects(c echo.Context) error {
	req := new(aV1.ImportProjectsReq)
	err := bindAndValidateReq(c, req)
	if err != nil {
		return NewErrResp(c, err, apiError.BadRequestErr)
	}

	currentUserUid, err := jwt.GetUserUidStrFromContext(c)
	if err != nil {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}

	err = a.DMS.ImportProjects(c.Request().Context(), currentUserUid, req)
	if err != nil {
		return NewErrResp(c, err, apiError.DMSServiceErr)
	}

	return NewOkResp(c)
}

// swagger:route POST /v1/dms/projects/preview_import Project PreviewImportProjects
//
// Preview import projects.
//
//	Consumes:
//	- multipart/form-data
//
//	responses:
//	  200: PreviewImportProjectsReply
//	  default: body:GenericResp
// deprecated: true
    API路径弃用

    部分API路径被标记为弃用，需确认相关文档和客户端调用已同步更新，避免影响现有用户。

     
            deprecated: true
        operationId: ListProjects
        parameters:
            - description: the maximum count of Project to be returned
              format: uint32
              in: query
              name: page_size
              required: true
              type: integer
              x-go-name: PageSize
            - description: the offset of Projects to be returned, default is 0
              format: uint32
              in: query
              name: page_index
              type: integer
              x-go-name: PageIndex
            - description: |-
                Multiple of ["name"], default is ["name"]
                name ProjectOrderByName
              enum:
                - name
              in: query
              name: order_by
              type: string
              x-go-enum-desc: name ProjectOrderByName
              x-go-name: OrderBy
            - description: filter the Project name
              in: query
              name: filter_by_name
              type: string
              x-go-name: FilterByName
            - description: filter the Project UID
              in: query
              name: filter_by_uid
              type: string
              x-go-name: FilterByUID
            - description: filter project by project id list, using in condition
              in: query
              items:
                type: string
              name: filter_by_project_uids
              type: array
              x-go-name: FilterByProjectUids
            - description: |-
                filter project by project priority
                high ProjectPriorityHigh
                medium ProjectPriorityMedium
                low ProjectPriorityLow
                unknown ProjectPriorityUnknown
              enum:
                - high
                - medium
                - low
                - unknown
              in: query
              name: filter_by_project_priority
              type: string
              x-go-enum-desc: |-
                high ProjectPriorityHigh
                medium ProjectPriorityMedium
                low ProjectPriorityLow
                unknown ProjectPriorityUnknown
              x-go-name: FilterByProjectPriority
            - description: filter project by business tag
              in: query
              name: filter_by_business_tag
              type: string
              x-go-name: FilterByBusinessTag
            - description: filter the Project By Project description
              in: query
              name: filter_by_desc
              type: string
              x-go-name: FilterByDesc
        responses:
            "200":
                description: ListProjectReply
                schema:
                    $ref: '#/definitions/ListProjectReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: List projects.
        tags:
            - Project
    post:
        deprecated: true
        operationId: AddProject
        parameters:
            - description: Add new Project
              in: body
              name: project
              required: true
              schema:
                $ref: '#/definitions/AddProjectReq'
        responses:
            "200":
                description: AddProjectReply
                schema:
                    $ref: '#/definitions/AddProjectReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Add project.
        tags:
            - Project
/v1/dms/projects/{project_uid}:
    delete:
        description: Delete a project
        operationId: DelProject
        parameters:
            - description: project uid
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        tags:
            - Project
    put:
        operationId: UpdateProject
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: Update a project
              in: body
              name: project
              required: true
              schema:
                $ref: '#/definitions/UpdateProjectReq'
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: update a project.
        tags:
            - Project
/v1/dms/projects/{project_uid}/archive:
    put:
        operationId: ArchiveProject
        parameters:
            - description: Project uid
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Archive a project.
        tags:
            - Project
/v1/dms/projects/{project_uid}/cb_operation_logs:
    get:
        operationId: ListCBOperationLogs
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - in: query
              name: filter_operation_person_uid
              type: string
              x-go-name: FilterOperationPersonUID
            - in: query
              name: filter_operation_time_from
              type: string
              x-go-name: FilterOperationTimeFrom
            - in: query
              name: filter_operation_time_to
              type: string
              x-go-name: FilterOperationTimeTo
            - in: query
              name: filter_db_service_uid
              type: string
              x-go-name: FilterDBServiceUID
            - in: query
              name: filter_exec_result
              type: string
              x-go-name: FilterExecResult
            - description: filter fuzzy key word for operation_detail/operation_ip
              in: query
              name: fuzzy_keyword
              type: string
              x-go-name: FuzzyKeyword
            - description: the maximum count of member to be returned
              format: uint32
              in: query
              name: page_size
              required: true
              type: integer
              x-go-name: PageSize
            - description: the offset of members to be returned, default is 0
              format: uint32
              in: query
              name: page_index
              type: integer
              x-go-name: PageIndex
        responses:
            "200":
                description: ListCBOperationLogsReply
                schema:
                    $ref: '#/definitions/ListCBOperationLogsReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: List cb operation logs.
        tags:
            - CBOperationLogs
/v1/dms/projects/{project_uid}/cb_operation_logs/export:
    get:
        operationId: ExportCBOperationLogs
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - in: query
              name: filter_operation_person_uid
              type: string
              x-go-name: FilterOperationPersonUID
            - in: query
              name: filter_operation_time_from
              type: string
              x-go-name: FilterOperationTimeFrom
            - in: query
              name: filter_operation_time_to
              type: string
              x-go-name: FilterOperationTimeTo
            - in: query
              name: filter_db_service_uid
              type: string
              x-go-name: FilterDBServiceUID
            - in: query
              name: filter_exec_result
              type: string
              x-go-name: FilterExecResult
            - description: filter fuzzy key word for operation_detail/operation_ip
              in: query
              name: fuzzy_keyword
              type: string
              x-go-name: FuzzyKeyword
        responses:
            "200":
                $ref: '#/responses/ExportCBOperationLogsReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Export cb operation logs.
        tags:
            - CBOperationLogs
/v1/dms/projects/{project_uid}/cb_operation_logs/tips:
    get:
        operationId: GetCBOperationLogTips
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
        responses:
            "200":
                description: GetCBOperationLogTipsReply
                schema:
                    $ref: '#/definitions/GetCBOperationLogTipsReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Get cb operation log tips.
        tags:
            - CBOperationLogs
/v1/dms/projects/{project_uid}/data_export_tasks:
    get:
        operationId: BatchGetDataExportTask
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - in: query
              name: data_export_task_uids
              required: true
              type: string
              x-go-name: TaskUids
        responses:
            "200":
                description: BatchGetDataExportTaskReply
                schema:
                    $ref: '#/definitions/BatchGetDataExportTaskReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Batch get data_export task.
        tags:
            - DataExportTask
    post:
        operationId: AddDataExportTask
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: add data export workflow
              in: body
              name: data_export_tasks
              schema:
                $ref: '#/definitions/AddDataExportTaskReq'
        responses:
            "200":
                description: AddDataExportTaskReply
                schema:
                    $ref: '#/definitions/AddDataExportTaskReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Add data_export task.
        tags:
            - DataExportTask
/v1/dms/projects/{project_uid}/data_export_tasks/{data_export_task_uid}/data_export_task_sqls:
    get:
        operationId: ListDataExportTaskSQLs
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - in: path
              name: data_export_task_uid
              required: true
              type: string
              x-go-name: DataExportTaskUid
            - description: the maximum count of member to be returned
              format: uint32
              in: query
              name: page_size
              required: true
              type: integer
              x-go-name: PageSize
            - description: the offset of members to be returned, default is 0
              format: uint32
              in: query
              name: page_index
              type: integer
              x-go-name: PageIndex
        responses:
            "200":
                description: ListDataExportTaskSQLsReply
                schema:
                    $ref: '#/definitions/ListDataExportTaskSQLsReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: List data_export workflow.
        tags:
            - DataExportTask
/v1/dms/projects/{project_uid}/data_export_tasks/{data_export_task_uid}/data_export_task_sqls/download:
    get:
        operationId: DownloadDataExportTaskSQLs
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - in: path
              name: data_export_task_uid
              required: true
              type: string
              x-go-name: DataExportTaskUid
        responses:
            "200":
                $ref: '#/responses/DownloadDataExportTaskSQLsReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: dowload data_export sqls.
        tags:
            - DataExportTask
/v1/dms/projects/{project_uid}/data_export_tasks/{data_export_task_uid}/download:
    get:
        operationId: DownloadDataExportTask
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - in: path
              name: data_export_task_uid
              required: true
              type: string
              x-go-name: DataExportTaskUid
        responses:
            "200":
                $ref: '#/responses/DownloadDataExportTaskReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: download task file.
        tags:
            - DataExportTask
/v1/dms/projects/{project_uid}/data_export_workflows:
    get:
        operationId: ListDataExportWorkflows
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - description: the maximum count of member to be returned
              format: uint32
              in: query
              name: page_size
              required: true
              type: integer
              x-go-name: PageSize
            - description: the offset of members to be returned, default is 0
              format: uint32
              in: query
              name: page_index
              type: integer
              x-go-name: PageIndex
            - description: |-
                filter the status
                wait_for_approve DataExportWorkflowStatusWaitForApprove
                wait_for_export DataExportWorkflowStatusWaitForExport
                exporting DataExportWorkflowStatusWaitForExporting
                rejected DataExportWorkflowStatusRejected
                cancel DataExportWorkflowStatusCancel
                failed DataExportWorkflowStatusFailed
                finish DataExportWorkflowStatusFinish
              enum:
                - wait_for_approve
                - wait_for_export
                - exporting
                - rejected
                - cancel
                - failed
                - finish
              in: query
              name: filter_by_status
              type: string
              x-go-enum-desc: |-
                wait_for_approve DataExportWorkflowStatusWaitForApprove
                wait_for_export DataExportWorkflowStatusWaitForExport
                exporting DataExportWorkflowStatusWaitForExporting
                rejected DataExportWorkflowStatusRejected
                cancel DataExportWorkflowStatusCancel
                failed DataExportWorkflowStatusFailed
                finish DataExportWorkflowStatusFinish
              x-go-name: FilterByStatus
            - description: filter create user id
              in: query
              name: filter_by_create_user_uid
              type: string
              x-go-name: FilterByCreateUserUid
            - description: filter current assignee user id
              in: query
              name: filter_current_step_assignee_user_uid
              type: string
              x-go-name: FilterCurrentStepAssigneeUserUid
            - description: filter db_service id
              in: query
              name: filter_by_db_service_uid
              type: string
              x-go-name: FilterByDBServiceUid
            - description: filter create time from
              in: query
              name: filter_create_time_from
              type: string
              x-go-name: FilterCreateTimeFrom
            - description: filter create time end
              in: query
              name: filter_create_time_to
              type: string
              x-go-name: FilterCreateTimeTo
            - description: filter fuzzy key word for id/name
              in: query
              name: fuzzy_keyword
              type: string
              x-go-name: FuzzyKeyword
        responses:
            "200":
                description: ListDataExportWorkflowsReply
                schema:
                    $ref: '#/definitions/ListDataExportWorkflowsReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: List data_export workflow.
        tags:
            - DataExportWorkflows
    post:
        operationId: AddDataExportWorkflow
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: add data export workflow
              in: body
              name: data_export_workflow
              schema:
                $ref: '#/definitions/AddDataExportWorkflowReq'
        responses:
            "200":
                description: AddDataExportWorkflowReply
                schema:
                    $ref: '#/definitions/AddDataExportWorkflowReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Add data_export workflow.
        tags:
            - DataExportWorkflows
/v1/dms/projects/{project_uid}/data_export_workflows/{data_export_workflow_uid}:
    get:
        operationId: GetDataExportWorkflow
        parameters:
            - in: path
              name: data_export_workflow_uid
              required: true
              type: string
              x-go-name: DataExportWorkflowUid
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
        responses:
            "200":
                description: GetDataExportWorkflowReply
                schema:
                    $ref: '#/definitions/GetDataExportWorkflowReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Get data_export workflow.
        tags:
            - DataExportWorkflows
/v1/dms/projects/{project_uid}/data_export_workflows/{data_export_workflow_uid}/approve:
    post:
        operationId: ApproveDataExportWorkflow
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - in: path
              name: data_export_workflow_uid
              required: true
              type: string
              x-go-name: DataExportWorkflowUid
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Approve data_export workflow.
        tags:
            - DataExportWorkflows
/v1/dms/projects/{project_uid}/data_export_workflows/{data_export_workflow_uid}/export:
    post:
        operationId: ExportDataExportWorkflow
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - in: path
              name: data_export_workflow_uid
              required: true
              type: string
              x-go-name: DataExportWorkflowUid
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: exec data_export workflow.
        tags:
            - DataExportWorkflows
/v1/dms/projects/{project_uid}/data_export_workflows/{data_export_workflow_uid}/reject:
    post:
        operationId: RejectDataExportWorkflow
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - in: path
              name: data_export_workflow_uid
              required: true
              type: string
            - in: body
              name: payload
              required: true
              schema:
                $ref: '#/definitions/RejectDataExportWorkflowReq'
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Reject data_export workflow.
        tags:
            - DataExportWorkflows
/v1/dms/projects/{project_uid}/data_export_workflows/cancel:
    post:
        operationId: CancelDataExportWorkflow
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - in: body
              name: payload
              required: true
              schema:
                $ref: '#/definitions/CancelDataExportWorkflowReq'
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Cancel data export workflows.
        tags:
            - DataExportWorkflows
/v1/dms/projects/{project_uid}/db_services:
    get:
        operationId: ListDBServices
        parameters:
            - description: the maximum count of db service to be returned
              format: uint32
              in: query
              name: page_size
              required: true
              type: integer
              x-go-name: PageSize
            - description: the offset of users to be returned, default is 0
              format: uint32
              in: query
              name: page_index
              type: integer
              x-go-name: PageIndex
            - description: |-
                Multiple of ["name"], default is ["name"]
                name DBServiceOrderByName
              enum:
                - name
              in: query
              name: order_by
              type: string
              x-go-enum-desc: name DBServiceOrderByName
              x-go-name: OrderBy
            - description: the db service business name
              in: query
              name: filter_by_business
              type: string
              x-go-name: FilterByBusiness
            - description: the db service connection
              enum:
                - connect_success
                - connect_failed
              in: query
              name: filter_last_connection_test_status
              type: string
              x-go-name: FilterLastConnectionTestStatus
            - description: the db service host
              in: query
              name: filter_by_host
              type: string
              x-go-name: FilterByHost
            - description: the db service uid
              in: query
              name: filter_by_uid
              type: string
              x-go-name: FilterByUID
            - description: the db service name
              in: query
              name: filter_by_name
              type: string
              x-go-name: FilterByName
            - description: the db service port
              in: query
              name: filter_by_port
              type: string
              x-go-name: FilterByPort
            - description: the db service db type
              in: query
              name: filter_by_db_type
              type: string
              x-go-name: FilterByDBType
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - description: filter db services by db service id list using in condition
              in: query
              items:
                type: string
              name: filter_by_db_service_ids
              type: array
              x-go-name: FilterByDBServiceIds
            - description: the db service fuzzy keyword,include host/port
              in: query
              name: fuzzy_keyword
              type: string
              x-go-name: FuzzyKeyword
            - description: is masking
              in: query
              name: is_enable_masking
              type: boolean
              x-go-name: IsEnableMasking
        responses:
            "200":
                description: ListDBServiceReply
                schema:
                    $ref: '#/definitions/ListDBServiceReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: List db service.
        tags:
            - DBService
    post:
        operationId: AddDBService
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: Add new db service
              in: body
              name: db_service
              required: true
              schema:
                $ref: '#/definitions/AddDBServiceReq'
        responses:
            "200":
                description: AddDBServiceReply
                schema:
                    $ref: '#/definitions/AddDBServiceReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Add DB Service.
        tags:
            - DBService
/v1/dms/projects/{project_uid}/db_services/{db_service_uid}:
    delete:
        operationId: DelDBService
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - description: db service uid
              in: path
              name: db_service_uid
              required: true
              type: string
              x-go-name: DBServiceUid
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Delete a DB Service.
        tags:
            - DBService
    put:
        operationId: UpdateDBService
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: db_service_uid id
              in: path
              name: db_service_uid
              required: true
              type: string
            - description: Update a DB service
              in: body
              name: db_service
              schema:
                $ref: '#/definitions/UpdateDBServiceReq'
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: update a DB Service.
        tags:
            - DBService
/v1/dms/projects/{project_uid}/db_services/{db_service_uid}/connection:
    post:
        operationId: CheckDBServiceIsConnectableById
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: db service uid
              in: path
              name: db_service_uid
              required: true
              type: string
        responses:
            "200":
                description: CheckDBServiceIsConnectableReply
                schema:
                    $ref: '#/definitions/CheckDBServiceIsConnectableReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: check if the db_service is connectable.
        tags:
            - DBService
/v1/dms/projects/{project_uid}/db_services/connection:
    post:
        operationId: CheckDBServiceIsConnectable
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: check db_service is connectable
              in: body
              name: db_service
              schema:
                $ref: '#/definitions/CheckDBServiceIsConnectableReq'
        responses:
            "200":
                description: CheckDBServiceIsConnectableReply
                schema:
                    $ref: '#/definitions/CheckDBServiceIsConnectableReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: check if the db_service is connectable.
        tags:
            - DBService
/v1/dms/projects/{project_uid}/db_services/connections:
    post:
        operationId: CheckProjectDBServicesConnections
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: check db_services is connectable
              in: body
              name: db_services
              schema:
                $ref: '#/definitions/CheckDBServicesIsConnectableReq'
        responses:
            "200":
                description: CheckDBServicesIsConnectableReply
                schema:
                    $ref: '#/definitions/CheckDBServicesIsConnectableReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: check if the project db_services is connectable.
        tags:
            - DBService
/v1/dms/projects/{project_uid}/db_services/import:
    post:
        operationId: ImportDBServicesOfOneProject
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: new db services
              in: body
              name: db_services
              required: true
              schema:
                $ref: '#/definitions/ImportDBServicesOfOneProjectReq'
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Import DBServices.
        tags:
            - DBService
/v1/dms/projects/{project_uid}/db_services/import_check:
    post:
        consumes:
            - multipart/form-data
        operationId: ImportDBServicesOfOneProjectCheck
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - description: DBServices file.
              in: formData
              name: db_services_file
              type: file
              x-go-name: DBServicesFile
        produces:
            - application/json
            - text/csv
        responses:
            "200":
                $ref: '#/responses/ImportDBServicesCheckCsvReply'
            default:
                description: ImportDBServicesCheckReply
                schema:
                    $ref: '#/definitions/ImportDBServicesCheckReply'
        summary: Import DBServices.
        tags:
            - DBService
/v1/dms/projects/{project_uid}/db_services/tips:
    get:
        operationId: ListDBServiceTips
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - in: query
              name: filter_db_type
              type: string
              x-go-name: FilterDBType
            - enum:
                - save_audit_plan
                - create_workflow
                - create_export_task
              in: query
              name: functional_module
              type: string
              x-go-name: FunctionalModule
        responses:
            "200":
                description: ListDBServiceTipsReply
                schema:
                    $ref: '#/definitions/ListDBServiceTipsReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: List db service tip.
        tags:
            - DBService
/v1/dms/projects/{project_uid}/member_groups:
    get:
        operationId: ListMemberGroups
        parameters:
            - description: the maximum count of member to be returned
              format: uint32
              in: query
              name: page_size
              required: true
              type: integer
              x-go-name: PageSize
            - description: the offset of members to be returned, default is 0
              format: uint32
              in: query
              name: page_index
              type: integer
              x-go-name: PageIndex
            - description: |-
                Multiple of ["name"], default is ["name"]
                name MemberGroupOrderByName
              enum:
                - name
              in: query
              name: order_by
              type: string
              x-go-enum-desc: name MemberGroupOrderByName
              x-go-name: OrderBy
            - description: filter the user group name
              in: query
              name: filter_by_name
              type: string
              x-go-name: FilterByName
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
        responses:
            "200":
                description: ListMemberGroupsReply
                schema:
                    $ref: '#/definitions/ListMemberGroupsReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: List member group, for front page.
        tags:
            - MemberGroup
    post:
        operationId: AddMemberGroup
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: Add new member group
              in: body
              name: member_group
              required: true
              schema:
                $ref: '#/definitions/AddMemberGroupReq'
        responses:
            "200":
                description: AddMemberGroupReply
                schema:
                    $ref: '#/definitions/AddMemberGroupReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Add member group.
        tags:
            - MemberGroup
/v1/dms/projects/{project_uid}/member_groups/{member_group_uid}:
    delete:
        operationId: DeleteMemberGroup
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - description: member group id
              in: path
              name: member_group_uid
              required: true
              type: string
              x-go-name: MemberGroupUid
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: delete member group, for front page.
        tags:
            - MemberGroup
    get:
        operationId: GetMemberGroup
        parameters:
            - description: Member group id
              in: path
              name: member_group_uid
              required: true
              type: string
              x-go-name: MemberGroupUid
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
        responses:
            "200":
                description: GetMemberGroupReply
                schema:
                    $ref: '#/definitions/GetMemberGroupReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Get member group, for front page.
        tags:
            - MemberGroup
    put:
        operationId: UpdateMemberGroup
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: Member group id
              in: path
              name: member_group_uid
              required: true
              type: string
            - description: Update a member group
              in: body
              name: member_group
              required: true
              schema:
                $ref: '#/definitions/UpdateMemberGroupReq'
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: update member group, for front page.
        tags:
            - MemberGroup
/v1/dms/projects/{project_uid}/members:
    get:
        operationId: ListMembers
        parameters:
            - description: the maximum count of member to be returned
              format: uint32
              in: query
              name: page_size
              required: true
              type: integer
              x-go-name: PageSize
            - description: the offset of members to be returned, default is 0
              format: uint32
              in: query
              name: page_index
              type: integer
              x-go-name: PageIndex
            - description: |-
                Multiple of ["name"], default is ["name"]
                user_uid MemberOrderByUserUid
              enum:
                - user_uid
              in: query
              name: order_by
              type: string
              x-go-enum-desc: user_uid MemberOrderByUserUid
              x-go-name: OrderBy
            - description: filter the member user uid
              in: query
              name: filter_by_user_uid
              type: string
              x-go-name: FilterByUserUid
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
        responses:
            "200":
                description: ListMemberReply
                schema:
                    $ref: '#/definitions/ListMemberReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: List member, for front page.
        tags:
            - Member
    post:
        operationId: AddMember
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: Add new member
              in: body
              name: member
              required: true
              schema:
                $ref: '#/definitions/AddMemberReq'
        responses:
            "200":
                description: AddMemberReply
                schema:
                    $ref: '#/definitions/AddMemberReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Add member.
        tags:
            - Member
/v1/dms/projects/{project_uid}/members/{member_uid}:
    delete:
        operationId: DelMember
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
            - description: member uid
              in: path
              name: member_uid
              required: true
              type: string
              x-go-name: MemberUid
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Delete a member.
        tags:
            - Member
    put:
        operationId: UpdateMember
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
            - description: Member uid
              in: path
              name: member_uid
              required: true
              type: string
            - description: Update a member
              in: body
              name: member
              required: true
              schema:
                $ref: '#/definitions/UpdateMemberReq'
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Update a member.
        tags:
            - Member
/v1/dms/projects/{project_uid}/members/internal:
    get:
        operationId: ListMembersForInternal
        parameters:
            - description: the maximum count of member to be returned
              format: uint32
              in: query
              name: page_size
              required: true
              type: integer
              x-go-name: PageSize
            - description: the offset of members to be returned, default is 0
              format: uint32
              in: query
              name: page_index
              type: integer
              x-go-name: PageIndex
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
        responses:
            "200":
                description: ListMembersForInternalReply
                schema:
                    $ref: '#/definitions/ListMembersForInternalReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: List members, for internal backend service.
        tags:
            - Member
/v1/dms/projects/{project_uid}/members/tips:
    get:
        operationId: ListMemberTips
        parameters:
            - description: project id
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
        responses:
            "200":
                description: ListMemberTipsReply
                schema:
                    $ref: '#/definitions/ListMemberTipsReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: List member tips.
        tags:
            - Member
/v1/dms/projects/{project_uid}/unarchive:
    put:
        operationId: UnarchiveProject
        parameters:
            - description: Project uid
              in: path
              name: project_uid
              required: true
              type: string
              x-go-name: ProjectUid
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Unarchive a project.
        tags:
            - Project
/v1/dms/projects/business_tags:
    get:
        operationId: ListBusinessTags
        parameters:
            - format: uint32
              in: query
              name: page_index
              type: integer
              x-go-name: PageIndex
            - format: uint32
              in: query
              name: page_size
              required: true
              type: integer
              x-go-name: PageSize
        responses:
            "200":
                description: ListBusinessTagsReply
                schema:
                    $ref: '#/definitions/ListBusinessTagsReply'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: List business tags.
        tags:
            - Project
    post:
        operationId: CreateBusinessTag
        parameters:
            - description: business tag to be created
              in: body
              name: business_tag
              required: true
              schema:
                $ref: '#/definitions/CreateBusinessTagReq'
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Create a new business tag.
        tags:
            - Project
/v1/dms/projects/business_tags/{business_tag_id}:
    delete:
        operationId: DeleteBusinessTag
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Delete an existing business tag.
        tags:
            - Project
    put:
        operationId: UpdateBusinessTag
        parameters:
            - description: business tag id
              in: path
              name: business_tag_id
              required: true
              type: string
            - description: the business tag to be updated
              in: body
              name: business_tag
              required: true
              schema:
                $ref: '#/definitions/UpdateBusinessTagReq'
        responses:
            "200":
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
            default:
                description: GenericResp
                schema:
                    $ref: '#/definitions/GenericResp'
        summary: Update an existing business tag.
        tags:
            - Project
/v1/dms/projects/db_services_connection:

    @github-actions GitHub Actions
    Copy link

    github-actions bot commented Apr 1, 2025 •
    edited
    Loading

    PR Code Suggestions ✨

    Latest suggestions up to 8354bab

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    处理HTTP响应

    CreateBusinessTag 函数返回 nil，这可能导致客户端收不到响应。应返回适当的响应对象。

    internal/apiserver/service/dms_controller.go [1734-1736]

     func (d *DMSController) CreateBusinessTag(c echo.Context) error {
-	return nil
+	// 实现创建业务标签的逻辑
+	return NewOkResp(c, createdTag)
 }
    Suggestion importance[1-10]: 8

    __

    Why: The CreateBusinessTag function currently returns nil, which may prevent the client from receiving a proper response. Returning an appropriate response object ensures that the client is informed of the operation's outcome.

    		Medium
    处理函数返回值

    AddProjectV2 函数调用 AddProject 后未处理其返回值，可能导致错误未被正确处理或响应未返回。应处理 AddProject
    的返回值并返回适当的响应。

    internal/apiserver/service/dms_controller_v2.go [26-28]

     func (d *DMSController) AddProjectV2(c echo.Context) error {
-	return d.AddProject(c)
+	err := d.AddProject(c)
+	if err != nil {
+		return err
+	}
+	return NewOkResp(c, nil)
 }
    Suggestion importance[1-10]: 8

    __

    Why: The AddProjectV2 function calls AddProject without handling its return value, which can lead to unhandled errors or missing responses. Properly managing the return value ensures that errors are addressed and clients receive necessary feedback.

    		Medium

    Previous suggestions

    Suggestions up to commit 7894731
    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    实现创建业务标签逻辑

    需要在 CreateBusinessTag 函数中实现实际的业务逻辑，而不仅仅返回 nil，以正确处理创建业务标签的请求，防止未处理的响应或潜在的空指针异常。

    internal/apiserver/service/dms_controller.go [1734-1736]

     func (d *DMSController) CreateBusinessTag(c echo.Context) error {
-	return nil
+	var req CreateBusinessTagReq
+	if err := c.Bind(&req); err != nil {
+		return NewErrResp(c, err, apiError.InvalidRequest)
+	}
+	// 实现创建业务标签的逻辑
+	return NewOkResp(c, GenericResp{Message: "业务标签创建成功"})
 }
    Suggestion importance[1-10]: 9

    __

    Why: The CreateBusinessTag function currently returns nil without implementing the business logic. Implementing the logic is crucial to handle the creation request properly, ensuring the PR's functionality is complete.

    		High
    实现更新业务标签逻辑

    需要在 UpdateBusinessTag 函数中实现更新业务标签的逻辑，而不仅仅返回 nil，以确保正确处理更新请求，防止未处理的响应或潜在的空指针异常。

    internal/apiserver/service/dms_controller.go [1744-1746]

     func (d *DMSController) UpdateBusinessTag(c echo.Context) error {
-	return nil
+	var req UpdateBusinessTagReq
+	if err := c.Bind(&req); err != nil {
+		return NewErrResp(c, err, apiError.InvalidRequest)
+	}
+	// 实现更新业务标签的逻辑
+	return NewOkResp(c, GenericResp{Message: "业务标签更新成功"})
 }
    Suggestion importance[1-10]: 9

    __

    Why: The UpdateBusinessTag function currently returns nil without implementing the update logic. Adding the necessary logic ensures that update requests are handled correctly, enhancing the PR's functionality.

    		High
    实现删除业务标签逻辑

    需要在 DeleteBusinessTag 函数中实现删除业务标签的逻辑，而不仅仅返回 nil，以确保正确处理删除请求，避免未处理的响应或潜在的资源泄漏。

    internal/apiserver/service/dms_controller.go [1775-1777]

     func (a *DMSController) DeleteBusinessTag(c echo.Context) error {
-	return nil
+	businessTagID := c.Param("business_tag_id")
+	// 实现删除业务标签的逻辑
+	return NewOkResp(c, GenericResp{Message: "业务标签删除成功"})
 }
    Suggestion importance[1-10]: 9

    __

    Why: The DeleteBusinessTag function currently returns nil without implementing the delete logic. Implementing this logic is essential to properly handle deletion requests and maintain resource integrity.

    		High
    实现列出业务标签逻辑

    需要在 ListBusinessTags 函数中实现列出业务标签的逻辑，而不仅仅返回 nil，以确保正确处理列表请求，防止未处理的响应或潜在的数据泄漏。

    internal/apiserver/service/dms_controller.go [1785-1787]

    -func (d *DMSController) ListBusinessTags(c echo.Context) error{
-	return nil
+func (d *DMSController) ListBusinessTags(c echo.Context) error {
+	pageIndex, _ := strconv.Atoi(c.QueryParam("page_index"))
+	pageSize, _ := strconv.Atoi(c.QueryParam("page_size"))
+	// 实现列出业务标签的逻辑
+	reply := ListBusinessTagsReply{
+		Data:  []*BusinessTag{}, // 填充数据
+		Total: 0,                // 总数
+	}
+	return NewOkRespWithReply(c, reply)
 }
    Suggestion importance[1-10]: 9

    __

    Why: The ListBusinessTags function currently returns nil without implementing the listing logic. Adding the necessary implementation ensures that business tags can be listed correctly, thereby completing the intended functionality of the PR.

    		High
    Suggestions up to commit dd877cf
    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    实现控制器业务逻辑

    请为 CreateBusinessTag 方法实现具体的业务逻辑，确保处理请求并返回适当的响应，而不是简单返回
    nil，以避免导致客户端接收到空响应或服务器出现未处理的错误。

    internal/apiserver/service/dms_controller.go [1734-1736]

     func (d *DMSController) CreateBusinessTag(c echo.Context) error {
-	return nil
+	// 实现业务逻辑，例如解析请求、验证数据、存储到数据库等
+	// 返回适当的响应
+	return NewOkRespWithReply(c, reply)
 }
    Suggestion importance[1-10]: 10

    __

    Why: The CreateBusinessTag method currently returns nil, which can lead to empty responses or unhandled errors. Implementing the business logic ensures proper handling of requests and appropriate responses.

    		High
    增强控制器错误处理

    请为 UpdateBusinessTag 方法添加必要的错误处理和数据验证，确保在更新业务标签时不会因为未处理的异常或无效数据导致程序崩溃或数据不一致。

    internal/apiserver/service/dms_controller.go [1744-1746]

     func (d *DMSController) UpdateBusinessTag(c echo.Context) error {
-	return nil
+	// 添加错误处理和数据验证逻辑
+	// 执行更新操作
+	return NewOkResp(c)
 }
    Suggestion importance[1-10]: 7

    __

    Why: Adding error handling and data validation to the UpdateBusinessTag method improves its robustness and prevents potential crashes or data inconsistencies.

    		Medium
    Suggestions up to commit bf9fcc7
    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    实现创建业务标签逻辑

    请为 CreateBusinessTag 函数实现具体的业务逻辑，目前函数仅返回 nil，无法处理创建业务标签的请求。

    internal/apiserver/service/dms_controller.go [1734-1736]

     func (d *DMSController) CreateBusinessTag(c echo.Context) error {
-	return nil
+	var req CreateBusinessTagReq
+	if err := c.Bind(&req); err != nil {
+		return NewErrResp(c, err, apiError.InvalidInput)
+	}
+	// 实现创建业务标签的逻辑
+	businessTagID, err := d.service.CreateBusinessTag(req.BusinessTag)
+	if err != nil {
+		return NewErrResp(c, err, apiError.DMSServiceErr)
+	}
+	reply := CreateBusinessTagReply{
+		Data: struct {
+			BusinessTagID uint `json:"business_tag_id"`
+		}{
+			BusinessTagID: businessTagID,
+		},
+		GenericResp: base.GenericResp{
+			Code:    200,
+			Message: "成功创建业务标签",
+		},
+	}
+	return NewOkRespWithReply(c, reply)
 }
    Suggestion importance[1-10]: 9

    __

    Why: 当前 CreateBusinessTag 函数仅返回 nil，未实现实际的业务逻辑，这会导致无法处理创建业务标签的请求，影响功能的正确性和完整性。

    		High
    实现更新业务标签逻辑

    请为 UpdateBusinessTag 函数实现具体的业务逻辑，目前函数仅返回 nil，无法处理更新业务标签的请求。

    internal/apiserver/service/dms_controller.go [1764-1766]

     func (d *DMSController) UpdateBusinessTag(c echo.Context) error {
-	return nil
+	var req UpdateBusinessTagReq
+	if err := c.Bind(&req); err != nil {
+		return NewErrResp(c, err, apiError.InvalidInput)
+	}
+	// 实现更新业务标签的逻辑
+	err := d.service.UpdateBusinessTag(req.BusinessTagID, req.BusinessTag)
+	if err != nil {
+		return NewErrResp(c, err, apiError.DMSServiceErr)
+	}
+	resp := base.GenericResp{
+		Code:    200,
+		Message: "成功更新业务标签",
+	}
+	return NewOkResp(c, resp)
 }
    Suggestion importance[1-10]: 9

    __

    Why: 当前 UpdateBusinessTag 函数仅返回 nil，未实现实际的业务逻辑，这会导致无法处理更新业务标签的请求，影响功能的正确性和完整性。

    		High
    实现列出业务标签逻辑

    请为 ListBusinessTags 函数实现具体的业务逻辑，目前函数仅返回 nil，无法处理列出业务标签的请求。

    internal/apiserver/service/dms_controller.go [1786-1788]

     func (d *DMSController) ListBusinessTags(c echo.Context) error{
-	return nil
+	var req ListBusinessTagReq
+	if err := c.Bind(&req); err != nil {
+		return NewErrResp(c, err, apiError.InvalidInput)
+	}
+	// 实现列出业务标签的逻辑
+	tags, total, err := d.service.ListBusinessTags(req.PageIndex, req.PageSize)
+	if err != nil {
+		return NewErrResp(c, err, apiError.DMSServiceErr)
+	}
+	reply := ListBusinessTagsReply{
+		Data:  tags,
+		Total: total,
+		GenericResp: base.GenericResp{
+			Code:    200,
+			Message: "成功获取业务标签列表",
+		},
+	}
+	return NewOkRespWithReply(c, reply)
 }
    Suggestion importance[1-10]: 9

    __

    Why: 当前 ListBusinessTags 函数仅返回 nil，未实现实际的业务逻辑，这会导致无法处理列出业务标签的请求，影响功能的正确性和完整性。

    		High
    Suggestions up to commit e44ef24
    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    正确返回HTTP响应

    确保在处理函数中正确返回响应，例如使用 c.JSON 返回适当的HTTP状态码和数据。

    internal/apiserver/service/dms_controller.go [1734-1736]

     func (d *DMSController) CreateBusinessTag(c echo.Context) error {
-	return nil
+	// 实现创建业务标签的逻辑
+	return c.JSON(http.StatusOK, CreateBusinessTagReply{...})
 }
    Suggestion importance[1-10]: 9

    __

    Why: The handler function is currently returning nil, which means it does not provide any meaningful HTTP response. Properly returning an HTTP response using c.JSON with appropriate status codes and data is essential for the functionality and reliability of the API endpoint.

    		High
    实现更新逻辑并返回响应

    在更新业务标签的处理函数中实现具体的更新逻辑，并确保返回相应的响应。

    internal/apiserver/service/dms_controller.go [1764-1766]

     func (d *DMSController) UpdateBusinessTag(c echo.Context) error {
-	return nil
+	// 实现更新业务标签的逻辑
+	return c.JSON(http.StatusOK, base.GenericResp{Code: 200, Message: "Update successful"})
 }
    Suggestion importance[1-10]: 9

    __

    Why: The UpdateBusinessTag handler function is incomplete as it only returns nil. Implementing the actual update logic and returning a proper HTTP response ensures that the API can successfully handle update requests and provide meaningful feedback to the client.

    		High

    @github-actions GitHub Actions
    Copy link

    github-actions bot commented Apr 1, 2025

    Persistent review updated to latest commit 53b2c45

    @github-actions GitHub Actions
    Copy link

    github-actions bot commented Apr 1, 2025

    Persistent review updated to latest commit 2c898bb

    @github-actions GitHub Actions
    Copy link

    github-actions bot commented Apr 1, 2025

    Persistent review updated to latest commit e44ef24

    @github-actions GitHub Actions
    Copy link

    github-actions bot commented Apr 1, 2025

    Persistent review updated to latest commit bf9fcc7

    @github-actions GitHub Actions
    Copy link

    github-actions bot commented Apr 1, 2025

    Persistent review updated to latest commit dd877cf

    @github-actions GitHub Actions
    Copy link

    github-actions bot commented Apr 2, 2025

    Persistent review updated to latest commit 7894731

    @winfredLIN
    feat(api): add business tag related models and requests
    d27a13b 
    - Create BusinessTag struct with ID and Name fields
- Add CreateBusinessTagReq, UpdateBusinessTagReq, and ListBusinessTagReq for business tag operations
- Define ListBusinessTagsReply to respond to list requests
    @winfredLIN
    feat(project): add business tag and deprecate business
    0e4e899 
    - Add BusinessTag field to Project struct
- Mark Business field as deprecated
- Update related structs and interfaces to support BusinessTag
    @winfredLIN
    feat(dms): add business tag management APIs
    c0b825e 
    - CreateBusinessTag: Create a new business tag
- UpdateBusinessTag: Update an existing business tag
- DeleteBusinessTag: Delete an existing business tag
- ListBusinessTags: List all business tags

Also, marked AddProject, ImportProjects, and PreviewImportProjects as deprecated.
    @winfredLIN
    feat(internal/apiserver): add v2 endpoints for project management
    59d584b 
    - Add new project management endpoints under /v2/dms/projects
- Implement AddProjectV2, ImportProjectsV2, and PreviewImportProjectsV2 methods
- Update Swagger documentation for new v2 endpoints
    @winfredLIN
    feat(project): add business tag filter and deprecate business field
    5633150 
    - Add FilterByBusinessTag query parameter to ListProjectReq
- Add BusinessTag struct and include in ListProject response
- Mark 'business' field in ListProject as deprecated
    @winfredLIN
    feat(project): add business tag functionality and update project endp…
    f7d325b 
    …oints

- Add new business tag related endpoints:
  - List business tags
  - Create business tag
  - Update business tag
  - Delete business tag
- Add filter_by_business_tag parameter to project list endpoint
- Deprecate existing project endpoints and introduce new ones with "V2" suffix
- Update project models to include business tag information
    @github-actions GitHub Actions
    Copy link

    github-actions bot commented Apr 2, 2025

    Persistent review updated to latest commit f7d325b

    @github-actions GitHub Actions
    Copy link

    github-actions bot commented Apr 2, 2025

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    @winfredLIN
    feat(api): add new endpoint for listing projects in v2 and deprecate …
    8354bab 
    …v1 endpoint

- Add new GET endpoint at /v2/dms/projects for listing projects
- Deprecate existing GET endpoint at /v1/dms/projects
- Update API controller to handle new endpoint
- Modify API definitions in swagger.json and swagger.yaml
    @github-actions GitHub Actions
    Copy link

    github-actions bot commented Apr 2, 2025

    Persistent review updated to latest commit 8354bab

    @iwanghc iwanghc merged commit a099fa2 into main Apr 3, 2025
    1 check passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @iwanghc iwanghc iwanghc approved these changes

    Assignees
    No one assigned
    Labels
    None yet
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @winfredLIN @iwanghc