update swagger

liuxiaolong

2019-11-12 4d0e5b1e9f59ebba7f875c9a39a6ab84c9dde4b6

update swagger

 controllers/area.go

@@ -59,9 +59,10 @@
    util.ResponseFormat(c, code.Success, arr)
}

// @Security ApiKeyAuth
// @Accept x-www-form-urlencoded
// @Summary 刷新Gb28181平台树
// @Description 刷新Gb28181平台树
// @Security ApiKeyAuth
// @Produce json
// @Tags menu
// @Param id formData string false "国标平台id"
@@ -99,6 +100,7 @@
// @Security ApiKeyAuth
// @Summary 添加menu的区域
// @Description 添加目录上区域
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags menu
// @Param name formData string true "区域名字"
@@ -127,7 +129,7 @@
// @Security ApiKeyAuth
// @Summary 修改名字
// @Description 修改区域名字
// @Accept  json
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags menu
// @Param id formData string true "区域id"
@@ -168,6 +170,7 @@
// @Security ApiKeyAuth
// @Summary 删除一个区域
// @Description 点击删除按钮时删除一个区域
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags menu
// @Param id formData string true "当前id"

 controllers/camera.go

@@ -294,6 +294,7 @@
// @Security ApiKeyAuth
// @Summary 切换摄像机运行实时或轮询的开关
// @Description 切换摄像机运行实时或轮询的开关
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags camera
// @Param cameraId formData string true "摄像机id"

 controllers/cameraPTZ.go

@@ -23,6 +23,7 @@
// @Summary 云台
// @Description 摄像机云台控制
// @Security ApiKeyAuth
// @Accept json
// @Produce json
// @Tags camera
// @Param ptzBody body controllers.PTZInstruct true "控制类型：up,down,left,right,zoomin,zoomout,stop"

 controllers/cameraPolygon.go

@@ -58,7 +58,6 @@
// @Security ApiKeyAuth
// @Summary 删除摄像机区域
// @Description 删除摄像机区域
// @Accept json
// @Produce json
// @Tags 摄像机多边形
// @Param  id query string  true "id"
@@ -84,7 +83,6 @@
// @Security ApiKeyAuth
// @Summary 查找摄像机区域
// @Description 查找摄像机区域
// @Accept json
// @Produce json
// @Tags 摄像机多边形
// @Param  cameraId query string  true "cameraId"

 controllers/cameraTask.go

@@ -99,6 +99,7 @@
// @Security ApiKeyAuth
// @Summary 摄像机添加一个任务
// @Description 摄像机添加一个任务
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags CameraTask
// @Param cameraId formData string true "摄像机id"
@@ -245,6 +246,7 @@
// @Security ApiKeyAuth
// @Summary 保存规则组报警等级
// @Description 保存规则组报警等级
// @Accept json
// @Produce json
// @Tags CameraTask
// @Param GroupLevel body controllers.GroupAlarmLevelVo true "alarmLevel"
@@ -276,6 +278,7 @@
// @Security ApiKeyAuth
// @Summary 更新任务状态
// @Description 更新任务状态
// @Accept json
// @Produce json
// @Tags CameraTask
// @Param CameraTaskStatus body controllers.CameraTaskStatusVo true "参数结构体"

 controllers/cameraTaskArgs.go

@@ -71,6 +71,7 @@
// @Security ApiKeyAuth
// @Summary 根据分组id切换布防或撤防
// @Description 根据分组id切换布防或撤防
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags CameraTaskArgs
// @Param groupId formData string true "任务算法参数分组id"

 controllers/cameraTimerule.go

@@ -66,7 +66,6 @@
// @Security ApiKeyAuth
// @Summary 删除时间规则
// @Description 删除时间规则
// @Accept json
// @Produce json
// @Tags CameraTimerule
// @Param  id query string  true "id"

 controllers/cluster.go

@@ -219,6 +219,7 @@
// @Security ApiKeyAuth
// @Summary 保存集群名称
// @Description 保存集群名称
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags cluster
// @Param clusterName formData string true "集群名称"

 controllers/dbtableperson.go

@@ -246,7 +246,7 @@
// @Security ApiKeyAuth
// @Summary 更新底库人脸照片
// @Description 更新底库人脸照片
// @Accept  json
// @Accept multipart/form-data
// @Produce json
// @Tags dbperson 底库人员
// @Param id formData string true "人员id"

 controllers/dictionary.go

@@ -32,6 +32,7 @@
// @Security ApiKeyAuth
// @Summary 根据父ID查找字典
// @Description  根据父ID查找字典
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags 字典
// @Param parentId query string false "parentId"

 controllers/eventPush.go

@@ -50,6 +50,8 @@
// @Security ApiKeyAuth
// @Summary 事件推送保存
// @Description 事件推送保存
// @Accept json
// @Produce json
// @Tags 事件推送
// @Param SaveArgs body controllers.EventPushVo true "时间推送保存参数"
// @Success 200 {string} json "{"code":200, success:true, msg:"", data:""}"
@@ -74,6 +76,7 @@
// @Security ApiKeyAuth
// @Summary 根据事件推送主题的一级和二级选项获取最后下拉菜单列表
// @Description  根据事件推送主题的一级和二级选项获取最后下拉菜单列表
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags 事件推送
// @Param topic query string true "一级主题选项,例如：camera(摄像机)"
@@ -100,6 +103,7 @@
// @Security ApiKeyAuth
// @Summary 查全部
// @Description  查全部
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags 事件推送
// @Param name query string false "事件名称"
@@ -120,6 +124,7 @@
// @Security ApiKeyAuth
// @Summary 事件推送编辑
// @Description  事件推送编辑
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags 事件推送
// @Param id query string true "id"
@@ -149,6 +154,7 @@
// @Security ApiKeyAuth
// @Summary 改变enable状态
// @Description  改变enable状态
// @Accept json
// @Produce json
// @Tags 事件推送
// @Param statusBody body controllers.ChangeStatusVo true "参数结构"

 controllers/fileController.go

@@ -53,7 +53,7 @@
// @Security ApiKeyAuth
// @Summary 依据图片添加底库人员
// @Description  依据图片添加底库返回数据人员
// @Accept  mpfd
// @Accept  multipart/form-data
// @Produce json
// @Tags dbperson 底库人员
// @Param file formData file true "底库人员图片"
@@ -114,6 +114,7 @@
// @Security ApiKeyAuth
// @Summary 人脸提取
// @Description  人脸提取
// @Accept multipart/form-data
// @Produce json
// @Tags 以图搜图
// @Param file formData file true "人员图片"
@@ -807,7 +808,7 @@
// @Security ApiKeyAuth
// @Summary 批量添加底库人员
// @Description  依据图片批量添加底库人员
// @Accept  mpfd
// @Accept  multipart/form-data
// @Produce json
// @Tags dbperson 底库人员
// @Param files formData file[] true "多个底库人员图片"
@@ -898,7 +899,7 @@
// @Security ApiKeyAuth
// @Summary 上传图片 并切图
// @Description  上传图片 并切图
// @Accept  mpfd
// @Accept  multipart/form-data
// @Produce json
// @Tags dbperson 底库人员
// @Param file formData file true "底库人员图片"

 controllers/pollConfig.go

@@ -93,6 +93,7 @@
// @Security ApiKeyAuth
// @Summary 切换轮询开关
// @Description 切换轮询开关
// @Accept json
// @Produce json
// @Tags 轮询配置
// @Param argBody body controllers.PollEnableVo true "开关参数"

 controllers/sdk.go

@@ -43,6 +43,7 @@
// @Security ApiKeyAuth
// @Summary 算法保存
// @Description 算法保存
// @Accept json
// @Produce json
// @Tags sdk
// @Param reqMap body controllers.SdkVo true "人脸检测"

 controllers/sysMenu.go

@@ -16,7 +16,6 @@
// @Security ApiKeyAuth
// @Summary 当前用户的系统菜单
// @Description 当前用户的系统菜单
// @Accept json
// @Produce json
// @Tags 系统菜单
// @Success 200 {string} json "{"code":200, success:true, msg:"", data:""}"
@@ -38,7 +37,6 @@
// @Security ApiKeyAuth
// @Summary 查找当前用户可见的系统菜单
// @Description 查找当前用户可见的系统菜单
// @Accept json
// @Produce json
// @Tags 系统菜单
// @Success 200 {string} json "{"code":200, success:true, msg:"", data:""}"

 controllers/syssetcont.go

@@ -101,7 +101,6 @@
// @Security ApiKeyAuth
// @Summary 存储信息修改
// @Description 存储信息修改
// @Accept  json
// @Produce json
// @Tags sysset
// @Success 200 {string} json "{"code":200, msg:"目录结构数据", success:true}"
@@ -283,7 +282,6 @@
// @Security ApiKeyAuth
// @Summary 测试同步时间
// @Description 测试同步时间服务器是否可用
// @Accept  json
// @Produce json
// @Tags sysset
// @Param server query string true "时间服务器ip"
@@ -404,6 +402,7 @@

// @Summary 设置定时重启
// @Description 设置定时重启任务的配置规则
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags sysset
// @Success 200 {string} json "{"code":200, msg:"目录结构数据", success:true}"

 controllers/task.go

@@ -167,6 +167,7 @@
// @Security ApiKeyAuth
// @Summary 给任务添加算法
// @Description 任务添加算法
// @Accept json
// @Produce json
// @Tags task
// @Param taskSdkAdd body controllers.TaskSdkAdd true "任务id"
@@ -219,6 +220,7 @@
// @Security ApiKeyAuth
// @Summary 更新任务名称
// @Description 更新任务名称
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags task
// @Param taskId formData string true "taskId"
@@ -250,6 +252,7 @@
// @Security ApiKeyAuth
// @Summary 更新任务状态
// @Description （算法不变,只更新任务状态）
// @Accept json
// @Produce json
// @Tags task
// @Param taskStatus body controllers.TaskStatusVo true "参数"
@@ -341,6 +344,7 @@
// @Security ApiKeyAuth
// @Summary 删除算法规则
// @Description 删除算法规则
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags 算法规则
// @Param taskId formData string true "taskId"

 controllers/user.go

@@ -21,7 +21,7 @@

// @Summary 用户登录
// @Description 用户登录
// @Accept json
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags 用户
// @Param username formData string true "用户名"
@@ -124,7 +124,7 @@
// @Security ApiKeyAuth
// @Summary 编辑此用户，返回此用户的权限菜单
// @Description 编辑此用户，返回此用户的权限菜单
// @Accept json
// @Accept x-www-form-urlencoded
// @Produce json
// @Tags 用户
// @Param userId formData string true "用户id"