feat: adjust openapi endpoint

2026-03-06 17:24:39 +08:00
parent a04d6ab537
commit c251fa452d
11 changed files with 343 additions and 252 deletions
@@ -58,7 +58,7 @@ func (ec *EnvController) CreateEnvVar(c *gin.Context) {
 // @Tags 环境变量
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Param name query string false "按名称模糊查询"
 // @Param page query int false "页码"
 // @Param page_size query int false "每页数量"
@@ -78,7 +78,7 @@ func (ec *EnvController) GetEnvVars(c *gin.Context) {
 // @Tags 环境变量
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Success 200 {object} utils.Response{data=[]vo.EnvVO}
 // @Router /env/all [get]
 func (ec *EnvController) GetAllEnvVars(c *gin.Context) {
@@ -93,7 +93,7 @@ func (ec *EnvController) GetAllEnvVars(c *gin.Context) {
 // @Tags 环境变量
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Param id path string true "环境变量ID"
 // @Success 200 {object} utils.Response{data=vo.EnvVO}
 // @Failure 404 {object} utils.Response
@@ -210,7 +210,7 @@ func (ec *EnvController) DeleteEnvVar(c *gin.Context) {
 // @Tags 环境变量
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Param id path string true "环境变量ID"
 // @Success 200 {object} utils.Response{data=[]vo.TaskVO}
 // @Router /env/{id}/tasks [get]
@@ -21,10 +21,10 @@ func NewExecutorController(executorService *tasks.ExecutorService) *ExecutorCont
 // ExecuteTask 运行任务
 // @Summary 运行任务
 // @Description 立即执行指定的任务
-// @Tags 任务
+// @Tags 任务执行
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Param id path string true "任务ID"
 // @Param body body object false "执行参数 (envs: 环境变量字典)"
 // @Success 200 {object} utils.Response{data=vo.ExecutionResultVO}
@@ -85,7 +85,7 @@ func (ec *ExecutorController) ExecuteCommand(c *gin.Context) {
 // @Tags 任务执行
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Param count query int false "数量 (默认 10)"
 // @Success 200 {object} utils.Response{data=[]vo.ExecutionResultVO}
 // @Router /execute/results [get]
@@ -19,10 +19,10 @@ func NewLogController() *LogController {
 // GetLogs 获取任务日志列表
 // @Summary 获取任务日志列表
 // @Description 分页获取任务日志列表，支持按任务 ID、任务名称、状态筛选
-// @Tags 日志
+// @Tags 日志管理
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Param task_id query string false "任务 ID"
 // @Param task_name query string false "任务名称"
 // @Param status query string false "状态"
@@ -102,10 +102,10 @@ func (lc *LogController) GetLogs(c *gin.Context) {
 // GetLogDetail 获取日志详情
 // @Summary 获取日志详情
 // @Description 根据 ID 获取任务日志详细内容（包含输出）
-// @Tags 日志
+// @Tags 日志管理
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Param id path string true "日志ID"
 // @Success 200 {object} utils.Response{data=vo.TaskLogVO}
 // @Failure 404 {object} utils.Response
@@ -108,10 +108,10 @@ func (tc *TaskController) CreateTask(c *gin.Context) {
 // GetTasks 获取任务列表
 // @Summary 获取任务列表
 // @Description 分页获取任务列表，支持按名称、Agent ID、标签、类型筛选
-// @Tags 任务
+// @Tags 任务管理
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Param name query string false "任务名称"
 // @Param agent_id query string false "Agent ID"
 // @Param tags query string false "标签"
@@ -140,10 +140,10 @@ func (tc *TaskController) GetTasks(c *gin.Context) {
 // GetTask 获取任务详情
 // @Summary 获取任务详情
 // @Description 根据 ID 获取任务详情
-// @Tags 任务
+// @Tags 任务管理
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Param id path string true "任务ID"
 // @Success 200 {object} utils.Response{data=vo.TaskVO}
 // @Failure 404 {object} utils.Response
@@ -167,10 +167,10 @@ func (tc *TaskController) GetTask(c *gin.Context) {
 // UpdateTask 更新任务
 // @Summary 更新任务
 // @Description 根据 ID 更新任务信息
-// @Tags 任务
+// @Tags 任务管理
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Param id path string true "任务ID"
 // @Param body body object true "任务更新信息"
 // @Success 200 {object} utils.Response{data=vo.TaskVO}
@@ -262,10 +262,10 @@ func (tc *TaskController) UpdateTask(c *gin.Context) {
 // DeleteTask 删除任务
 // @Summary 删除任务
 // @Description 根据 ID 删除任务
-// @Tags 任务
+// @Tags 任务管理
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Param id path string true "任务ID"
 // @Success 200 {object} utils.Response
 // @Failure 404 {object} utils.Response
@@ -303,10 +303,10 @@ func (tc *TaskController) DeleteTask(c *gin.Context) {
 // StopTask 停止任务
 // @Summary 停止任务
 // @Description 根据运行日志 ID 停止正在执行的任务
-// @Tags 任务
+// @Tags 任务管理
 // @Accept json
 // @Produce json
-// @Security ApiKeyAuth
+// @Security BearerAuth
 // @Param logID path string true "运行日志ID"
 // @Success 200 {object} utils.Response
 // @Failure 400 {object} utils.Response