瀏覽代碼

更新 webapi 的 swagger 注释

reghao 1 年之前
父節點
當前提交
38ecbaa774
共有 38 個文件被更改,包括 143 次插入151 次删除
  1. 2 2
      mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/AccountCodeController.java
  2. 7 7
      mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/MenuController.java
  3. 4 4
      mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/RoleController.java
  4. 9 9
      mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/UserController.java
  5. 4 4
      mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/page/MenuPageController.java
  6. 6 6
      mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/page/RolePageController.java
  7. 7 7
      mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/page/UserPageController.java
  8. 2 2
      mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/EmailController.java
  9. 4 4
      mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/ReceiverController.java
  10. 1 1
      mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/SysMessageController.java
  11. 3 3
      mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/page/EmailPageController.java
  12. 3 3
      mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/page/ReceiverPageController.java
  13. 2 2
      mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/page/SysLogPageController.java
  14. 2 2
      mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/page/SysMessagePageController.java
  15. 3 3
      mgr/src/main/java/cn/reghao/devops/mgr/app/HomeController.java
  16. 5 5
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/AppConfigController.java
  17. 3 3
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/AppDeployConfigController.java
  18. 7 15
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/BuildDeployController.java
  19. 2 2
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/GetAppController.java
  20. 5 5
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/RunStatController.java
  21. 5 5
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/page/AppConfigPageController.java
  22. 4 4
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/page/AppDeployConfigPageController.java
  23. 7 7
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/page/BuildDeployPageController.java
  24. 2 2
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/page/StatusPageController.java
  25. 1 1
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/BuildDirController.java
  26. 2 2
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/CompilerConfigController.java
  27. 2 2
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/DockerRegistryController.java
  28. 2 2
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/PackerConfigController.java
  29. 2 2
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/RepoAuthConfigController.java
  30. 2 2
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/page/BuildDirPageController.java
  31. 6 6
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/page/CompilerPageController.java
  32. 4 4
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/page/DockerRegistryPageController.java
  33. 4 4
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/page/PackerPageController.java
  34. 4 4
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/page/RepoAuthPageController.java
  35. 4 4
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/log/controller/AppLogController.java
  36. 1 1
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/machine/controller/ClusterController.java
  37. 4 4
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/machine/controller/MachineHostController.java
  38. 6 6
      mgr/src/main/java/cn/reghao/devops/mgr/mgr/machine/controller/page/MachineHostPageController.java

+ 2 - 2
mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/AccountCodeController.java

@@ -33,14 +33,14 @@ public class AccountCodeController {
         this.pubkeyService = pubkeyService;
     }
 
-    @ApiOperation(value = "获取公钥")
+    @ApiOperation(value = "获取公钥", notes = "N")
     @GetMapping(value = "/pubkey", produces = MediaType.APPLICATION_JSON_VALUE)
     public String getPubkey() throws NoSuchAlgorithmException {
         RsaPubkey rsaPubkey = pubkeyService.getPubkey();
         return WebResult.success(rsaPubkey);
     }
 
-    @ApiOperation(value = "获取图形验证码")
+    @ApiOperation(value = "获取图形验证码", notes = "N")
     @GetMapping(value = "/captcha", produces = MediaType.APPLICATION_JSON_VALUE)
     public String getCaptcha() throws IOException {
         InputStream in = codeService.generateCaptcha();

+ 7 - 7
mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/MenuController.java

@@ -29,7 +29,7 @@ public class MenuController {
         this.menuService = menuService;
     }
 
-    @ApiOperation(value = "添加资源")
+    @ApiOperation(value = "添加资源", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(produces = MediaType.APPLICATION_JSON_VALUE)
     public String addMenu(@Validated Menu menu) {
@@ -37,7 +37,7 @@ public class MenuController {
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "修改资源")
+    @ApiOperation(value = "修改资源", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/edit", produces = MediaType.APPLICATION_JSON_VALUE)
     public String modifyMenu(@Validated MenuDto menuDto) {
@@ -45,7 +45,7 @@ public class MenuController {
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "修改资源状态")
+    @ApiOperation(value = "修改资源状态", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/status/{enabled}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String menuStatus(@PathVariable("enabled") boolean enabled, @RequestParam("ids") List<Integer> ids) {
@@ -53,7 +53,7 @@ public class MenuController {
         return WebResult.success();
     }
 
-    @ApiOperation(value = "删除资源")
+    @ApiOperation(value = "删除资源", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @DeleteMapping(value = "/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deleteMenu(@PathVariable("id") Integer menuId) {
@@ -62,7 +62,7 @@ public class MenuController {
         return WebResult.failWithMsg("接口未实现");
     }
 
-    @ApiOperation(value = "获取指定状态的菜单")
+    @ApiOperation(value = "获取指定状态的菜单", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping(value = "/ztree/{enabled}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String list(@PathVariable(value = "enabled") Boolean enabled) {
@@ -70,7 +70,7 @@ public class MenuController {
         return WebResult.success(list);
     }
 
-    @ApiOperation(value = "返回所有 dir menu")
+    @ApiOperation(value = "返回所有 dir menu", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping(value = "/ztree/parent", produces = MediaType.APPLICATION_JSON_VALUE)
     public String getDirMenus() {
@@ -78,7 +78,7 @@ public class MenuController {
         return WebResult.success(list);
     }
 
-    @ApiOperation(value = "对同一 pid 组内的资源进行排序")
+    @ApiOperation(value = "对同一 pid 组内的资源进行排序", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping(value = "/sorted/{pid}/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String sortList(@PathVariable(value = "pid") int pid,

+ 4 - 4
mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/RoleController.java

@@ -35,7 +35,7 @@ public class RoleController {
         this.menuService = menuService;
     }
 
-    @ApiOperation("添加或修改角色")
+    @ApiOperation(value = "添加或修改角色", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(produces = MediaType.APPLICATION_JSON_VALUE)
     public String addOrModifyRole(@Validated RoleDto roleDto) {
@@ -43,7 +43,7 @@ public class RoleController {
         return WebResult.success();
     }
 
-    @ApiOperation("删除角色")
+    @ApiOperation(value = "删除角色", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @DeleteMapping(value = "/{roleId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deleteRole(@PathVariable("roleId") Integer roleId) {
@@ -58,7 +58,7 @@ public class RoleController {
      * @return
      * @date 2024-07-30 16:08:42
      */
-    @ApiOperation("获取角色可访问的资源")
+    @ApiOperation(value = "获取角色可访问的资源", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping(value = "/menus/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String getRoleMenus(@PathVariable("id") Role role) {
@@ -66,7 +66,7 @@ public class RoleController {
         return WebResult.success(allMenus);
     }
 
-    @ApiOperation("设置角色可访问的资源")
+    @ApiOperation(value = "设置角色可访问的资源", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/menus", produces = MediaType.APPLICATION_JSON_VALUE)
     public String setRoleMenus(@RequestParam(value = "id") Integer roleId,

+ 9 - 9
mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/UserController.java

@@ -31,27 +31,27 @@ public class UserController {
         this.accountService = accountService;
     }
 
-    @ApiOperation(value = "修改个人头像")
+    @ApiOperation(value = "修改个人头像", notes = "N")
     @PostMapping(value = "/avatar", produces = MediaType.APPLICATION_JSON_VALUE)
     public String userAvatar(MultipartFile file) {
         return WebResult.failWithMsg("接口未实现");
     }
 
-    @ApiOperation(value = "修改个人信息")
+    @ApiOperation(value = "修改个人信息", notes = "N")
     @PostMapping(value = "/update", produces = MediaType.APPLICATION_JSON_VALUE)
     public String editUserInfo(@Validated AccountProfile accountProfile) {
         accountService.updateAccountProfile(accountProfile);
         return WebResult.success();
     }
 
-    @ApiOperation(value = "修改个人密码")
+    @ApiOperation(value = "修改个人密码", notes = "N")
     @PostMapping(value = "/passwd/update", produces = MediaType.APPLICATION_JSON_VALUE)
     @ResponseBody
     public String editPasswd(UpdatePasswordDto updatePasswordDto) {
         return WebResult.failWithMsg("接口未实现");
     }
 
-    @ApiOperation(value = "创建用户")
+    @ApiOperation(value = "创建用户", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(produces = MediaType.APPLICATION_JSON_VALUE)
     public String createUser(@Validated CreateAccountDto createAccountDto) {
@@ -59,14 +59,14 @@ public class UserController {
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "批量创建用户")
+    @ApiOperation(value = "批量创建用户", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/batch", produces = MediaType.APPLICATION_JSON_VALUE)
     public String batchAdd(MultipartFile file) {
         return WebResult.failWithMsg("接口未实现");
     }
 
-    @ApiOperation(value = "删除用户")
+    @ApiOperation(value = "删除用户", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @DeleteMapping(value = "/delete/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deleteAccount(@PathVariable("id") Integer userId) {
@@ -74,7 +74,7 @@ public class UserController {
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "修改用户密码")
+    @ApiOperation(value = "修改用户密码", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/passwd", produces = MediaType.APPLICATION_JSON_VALUE)
     public String modifyPassword(@NotNull Integer id, @NotNull String newPassword) {
@@ -82,7 +82,7 @@ public class UserController {
         return WebResult.success();
     }
 
-    @ApiOperation(value = "分配用户角色")
+    @ApiOperation(value = "分配用户角色", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/role", produces = MediaType.APPLICATION_JSON_VALUE)
     public String assignRole(@Validated AccountRole accountRole) {
@@ -90,7 +90,7 @@ public class UserController {
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "启用/禁用用户")
+    @ApiOperation(value = "启用/禁用用户", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/status/{userId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String updateAccountStatus(@PathVariable("userId") Integer userId) {

+ 4 - 4
mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/page/MenuPageController.java

@@ -20,7 +20,7 @@ import java.util.stream.Collectors;
 @RequestMapping("/rbac/menu")
 @Controller
 public class MenuPageController {
-    @ApiOperation(value = "资源列表页面")
+    @ApiOperation(value = "资源列表页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping
     public String menuPage(@RequestParam(value = "enabled", required = false) Boolean enabled, Model model) {
@@ -32,14 +32,14 @@ public class MenuPageController {
         return "/admin/menu/index";
     }
 
-    @ApiOperation(value = "资源添加页面")
+    @ApiOperation(value = "资源添加页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping(value = "/add")
     public String addMenuPage(Model model) {
         return "/admin/menu/add";
     }
 
-    @ApiOperation(value = "资源编辑页面")
+    @ApiOperation(value = "资源编辑页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/edit/{id}")
     public String toEdit(@PathVariable("id") Menu menu, Model model) {
@@ -48,7 +48,7 @@ public class MenuPageController {
     }
 
     // TODO Hibernate 会根据传入的 id 自动查找相应的 Menu
-    @ApiOperation(value = "可访问资源的角色列表页面")
+    @ApiOperation(value = "可访问资源的角色列表页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/{id}/roles")
     public String roleListWithResource(@PathVariable("id") Menu menu, Model model) {

+ 6 - 6
mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/page/RolePageController.java

@@ -28,7 +28,7 @@ public class RolePageController {
         this.roleService = roleService;
     }
 
-    @ApiOperation("角色列表页面")
+    @ApiOperation(value = "角色列表页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping
     public String rolePage(@RequestParam(value = "name", required = false) String name, Model model) {
@@ -45,14 +45,14 @@ public class RolePageController {
         return "/admin/role/index";
     }
 
-    @ApiOperation("角色新增页面")
+    @ApiOperation(value = "角色新增页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/add")
     public String addRolePage() {
         return "/admin/role/add";
     }
 
-    @ApiOperation("角色编辑页面")
+    @ApiOperation(value = "角色编辑页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/edit/{id}")
     public String editRolePage(@PathVariable("id") int id, Model model) {
@@ -61,7 +61,7 @@ public class RolePageController {
         return "/admin/role/add";
     }
 
-    @ApiOperation("角色详细信息页面")
+    @ApiOperation(value = "角色详细信息页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/detail/{id}")
     public String roleDetailPage(@PathVariable("id") int id, Model model) {
@@ -70,7 +70,7 @@ public class RolePageController {
         return "/admin/role/detail";
     }
 
-    @ApiOperation("设置角色可访问的资源页面")
+    @ApiOperation(value = "设置角色可访问的资源页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/menus/{id}")
     public String menusPage(@PathVariable(value = "id") Integer id, Model model){
@@ -78,7 +78,7 @@ public class RolePageController {
         return "/admin/role/menus";
     }
 
-    @ApiOperation("拥有角色的所有用户页面")
+    @ApiOperation(value = "拥有角色的所有用户页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/users/{id}")
     public String userListWithRole(@PathVariable("id") Integer roleId, Model model) {

+ 7 - 7
mgr/src/main/java/cn/reghao/devops/mgr/admin/account/controller/page/UserPageController.java

@@ -38,7 +38,7 @@ public class UserPageController {
         this.accountSessionService = accountSessionService;
     }
 
-    @ApiOperation(value = "个人信息页面")
+    @ApiOperation(value = "个人信息页面", notes = "N")
     @GetMapping("/profile")
     public String userInfoPage(Model model) {
         User user = UserContext.getUser();
@@ -46,13 +46,13 @@ public class UserPageController {
         return "/admin/user/userinfo";
     }
 
-    @ApiOperation(value = "修改个人密码页面")
+    @ApiOperation(value = "修改个人密码页面", notes = "N")
     @GetMapping("/passwd/edit")
     public String editPasswdPage(Model model) {
         return "/admin/user/userpasswd";
     }
 
-    @ApiOperation(value = "用户列表页面")
+    @ApiOperation(value = "用户列表页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping
     public String userPage(@RequestParam(value = "screenName", required = false) String screenName, Model model) {
@@ -79,7 +79,7 @@ public class UserPageController {
         return "/admin/user/index";
     }
 
-    @ApiOperation(value = "新增用户页面")
+    @ApiOperation(value = "新增用户页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/add")
     public String addUserPage(Model model) {
@@ -89,7 +89,7 @@ public class UserPageController {
         return "/admin/user/add";
     }
 
-    @ApiOperation(value = "用户详细信息页面")
+    @ApiOperation(value = "用户详细信息页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/detail/{id}")
     public String userDetailPage(@PathVariable("id") int id, Model model) {
@@ -102,7 +102,7 @@ public class UserPageController {
         return "/admin/user/detail";
     }
 
-    @ApiOperation(value = "重置用户密码页面")
+    @ApiOperation(value = "重置用户密码页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/passwd/{id}")
     public String modifyPasswordPage(@PathVariable("id") Integer id, Model model) {
@@ -110,7 +110,7 @@ public class UserPageController {
         return "/admin/user/passwd";
     }
 
-    @ApiOperation(value = "用户角色分配页面")
+    @ApiOperation(value = "用户角色分配页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/role/{id}")
     public String assignRolePage(@PathVariable("id") User user, Model model) {

+ 2 - 2
mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/EmailController.java

@@ -31,7 +31,7 @@ public class EmailController {
         this.emailAccountRepository = emailAccountRepository;
     }
 
-    @ApiOperation(value = "添加邮箱帐号")
+    @ApiOperation(value = "添加邮箱帐号", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/save", produces = MediaType.APPLICATION_JSON_VALUE)
     public String saveReceiver(@Validated EmailAccount emailAccount) {
@@ -56,7 +56,7 @@ public class EmailController {
         return WebResult.success();
     }
 
-    @ApiOperation(value = "删除邮箱帐号")
+    @ApiOperation(value = "删除邮箱帐号", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @DeleteMapping(value = "/delete/{username}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deleteEmail(@PathVariable("username") String username) {

+ 4 - 4
mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/ReceiverController.java

@@ -33,7 +33,7 @@ public class ReceiverController {
         this.emailAccountRepository = emailAccountRepository;
     }
 
-    @ApiOperation(value = "添加通知接收")
+    @ApiOperation(value = "添加通知接收", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/save", produces = MediaType.APPLICATION_JSON_VALUE)
     public String saveReceiver(@Validated NotifyReceiver notifyReceiver) {
@@ -68,7 +68,7 @@ public class ReceiverController {
         return WebResult.success();
     }
 
-    @ApiOperation(value = "更新通知接收")
+    @ApiOperation(value = "更新通知接收", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/edit", produces = MediaType.APPLICATION_JSON_VALUE)
     public String editReceiver(@Validated NotifyReceiver notifyReceiver) {
@@ -84,7 +84,7 @@ public class ReceiverController {
         return WebResult.success();
     }
 
-    @ApiOperation(value = "更新通知接收")
+    @ApiOperation(value = "更新通知接收", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/default/{name}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String updateDefaultReceiver(@PathVariable("name") String name) {
@@ -101,7 +101,7 @@ public class ReceiverController {
         return WebResult.success();
     }
 
-    @ApiOperation(value = "删除通知接收")
+    @ApiOperation(value = "删除通知接收", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @DeleteMapping(value = "/delete/{name}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deleteReceiver(@PathVariable("name") String name) {

+ 1 - 1
mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/SysMessageController.java

@@ -25,7 +25,7 @@ public class SysMessageController {
         this.sysMessageService = sysMessageService;
     }
 
-    @ApiOperation(value = "清空系统消息")
+    @ApiOperation(value = "清空系统消息", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/message/clear", produces = MediaType.APPLICATION_JSON_VALUE)
     @ResponseBody

+ 3 - 3
mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/page/EmailPageController.java

@@ -27,7 +27,7 @@ public class EmailPageController {
         this.emailAccountRepository = emailAccountRepository;
     }
 
-    @ApiOperation(value = "邮箱帐号列表页面")
+    @ApiOperation(value = "邮箱帐号列表页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("")
     public String emailIndex(Model model) {
@@ -42,14 +42,14 @@ public class EmailPageController {
         return "/admin/notify/email";
     }
 
-    @ApiOperation(value = "添加邮箱帐号页面")
+    @ApiOperation(value = "添加邮箱帐号页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/add")
     public String emailAdd(Model model) {
         return "/admin/notify/emailadd";
     }
 
-    @ApiOperation(value = "更新邮箱帐号页面")
+    @ApiOperation(value = "更新邮箱帐号页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/edit/{username}")
     public String emailEdit(@PathVariable("username") String username, Model model) throws Exception {

+ 3 - 3
mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/page/ReceiverPageController.java

@@ -25,7 +25,7 @@ public class ReceiverPageController {
         this.notifyReceiverRepository = notifyReceiverRepository;
     }
 
-    @ApiOperation(value = "通知接收列表页面")
+    @ApiOperation(value = "通知接收列表页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("")
     public String receiverIndex(Model model) throws Exception {
@@ -36,14 +36,14 @@ public class ReceiverPageController {
         return "/admin/notify/receiver";
     }
 
-    @ApiOperation(value = "添加通知接收页面")
+    @ApiOperation(value = "添加通知接收页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/add")
     public String receiverAdd(Model model) throws Exception {
         return "/admin/notify/receiveradd";
     }
 
-    @ApiOperation(value = "更新通知接收页面")
+    @ApiOperation(value = "更新通知接收页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/edit/{name}")
     public String receiverEdit(@PathVariable("name") String name, Model model) throws Exception {

+ 2 - 2
mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/page/SysLogPageController.java

@@ -15,14 +15,14 @@ import org.springframework.web.bind.annotation.RequestMapping;
 @Controller
 @RequestMapping("/sys/log")
 public class SysLogPageController {
-    @ApiOperation(value = "系统运行日志页面")
+    @ApiOperation(value = "系统运行日志页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/rt")
     public String runtimeLogPage() {
         return "/admin/log/rtlog";
     }
 
-    @ApiOperation(value = "系统访问日志页面")
+    @ApiOperation(value = "系统访问日志页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/access")
     public String accessLogPage() {

+ 2 - 2
mgr/src/main/java/cn/reghao/devops/mgr/admin/sys/controller/page/SysMessagePageController.java

@@ -29,7 +29,7 @@ public class SysMessagePageController {
         this.sysMessageRepository = sysMessageRepository;
     }
 
-    @ApiOperation(value = "系统消息页面")
+    @ApiOperation(value = "系统消息页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("")
     public String messagePage(Model model) {
@@ -39,7 +39,7 @@ public class SysMessagePageController {
         return "/admin/msg/sysmsg";
     }
 
-    @ApiOperation(value = "系统消息内容")
+    @ApiOperation(value = "系统消息内容", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/detail/{id}")
     public String messageDetail(@PathVariable("id") int id, Model model) {

+ 3 - 3
mgr/src/main/java/cn/reghao/devops/mgr/app/HomeController.java

@@ -49,14 +49,14 @@ public class HomeController {
         this.machineQuery = machineQuery;
     }
 
-    @ApiOperation(value = "帐号登入页面")
+    @ApiOperation(value = "帐号登入页面", notes = "N")
     @GetMapping("/login")
     public String toLogin(Model model) {
         model.addAttribute("isCaptcha", false);
         return "/login";
     }
 
-    @ApiOperation(value = "系统主页面")
+    @ApiOperation(value = "系统主页面", notes = "N")
     @GetMapping("/")
     public String index(Model model) throws Exception {
         User user = UserContext.getUser();
@@ -78,7 +78,7 @@ public class HomeController {
         return "/main";
     }
 
-    @ApiOperation(value = "系统 home 页面")
+    @ApiOperation(value = "系统 home 页面", notes = "N")
     @GetMapping("/home")
     public String home(Model model) {
         String commitId = NotAvailable.na.getDesc();

+ 5 - 5
mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/AppConfigController.java

@@ -29,7 +29,7 @@ public class AppConfigController {
         this.appBuildService = appBuildService;
     }
 
-    @ApiOperation(value = "添加应用配置")
+    @ApiOperation(value = "添加应用配置", notes = "N")
     @PostMapping(produces = MediaType.APPLICATION_JSON_VALUE)
     public String addAppConfig(@Validated AppConfigDto appConfigDto) {
         Result result = appBuildService.createAppBuild(appConfigDto);
@@ -37,21 +37,21 @@ public class AppConfigController {
     }
 
     // TODO 使用 @PathVariable 注解时会自动填充实体
-    @ApiOperation(value = "复制应用配置")
+    @ApiOperation(value = "复制应用配置", notes = "N")
     @PostMapping(value = "/copy", produces = MediaType.APPLICATION_JSON_VALUE)
     public String copyAppConfig(@Validated CopyAppDto copyAppDto) {
         Result result = appBuildService.createByCopy(copyAppDto);
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "修改应用配置")
+    @ApiOperation(value = "修改应用配置", notes = "N")
     @PostMapping(value = "/update", produces = MediaType.APPLICATION_JSON_VALUE)
     public String updateAppConfig(@Validated AppConfigUpdateDto appConfigUpdateDto) {
         Result result = appBuildService.updateAppConfig(appConfigUpdateDto);
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "删除应用配置")
+    @ApiOperation(value = "删除应用配置", notes = "N")
     @DeleteMapping(value = "/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deleteAppConfig(@PathVariable("id") AppConfig app) {
         String appId = app.getAppId();
@@ -59,7 +59,7 @@ public class AppConfigController {
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "清空应用本地仓库")
+    @ApiOperation(value = "清空应用本地仓库", notes = "N")
     @DeleteMapping(value = "/repo/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deleteAppLocalRepo(@PathVariable("id") AppConfig app) {
         String appId = app.getAppId();

+ 3 - 3
mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/AppDeployConfigController.java

@@ -26,21 +26,21 @@ public class AppDeployConfigController {
         this.appDeployService = appDeployService;
     }
 
-    @ApiOperation(value = "添加应用部署配置")
+    @ApiOperation(value = "添加应用部署配置", notes = "N")
     @PostMapping(produces = MediaType.APPLICATION_JSON_VALUE)
     public String add(@Validated DeployConfigDto deployConfigDto) {
         Result result = appDeployService.addDeployConfig(deployConfigDto);
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "修改应用部署配置")
+    @ApiOperation(value = "修改应用部署配置", notes = "N")
     @PostMapping(value = "/update", produces = MediaType.APPLICATION_JSON_VALUE)
     public String update(@Validated DeployConfigDto deployConfigDto) {
         Result result = appDeployService.updateStartScript(deployConfigDto);
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "删除应用部署配置")
+    @ApiOperation(value = "删除应用部署配置", notes = "N")
     @DeleteMapping(value = "/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String delete(@PathVariable("id") Integer appDeployConfigId) {
         Result result = appDeployService.deleteDeployConfig(appDeployConfigId);

+ 7 - 15
mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/BuildDeployController.java

@@ -7,8 +7,6 @@ import cn.reghao.devops.mgr.mgr.app.service.webhook.WebhookService;
 import cn.reghao.jutil.jdk.result.Result;
 import cn.reghao.jutil.jdk.result.WebResult;
 import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiImplicitParam;
-import io.swagger.annotations.ApiImplicitParams;
 import io.swagger.annotations.ApiOperation;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.MediaType;
@@ -35,27 +33,21 @@ public class BuildDeployController {
         this.webhookService = webhookService;
     }
 
-    @ApiOperation(value = "构建部署应用")
-    @ApiImplicitParams(@ApiImplicitParam(name="appId", value="应用 ID", paramType="path", dataType = "String"))
+    @ApiOperation(value = "构建部署应用", notes = "N")
     @PostMapping(value = "/update/{appId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String buildAndDeploy(@PathVariable("appId") String appId) throws Exception {
         Result result = buildApp.buildAndDeploy(appId, true);
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "构建应用")
-    @ApiImplicitParams(@ApiImplicitParam(name="appId", value="应用 ID", paramType="path", dataType = "String"))
+    @ApiOperation(value = "构建应用", notes = "N")
     @PostMapping(value = "/build/{appId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String build(@PathVariable("appId") String appId) throws Exception {
         Result result = buildApp.buildAndDeploy(appId, false);
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "部署应用")
-    @ApiImplicitParams({
-            @ApiImplicitParam(name="buildLogId", value="构建 ID", paramType="path", dataType = "String"),
-            @ApiImplicitParam(name="machineId", value="机器 ID", paramType="path", dataType = "String")
-    })
+    @ApiOperation(value = "部署应用", notes = "N")
     @PostMapping(value = "/deploy/{buildLogId}/{machineId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deploy(@PathVariable("buildLogId") String buildLogId, @PathVariable("machineId") String machineId)
             throws Exception {
@@ -67,28 +59,28 @@ public class BuildDeployController {
         return WebResult.successWithMsg("部署请求已提交");
     }
 
-    @ApiOperation(value = "重置应用构建状态")
+    @ApiOperation(value = "重置应用构建状态", notes = "N")
     @PostMapping(value = "/reset", produces = MediaType.APPLICATION_JSON_VALUE)
     public String resetState() {
         appBuildService.resetBuildStat();
         return WebResult.success("构建状态已重置");
     }
 
-    @ApiOperation(value = "取消构建任务")
+    @ApiOperation(value = "取消构建任务", notes = "N")
     @PostMapping(value = "/task/cancel/{appId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String cancelTask(@PathVariable("appId") String appId) {
         //buildApp.cancelTask(appId);
         return WebResult.failWithMsg("接口未实现");
     }
 
-    @ApiOperation(value = "webhook 自动构建部署")
+    @ApiOperation(value = "webhook 自动构建部署", notes = "N")
     @PostMapping("/hook")
     public String hook(@RequestBody String body) throws Exception {
         webhookService.handle(body);
         return WebResult.success();
     }
 
-    @ApiOperation(value = "删除构建")
+    @ApiOperation(value = "删除构建", notes = "N")
     @DeleteMapping(value = "/delete/{buildLogId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deleteBuild(@PathVariable("buildLogId") String buildLogId) throws Exception {
         appBuildService.deleteBuildLog(buildLogId);

+ 2 - 2
mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/GetAppController.java

@@ -27,7 +27,7 @@ public class GetAppController {
         this.getApp = getApp;
     }
 
-    @ApiOperation(value = "构建包下载接口")
+    @ApiOperation(value = "构建包下载接口", notes = "N")
     @GetMapping(value = "/packageurl/{buildLogId}", produces = MediaType.APPLICATION_JSON_VALUE)
     @ResponseBody
     public String packageUrl(@PathVariable("buildLogId") String buildLogId) throws Exception {
@@ -35,7 +35,7 @@ public class GetAppController {
         return WebResult.successWithMsg(packageUrl);
     }
 
-    @ApiOperation(value = "构建包下载接口")
+    @ApiOperation(value = "构建包下载接口", notes = "N")
     @GetMapping("/dl/{filename}")
     public String dlPackage(@PathVariable("filename") String filename) {
         try {

+ 5 - 5
mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/RunStatController.java

@@ -32,28 +32,28 @@ public class RunStatController {
         this.logService = logService;
     }
 
-    @ApiOperation(value = "重启应用")
+    @ApiOperation(value = "重启应用", notes = "N")
     @PostMapping(value = "/restart/{appId}/{machineId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String restart(@PathVariable("appId") String appId, @PathVariable("machineId") String machineId) throws Exception {
         appRunService.changeStatus(appId, machineId, AppStatOps.restart);
         return WebResult.result(Result.result(ResultStatus.SUCCESS, appId + " 正在重启,请 10s 后刷新页面查看最新状态"));
     }
 
-    @ApiOperation(value = "停止应用")
+    @ApiOperation(value = "停止应用", notes = "N")
     @PostMapping(value = "/stop/{appId}/{machineId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String stop(@PathVariable("appId") String appId, @PathVariable("machineId") String machineId) throws Exception {
         appRunService.changeStatus(appId, machineId, AppStatOps.stop);
         return WebResult.result(Result.result(ResultStatus.SUCCESS, appId + " 正在停止,请稍后刷新页面"));
     }
 
-    @ApiOperation(value = "启动应用")
+    @ApiOperation(value = "启动应用", notes = "N")
     @PostMapping(value = "/start/{appId}/{machineId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String start(@PathVariable("appId") String appId, @PathVariable("machineId") String machineId) throws Exception {
         appRunService.changeStatus(appId, machineId, AppStatOps.start);
         return WebResult.result(Result.result(ResultStatus.SUCCESS, appId + " 正在启动,请 10s 后刷新页面查看最新状态"));
     }
 
-    @ApiOperation(value = "应用当前状态")
+    @ApiOperation(value = "应用当前状态", notes = "N")
     @GetMapping(value = "/{appId}/{machineId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String status(@PathVariable("appId") String appId, @PathVariable("machineId") String machineId) {
         appRunService.getStatus(appId, machineId);
@@ -61,7 +61,7 @@ public class RunStatController {
         return WebResult.result(Result.result(ResultStatus.SUCCESS, msg));
     }
 
-    @ApiOperation(value = "应用历史日志")
+    @ApiOperation(value = "应用历史日志", notes = "N")
     @GetMapping(value = "/log", produces = MediaType.APPLICATION_JSON_VALUE)
     public String getAppLog() {
         List<AppLogVO> list = logService.getAppLogs("admin-service", "172.16.90.200", "INFO");

+ 5 - 5
mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/page/AppConfigPageController.java

@@ -48,7 +48,7 @@ public class AppConfigPageController {
         this.packerConfigRepository = packerConfigRepository;
     }
 
-    @ApiOperation(value = "应用配置列表页面")
+    @ApiOperation(value = "应用配置列表页面", notes = "N")
     @GetMapping
     public String appConfigPage(@RequestParam(value = "env", required = false) String env,
                                 @RequestParam(value = "type", required = false) String type,
@@ -84,7 +84,7 @@ public class AppConfigPageController {
         return "/devops/app/config/index";
     }
 
-    @ApiOperation(value = "添加应用配置页面")
+    @ApiOperation(value = "添加应用配置页面", notes = "N")
     @GetMapping("/add")
     public String addAppConfigPage(Model model) {
         setAppModel(model);
@@ -127,7 +127,7 @@ public class AppConfigPageController {
         model.addAttribute("packers", packers);
     }
 
-    @ApiOperation(value = "编辑应用配置页面")
+    @ApiOperation(value = "编辑应用配置页面", notes = "N")
     @GetMapping("/edit/{id}")
     public String editAppConfigPage(@PathVariable("id") AppConfig app, Model model) {
         setAppModel(model);
@@ -135,7 +135,7 @@ public class AppConfigPageController {
         return "/devops/app/config/edit";
     }
 
-    @ApiOperation(value = "拷贝应用配置页面")
+    @ApiOperation(value = "拷贝应用配置页面", notes = "N")
     @GetMapping("/copy/{appId}")
     public String copyAppConfigPage(@PathVariable("appId") String appId, Model model) {
         List<KeyValue> envs = getEnvList();
@@ -153,7 +153,7 @@ public class AppConfigPageController {
         return envs;
     }
 
-    @ApiOperation(value = "应用配置详情页面")
+    @ApiOperation(value = "应用配置详情页面", notes = "N")
     @GetMapping("/detail/{appId}")
     public String appConfigPage(@PathVariable("appId") String appId, Model model) {
         AppConfig app = appBuildQuery.getAppConfig(appId);

+ 4 - 4
mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/page/AppDeployConfigPageController.java

@@ -39,7 +39,7 @@ public class AppDeployConfigPageController {
         this.machineQuery = machineQuery;
     }
 
-    @ApiOperation(value = "部署配置列表页面")
+    @ApiOperation(value = "部署配置列表页面", notes = "N")
     @GetMapping("/{appId}")
     public String deployConfigIndexPage(@PathVariable("appId") String appId, Model model) {
         List<AppDeployConfigVO> list = appDeployQuery.getByAppId(appId).stream()
@@ -51,7 +51,7 @@ public class AppDeployConfigPageController {
         return "/devops/app/deploy/index";
     }
 
-    @ApiOperation(value = "添加部署配置页面")
+    @ApiOperation(value = "添加部署配置页面", notes = "N")
     @GetMapping("/add/{appId}")
     public String addAppConfigPage(@PathVariable("appId") String appId, Model model) {
         AppConfig appConfig = appBuildQuery.getAppConfig(appId);
@@ -63,7 +63,7 @@ public class AppDeployConfigPageController {
         return "/devops/app/deploy/add";
     }
 
-    @ApiOperation(value = "编辑部署配置页面")
+    @ApiOperation(value = "编辑部署配置页面", notes = "N")
     @GetMapping("/edit/{appId}/{machineId}")
     public String editAppConfigPage(@PathVariable("appId") String appId,
                                     @PathVariable("machineId") String machineId,
@@ -73,7 +73,7 @@ public class AppDeployConfigPageController {
         return "/devops/app/deploy/edit";
     }
 
-    @ApiOperation(value = "部署配置详情页面")
+    @ApiOperation(value = "部署配置详情页面", notes = "N")
     @GetMapping("/detail/{appId}/{machineId}")
     public String appConfigPage(@PathVariable("appId") String appId, @PathVariable("machineId") String machineId,
                                 Model model) {

+ 7 - 7
mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/page/BuildDeployPageController.java

@@ -43,7 +43,7 @@ public class BuildDeployPageController {
         this.buildApp = buildApp;
     }
 
-    @ApiOperation(value = "应用构建页面")
+    @ApiOperation(value = "应用构建页面", notes = "N")
     @GetMapping(value = "/build")
     public String index(@RequestParam(value = "env", required = false) String env,
                         @RequestParam(value = "type", required = false) String type,
@@ -71,7 +71,7 @@ public class BuildDeployPageController {
         return "/devops/app/bd/index";
     }
 
-    @ApiOperation(value = "构建任务页面")
+    @ApiOperation(value = "构建任务页面", notes = "N")
     @GetMapping(value = "/task")
     public String buildTaskPage(Model model) {
         List<BuildTask> list = buildApp.getBuildTasks();
@@ -79,7 +79,7 @@ public class BuildDeployPageController {
         return "/devops/app/bd/taskindex";
     }
 
-    @ApiOperation(value = "应用部署页面")
+    @ApiOperation(value = "应用部署页面", notes = "N")
     @GetMapping("/deploy")
     public String deployPage(@RequestParam("appId") String appId,
                              @RequestParam("buildLogId") String buildLogId,
@@ -91,7 +91,7 @@ public class BuildDeployPageController {
         return "/devops/app/bd/deploy";
     }
 
-    @ApiOperation(value = "构建结果页面")
+    @ApiOperation(value = "构建结果页面", notes = "N")
     @GetMapping("/build/result")
     public String buildLogResultPage(@RequestParam("buildLogId") String buildLogId, Model model) {
         String content;
@@ -106,7 +106,7 @@ public class BuildDeployPageController {
         return "/devops/app/bd/log/buildresult";
     }
 
-    @ApiOperation(value = "历史构建页面")
+    @ApiOperation(value = "历史构建页面", notes = "N")
     @GetMapping("/build/history")
     public String buildLogPage(@RequestParam("appId") String appId, Model model) {
         PageRequest pageRequest = PageSort.pageRequest();
@@ -116,7 +116,7 @@ public class BuildDeployPageController {
         return "/devops/app/bd/log/buildlog";
     }
 
-    @ApiOperation(value = "构建配置页面")
+    @ApiOperation(value = "构建配置页面", notes = "N")
     @GetMapping("/build/config")
     public String buildConfigPage(@RequestParam("buildLogId") String buildLogId, Model model) {
         BuildLog buildLog = appBuildQuery.getBuildLog(buildLogId);
@@ -125,7 +125,7 @@ public class BuildDeployPageController {
         return "/devops/app/bd/log/buildconfig";
     }
 
-    @ApiOperation(value = "构建耗时页面")
+    @ApiOperation(value = "构建耗时页面", notes = "N")
     @GetMapping("/build/consumed")
     public String buildTimePage(@RequestParam("buildLogId") String buildLogId, Model model) {
         BuildLog buildLog = appBuildQuery.getBuildLog(buildLogId);

+ 2 - 2
mgr/src/main/java/cn/reghao/devops/mgr/mgr/app/controller/page/StatusPageController.java

@@ -36,7 +36,7 @@ public class StatusPageController {
         this.appDeployQuery = appDeployQuery;
     }
 
-    @ApiOperation(value = "应用运行状态列表页面")
+    @ApiOperation(value = "应用运行状态列表页面", notes = "N")
     @GetMapping
     public String statusPage1(@RequestParam(value = "env", required = false) String env,
                               @RequestParam(value = "appType", required = false) String appType,
@@ -76,7 +76,7 @@ public class StatusPageController {
         return "/devops/app/stat/index1";
     }
 
-    @ApiOperation(value = "应用运行状态详情页面")
+    @ApiOperation(value = "应用运行状态详情页面", notes = "N")
     @GetMapping(value = "/detail/{appId}")
     public String statusPage2(@PathVariable(value = "appId") String appId, Model model) {
         List<AppRunningNode> list = appDeployQuery.getAppRunning(appId);

+ 1 - 1
mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/BuildDirController.java

@@ -25,7 +25,7 @@ public class BuildDirController {
         this.buildDirService = buildDirService;
     }
 
-    @ApiOperation(value = "清空构建目录")
+    @ApiOperation(value = "清空构建目录", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/erase", produces = MediaType.APPLICATION_JSON_VALUE)
     public String emptyBuildDir() {

+ 2 - 2
mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/CompilerConfigController.java

@@ -27,7 +27,7 @@ public class CompilerConfigController {
         this.compilerConfigService = compilerConfigService;
     }
 
-    @ApiOperation(value = "添加/修改应用编译配置")
+    @ApiOperation(value = "添加/修改应用编译配置", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(produces = MediaType.APPLICATION_JSON_VALUE)
     public String addOrUpdateCompileConfig(@Validated CompilerConfig compilerConfig) {
@@ -35,7 +35,7 @@ public class CompilerConfigController {
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "删除应用编译配置")
+    @ApiOperation(value = "删除应用编译配置", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @DeleteMapping(value = "/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deleteCompileConfig(@PathVariable("id") int id) {

+ 2 - 2
mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/DockerRegistryController.java

@@ -26,7 +26,7 @@ public class DockerRegistryController {
         this.dockerRegistryService = dockerRegistryService;
     }
 
-    @ApiOperation(value = "添加/修改 DockerRegistry 配置")
+    @ApiOperation(value = "添加/修改 DockerRegistry 配置", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/registry", produces = MediaType.APPLICATION_JSON_VALUE)
     public String addOrUpdateRepoConfig(@Validated DockerAuth dockerAuth) {
@@ -34,7 +34,7 @@ public class DockerRegistryController {
         return WebResult.success();
     }
 
-    @ApiOperation(value = "删除 DockerRegistry 配置")
+    @ApiOperation(value = "删除 DockerRegistry 配置", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @DeleteMapping(value = "/registry/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deleteRepoConfig(@PathVariable("id") Integer id) {

+ 2 - 2
mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/PackerConfigController.java

@@ -27,7 +27,7 @@ public class PackerConfigController {
         this.packerConfigService = packerConfigService;
     }
 
-    @ApiOperation(value = "添加/修改应用打包配置")
+    @ApiOperation(value = "添加/修改应用打包配置", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(produces = MediaType.APPLICATION_JSON_VALUE)
     public String addOrUpdatePackConfig(@Validated PackerConfig packerConfig) {
@@ -35,7 +35,7 @@ public class PackerConfigController {
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "删除应用打包配置")
+    @ApiOperation(value = "删除应用打包配置", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @DeleteMapping(value = "/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deletePackConfig(@PathVariable("id")  int id) {

+ 2 - 2
mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/RepoAuthConfigController.java

@@ -27,7 +27,7 @@ public class RepoAuthConfigController {
         this.repoAuthConfigService = repoAuthConfigService;
     }
 
-    @ApiOperation(value = "添加/修改仓库认证配置")
+    @ApiOperation(value = "添加/修改仓库认证配置", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(produces = MediaType.APPLICATION_JSON_VALUE)
     public String addOrUpdateRepoConfig(@Validated RepoAuthConfig repoAuth) {
@@ -35,7 +35,7 @@ public class RepoAuthConfigController {
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "删除仓库认证配置")
+    @ApiOperation(value = "删除仓库认证配置", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @DeleteMapping(value = "/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deleteRepoConfig(@PathVariable("id") int id) {

+ 2 - 2
mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/page/BuildDirPageController.java

@@ -32,7 +32,7 @@ public class BuildDirPageController {
         this.buildDirService = buildDirService;
     }
 
-    @ApiOperation(value = "构建目录页面")
+    @ApiOperation(value = "构建目录页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping
     public String buildDirPage(Model model) {
@@ -47,7 +47,7 @@ public class BuildDirPageController {
         return "/devops/build/builddir";
     }
 
-    @ApiOperation(value = "构建目录所在磁盘容量详情页面")
+    @ApiOperation(value = "构建目录所在磁盘容量详情页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/usage")
     public String usagePage(Model model) {

+ 6 - 6
mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/page/CompilerPageController.java

@@ -41,7 +41,7 @@ public class CompilerPageController {
         this.compilerConfigService = compilerConfigService;
     }
 
-    @ApiOperation(value = "编译配置页面")
+    @ApiOperation(value = "编译配置页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping
     public String compilerConfigPage(Model model) {
@@ -53,7 +53,7 @@ public class CompilerPageController {
         return "/devops/build/compiler/index";
     }
 
-    @ApiOperation(value = "编译添加页面")
+    @ApiOperation(value = "编译添加页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/add")
     public String addCompilerPage(Model model) {
@@ -61,7 +61,7 @@ public class CompilerPageController {
         return "/devops/build/compiler/add";
     }
 
-    @ApiOperation(value = "编译更新页面")
+    @ApiOperation(value = "编译更新页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/edit/{id}")
     public String editCompilerPage(@PathVariable("id") CompilerConfig compilerConfig, Model model) {
@@ -79,7 +79,7 @@ public class CompilerPageController {
         model.addAttribute("machineIpv4", Machine.IPV4);
     }
 
-    @ApiOperation(value = "编译详情页面")
+    @ApiOperation(value = "编译详情页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/detail/{id}")
     public String compilerDetailPage(@PathVariable("id") CompilerConfig compilerConfig, Model model) {
@@ -87,7 +87,7 @@ public class CompilerPageController {
         return "/devops/build/compiler/detail";
     }
 
-    @ApiOperation(value = "编译器版本页面")
+    @ApiOperation(value = "编译器版本页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/version/{id}")
     public String compilerVersionPage(@PathVariable("id") int id, Model model) {
@@ -96,7 +96,7 @@ public class CompilerPageController {
         return "/devops/build/compiler/version";
     }
 
-    @ApiOperation(value = "docker 编译器映射目录页面")
+    @ApiOperation(value = "docker 编译器映射目录页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/bind/{id}")
     public String compilerBindPage(@PathVariable("id") int id, Model model) {

+ 4 - 4
mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/page/DockerRegistryPageController.java

@@ -28,7 +28,7 @@ public class DockerRegistryPageController {
         this.dockerAuthRepository = dockerAuthRepository;
     }
 
-    @ApiOperation(value = "DockerRegistry 列表页面")
+    @ApiOperation(value = "DockerRegistry 列表页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/registry")
     public String repoAuthPage(Model model) {
@@ -40,14 +40,14 @@ public class DockerRegistryPageController {
         return "/devops/build/docker/index";
     }
 
-    @ApiOperation(value = "DockerRegistry 添加页面")
+    @ApiOperation(value = "DockerRegistry 添加页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/registry/add")
     public String addRepoAuthPage(Model model) {
         return "/devops/build/docker/add";
     }
 
-    @ApiOperation(value = "DockerRegistry 编辑页面")
+    @ApiOperation(value = "DockerRegistry 编辑页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/registry/edit/{id}")
     public String editRepoAuthPage(@PathVariable("id") DockerRegistry dockerRegistry, Model model) {
@@ -56,7 +56,7 @@ public class DockerRegistryPageController {
         return "/devops/build/docker/edit";
     }
 
-    @ApiOperation(value = "DockerRegistry 详情页面")
+    @ApiOperation(value = "DockerRegistry 详情页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/registry/detail/{id}")
     public String repoAuthDetailPage(@PathVariable("id") DockerRegistry dockerRegistry, Model model) {

+ 4 - 4
mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/page/PackerPageController.java

@@ -40,7 +40,7 @@ public class PackerPageController {
         this.dockerRegistryRepository = dockerRegistryRepository;
     }
 
-    @ApiOperation(value = "打包配置页面")
+    @ApiOperation(value = "打包配置页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping
     public String packerPage(Model model) {
@@ -52,7 +52,7 @@ public class PackerPageController {
         return "/devops/build/packer/index";
     }
 
-    @ApiOperation(value = "打包添加页面")
+    @ApiOperation(value = "打包添加页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/add")
     public String addPackerPage(Model model) {
@@ -70,7 +70,7 @@ public class PackerPageController {
         return "/devops/build/packer/add";
     }
 
-    @ApiOperation(value = "打包更新页面")
+    @ApiOperation(value = "打包更新页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/edit/{id}")
     public String editPackerPage(@PathVariable("id") PackerConfig packerConfig, Model model) {
@@ -88,7 +88,7 @@ public class PackerPageController {
         model.addAttribute("machineIpv4", Machine.IPV4);
     }
 
-    @ApiOperation(value = "打包详情页面")
+    @ApiOperation(value = "打包详情页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/detail/{id}")
     public String packerDetailPage(@PathVariable("id") PackerConfig packerConfig, Model model) {

+ 4 - 4
mgr/src/main/java/cn/reghao/devops/mgr/mgr/builds/controller/page/RepoAuthPageController.java

@@ -36,7 +36,7 @@ public class RepoAuthPageController {
         this.repoAuthConfigRepository = repoAuthConfigRepository;
     }
 
-    @ApiOperation(value = "仓库认证列表页面")
+    @ApiOperation(value = "仓库认证列表页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/repoauth")
     public String repoAuthPage(Model model) {
@@ -48,7 +48,7 @@ public class RepoAuthPageController {
         return "/devops/build/repoauth/index";
     }
 
-    @ApiOperation(value = "仓库认证添加页面")
+    @ApiOperation(value = "仓库认证添加页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/repoauth/add")
     public String addRepoAuthPage(Model model) {
@@ -56,7 +56,7 @@ public class RepoAuthPageController {
         return "/devops/build/repoauth/add";
     }
 
-    @ApiOperation(value = "仓库认证编辑页面")
+    @ApiOperation(value = "仓库认证编辑页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/repoauth/edit/{id}")
     public String editRepoAuthPage(@PathVariable("id") RepoAuthConfig repoAuth, Model model) {
@@ -80,7 +80,7 @@ public class RepoAuthPageController {
         model.addAttribute("auths", auths);
     }
 
-    @ApiOperation(value = "仓库认证详情页面")
+    @ApiOperation(value = "仓库认证详情页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/repoauth/detail/{id}")
     public String repoAuthDetailPage(@PathVariable("id") RepoAuthConfig repoAuth, Model model) {

+ 4 - 4
mgr/src/main/java/cn/reghao/devops/mgr/mgr/log/controller/AppLogController.java

@@ -25,25 +25,25 @@ public class AppLogController {
         this.loggingService = loggingService;
     }
 
-    @ApiOperation(value = "应用实时日志页面")
+    @ApiOperation(value = "应用实时日志页面", notes = "N")
     @GetMapping(value = "/app/log/online")
     public String appLogPage() {
         return "/devops/app/stat/log";
     }
 
-    @ApiOperation(value = "应用历史日志页面")
+    @ApiOperation(value = "应用历史日志页面", notes = "N")
     @GetMapping(value = "/app/log/offline")
     public String appLog() {
         return "/devops/app/stat/log1";
     }
 
-    @ApiOperation(value = "Nginx 日志页面")
+    @ApiOperation(value = "Nginx 日志页面", notes = "N")
     @GetMapping(value = "/app/log/nginx")
     public String nginxLog() {
         return "/devops/app/stat/nginxlog";
     }
 
-    @ApiOperation(value = "Nginx 日志的 echarts 数据")
+    @ApiOperation(value = "Nginx 日志的 echarts 数据", notes = "N")
     @GetMapping(value = "/api/log/nginx/chart", produces = MediaType.APPLICATION_JSON_VALUE)
     @ResponseBody
     public String nginxLogData() throws ParseException {

+ 1 - 1
mgr/src/main/java/cn/reghao/devops/mgr/mgr/machine/controller/ClusterController.java

@@ -23,7 +23,7 @@ public class ClusterController {
         this.keepalivedService = keepalivedService;
     }
 
-    @ApiOperation(value = "设置机器环境")
+    @ApiOperation(value = "keepalived 通知", notes = "N")
     @PostMapping(value = "/notify/keepalived", produces = MediaType.APPLICATION_JSON_VALUE)
     public String notify(@Validated KeepalivedState keepalivedState) {
         keepalivedService.stateNotify(keepalivedState);

+ 4 - 4
mgr/src/main/java/cn/reghao/devops/mgr/mgr/machine/controller/MachineHostController.java

@@ -33,7 +33,7 @@ public class MachineHostController {
         this.machineQuery = machineQuery;
     }
 
-    @ApiOperation(value = "设置机器环境")
+    @ApiOperation(value = "设置机器环境", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/env/{machineId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public ResponseEntity<String> editExtraMachineInfo(@PathVariable("machineId") String machineId,
@@ -42,7 +42,7 @@ public class MachineHostController {
         return ResponseEntity.ok().body(WebResult.success());
     }
 
-    @ApiOperation(value = "编辑 SSH 认证信息")
+    @ApiOperation(value = "编辑 SSH 认证信息", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/sshauth/{machineId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public ResponseEntity<String> editSshAuth(@PathVariable("machineId") String machineId, @Valid SshAuth sshAuth) {
@@ -50,7 +50,7 @@ public class MachineHostController {
         return ResponseEntity.ok().body(WebResult.success());
     }
 
-    @ApiOperation(value = "删除机器")
+    @ApiOperation(value = "删除机器", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @DeleteMapping(value = "/{machineId}", produces = MediaType.APPLICATION_JSON_VALUE)
     public String machine(@PathVariable("machineId") String machineId) {
@@ -62,7 +62,7 @@ public class MachineHostController {
         return WebResult.result(result);
     }
 
-    @ApiOperation(value = "设置机器为弃用状态")
+    @ApiOperation(value = "设置机器为弃用状态", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @PostMapping(value = "/deprecate", produces = MediaType.APPLICATION_JSON_VALUE)
     public String deleteAll(@RequestParam(value = "ids") List<String> machineIds) {

+ 6 - 6
mgr/src/main/java/cn/reghao/devops/mgr/mgr/machine/controller/page/MachineHostPageController.java

@@ -44,7 +44,7 @@ public class MachineHostPageController {
         this.machineQuery = machineQuery;
     }
 
-    @ApiOperation(value = "机器节点页面")
+    @ApiOperation(value = "机器节点页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping
     public String indexPage(@RequestParam(value = "env", required = false) String env,
@@ -69,7 +69,7 @@ public class MachineHostPageController {
         return "/devops/machine/host/index";
     }
 
-    @ApiOperation(value = "使用某机器的应用列表页面")
+    @ApiOperation(value = "使用某机器的应用列表页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/app/{machineId}")
     public String machineAppPage(@PathVariable("machineId") String machineId, Model model) {
@@ -78,7 +78,7 @@ public class MachineHostPageController {
         return "/devops/machine/host/apps";
     }
 
-    @ApiOperation(value = "机器所属环境设置页面")
+    @ApiOperation(value = "机器所属环境设置页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/env/{machineId}")
     public String hostEditPage(@PathVariable("machineId") String machineId, Model model) {
@@ -95,7 +95,7 @@ public class MachineHostPageController {
         return "/devops/machine/host/env";
     }
 
-    @ApiOperation(value = "SSH 认证设置页面")
+    @ApiOperation(value = "SSH 认证设置页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/sshauth/{machineId}")
     public String sshAuthPage(@PathVariable("machineId") String machineId, Model model) {
@@ -118,7 +118,7 @@ public class MachineHostPageController {
         return "/devops/machine/host/sshauth";
     }
 
-    @ApiOperation(value = "SSH 控制台页面")
+    @ApiOperation(value = "SSH 控制台页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/webssh/{machineId}")
     public String webSshPage(@PathVariable("machineId") String machineId, Model model) {
@@ -141,7 +141,7 @@ public class MachineHostPageController {
         return "/devops/machine/host/webssh";
     }
 
-    @ApiOperation(value = "机器信息详情页面")
+    @ApiOperation(value = "机器信息详情页面", notes = "N")
     @PreAuthorize("hasRole('ROLE_ADMIN')")
     @GetMapping("/detail/{machineId}")
     public String getMachineInfo(@PathVariable("machineId") String machineId, Model model) {