Skip to content

Conversation

@iwanghc
Copy link
Collaborator

@iwanghc iwanghc commented Oct 24, 2025

User description

… include new states

关联的 issue

https://github.com/actiontech/sqle-ee/issues/2560

描述你的变更

补充缺失的导出工单枚举状态

确认项(pr提交后操作)

Tip

请在指定复审人之前,确认并完成以下事项,完成后✅


  • 我已完成自测
  • 我已记录完整日志方便进行诊断
  • 我已在关联的issue里补充了实现方案
  • 我已在关联的issue里补充了测试影响面
  • 我已确认了变更的兼容性,如果不兼容则在issue里标记 not_compatible
  • 我已确认了是否要更新文档,如果要更新则在issue里标记 need_update_doc

link #3156


Description

  • 更新 workflow 状态枚举以支持新状态

  • 修改 API 控制器返回状态枚举

  • 更新文档及 Swagger 定义中的状态列表


Diagram Walkthrough

flowchart LR
  A["修改 workflow 状态枚举"] -- "同步更新" --> B["API 控制器"]
  B -- "更新接口文档" --> C["docs.go"]
  C -- "同步更新" --> D["swagger.json"]
  D -- "同步更新" --> E["swagger.yaml"]
Loading

File Walkthrough

Relevant files
Enhancement
workflow.go
工作流状态枚举新增多个状态                                                                                       

sqle/api/controller/v1/workflow.go

  • 修改 workflow 状态枚举列表
  • 添加新状态如 wait_for_approve, wait_for_export, cancel, failed, exporting,
    finish
+1/-1     
Documentation
docs.go
更新文档状态枚举列表                                                                                             

sqle/docs/docs.go

  • 更新文档中 workflow 状态枚举
  • 添加新状态描述细节
+7/-1     
swagger.json
Swagger JSON 状态枚举更新                                                                           

sqle/docs/swagger.json

  • 更新 Swagger JSON 中状态枚举列表
  • 同步添加新状态选项
+7/-1     
swagger.yaml
Swagger YAML 状态枚举更新                                                                           

sqle/docs/swagger.yaml

  • 修改 Swagger YAML 定义状态枚举
  • 添加新状态信息,保证一致性
+6/-0     

@github-actions
Copy link

PR Reviewer Guide 🔍

🎫 Ticket compliance analysis 🔶

2560 - Partially compliant

Compliant requirements:

  • 更新 workflow 状态枚举以支持新状态
  • 修改 API 控制器返回状态枚举
  • 更新文档及 Swagger 定义中的状态列表

Non-compliant requirements:

  • 修改实例扫描任务列表instance_id返回值类型:uint64 -> string

Requires further human verification:

  • 需要验证各模块间对于枚举状态更新后的调用逻辑是否一致
⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
🧪 PR contains tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

枚举状态更新

新增的 status 字段中枚举值较多,建议确认是否与业务逻辑一致,同时检查是否应与其他系统组件的枚举状态保持统一。

Status                  string                `json:"status" enums:"wait_for_audit,wait_for_approve,wait_for_execution,wait_for_export,rejected,canceled,cancel,exec_failed,failed,executing,exporting,finished,finish"`
枚举文档补充

文档中新增的 status 枚举值需要与 API 定义及 Swagger 文件中的枚举值保持一致,请确认所有更新均符合设计要求。

    "wait_for_approve",
    "wait_for_execution",
    "wait_for_export",
    "rejected",
    "canceled",
    "cancel",
    "exec_failed",
    "failed",
    "executing",
    "exporting",
    "finished",
    "finish"
]
Swagger 枚举更新

Swagger JSON 文件中扩展了 status 枚举,建议核对各枚举状态的顺序和命名,确保与业务需求和前后端调用一致。

"wait_for_approve",
"wait_for_execution",
"wait_for_export",
"rejected",
"canceled",
"cancel",
"exec_failed",
"failed",
"executing",
"exporting",
"finished",
"finish"

@github-actions
Copy link

PR Code Suggestions ✨

No code suggestions found for the PR.

@winfredLIN winfredLIN merged commit 0510207 into main Oct 24, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants