update - 添加接口的注释

This commit is contained in:
wangli 2024-01-15 13:56:27 +08:00
parent d8f1a869cc
commit 93e0d491e8

View File

@ -140,6 +140,12 @@ public class ProcessCategoryController implements ProcessCategoryApi {
return success(categoryService.search(dto));
}
/**
* 业务分类创建黑白名单配置项
*
* @param dto
* @return
*/
@PostMapping("/config/create")
@Override
public CommonResponse<Boolean> createConfig(@Validated @RequestBody CategoryConfigCreateDTO dto) {
@ -147,24 +153,49 @@ public class ProcessCategoryController implements ProcessCategoryApi {
return success(true);
}
/**
* 删除指定分类的配置项数据
*
* @param id
* @return
*/
@DeleteMapping("/config/delete/{id}")
@Override
public CommonResponse<Boolean> deleteConfig(@PathVariable Long id) {
return success(categoryConfigService.delete(id));
}
/**
* 业务分类黑白名单查询
*
* @return
*/
@PostMapping("/config/page/search")
@Override
public CommonResponse<BpmPageResult<CategoryConfigItemVO>> configSearch(@Validated @RequestBody CategoryConfigSearchDTO dto) {
return success(categoryConfigService.configSearch(dto));
}
/**
* 更新业务分类的配置类型
*
* @param id
* @param configType
* @return
*/
@PostMapping("/config/type/update")
@Override
public CommonResponse<Boolean> updateCategoryConfigType(@RequestParam Long id, @RequestParam String configType) {
return success(categoryService.updateRemark(id, configType));
}
/**
* 用于业务方判断指定的业务分类的黑白名单配置
*
* @param tenantId 租户ID
* @param categoryCode 业务分类编码
* @return true: 可以发起创建流程实例, false: 不可用
*/
@GetMapping("/check/status")
@Override
public CommonResponse<Boolean> checkCategoryStatus(@RequestParam Long tenantId, @RequestParam String categoryCode) {