test-version22
/
MeterSphere
mirror of https://gitee.com/fit2cloud-feizhiyun/MeterSphere.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

refactor(系统设置): 补充系统组织及组织用户组swagger文档

This commit is contained in:
song-cc-rock 2023-08-28 15:09:10 +08:00 committed by 刘瑞斌
parent 0681c3d224
commit 071045110e
2 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
backend/services/system-setting/src/main/java/io/metersphere/system/controller/OrganizationUserRoleController.java
View File

@ -33,7 +33,7 @@ import java.util.List;
/**
* @author song-cc-rock
*/
@Tag(name = "组织-用户组与权限")
@Tag(name = "系统设置-组织-用户组")
@RestController
@RequestMapping("/user/role/organization")
public class OrganizationUserRoleController {
@ -42,7 +42,7 @@ public class OrganizationUserRoleController {
OrganizationUserRoleService organizationUserRoleService;
@GetMapping("/list/{organizationId}")
@Operation(summary = "获取组织用户组列表")
@Operation(summary = "系统设置-组织-用户组-获取用户组列表")
@Parameter(name = "organizationId", description = "当前组织ID", schema = @Schema(requiredMode = Schema.RequiredMode.REQUIRED))
@RequiresPermissions(PermissionConstants.ORGANIZATION_USER_ROLE_READ)
public List<UserRole> list(@PathVariable String organizationId) {
@ -50,7 +50,7 @@ public class OrganizationUserRoleController {
}
@PostMapping("/add")
@Operation(summary = "添加组织用户组")
@Operation(summary = "系统设置-组织-用户组-添加用户组")
@RequiresPermissions(PermissionConstants.ORGANIZATION_USER_ROLE_READ_ADD)
@Log(type = OperationLogType.ADD, expression = "#msClass.addLog(#request)", msClass = OrganizationUserRoleLogService.class)
public UserRole add(@Validated @RequestBody OrganizationUserRoleEditRequest request) {
@ -61,7 +61,7 @@ public class OrganizationUserRoleController {
}
@PostMapping("/update")
@Operation(summary = "修改组织用户组")
@Operation(summary = "系统设置-组织-用户组-修改用户组")
@RequiresPermissions(PermissionConstants.ORGANIZATION_USER_ROLE_READ_UPDATE)
@Log(type = OperationLogType.UPDATE, expression = "#msClass.updateLog(#request)", msClass = OrganizationUserRoleLogService.class)
public UserRole update(@Validated @RequestBody OrganizationUserRoleEditRequest request) {
@ -71,7 +71,7 @@ public class OrganizationUserRoleController {
}
@GetMapping("/delete/{id}")
@Operation(summary = "删除组织用户组")
@Operation(summary = "系统设置-组织-用户组-删除用户组")
@RequiresPermissions(PermissionConstants.ORGANIZATION_USER_ROLE_READ_DELETE)
@Parameter(name = "id", description = "用户组ID", schema = @Schema(requiredMode = Schema.RequiredMode.REQUIRED))
@Log(type = OperationLogType.DELETE, expression = "#msClass.deleteLog(#id)", msClass = OrganizationUserRoleLogService.class)
@ -80,7 +80,7 @@ public class OrganizationUserRoleController {
}
@GetMapping("/permission/setting/{id}")
@Operation(summary = "获取组织用户组对应的权限配置")
@Operation(summary = "系统设置-组织-用户组-获取用户组对应的权限配置")
@Parameter(name = "id", description = "用户组ID", schema = @Schema(requiredMode = Schema.RequiredMode.REQUIRED))
@RequiresPermissions(PermissionConstants.ORGANIZATION_USER_ROLE_READ)
public List<PermissionDefinitionItem> getPermissionSetting(@PathVariable String id) {
@ -88,7 +88,7 @@ public class OrganizationUserRoleController {
}
@PostMapping("/permission/update")
@Operation(summary = "编辑组织用户组对应的权限配置")
@Operation(summary = "系统设置-组织-用户组-修改用户组对应的权限配置")
@RequiresPermissions(PermissionConstants.ORGANIZATION_USER_ROLE_READ_UPDATE)
@Log(type = OperationLogType.UPDATE, expression = "#msClass.updatePermissionSettingLog(#request)", msClass = OrganizationUserRoleLogService.class)
public void updatePermissionSetting(@Validated @RequestBody PermissionSettingUpdateRequest request) {
@ -96,14 +96,14 @@ public class OrganizationUserRoleController {
}
@GetMapping("/get-member/option/{organizationId}/{roleId}")
@Operation(summary = "获取组织用户组-成员下拉选项")
@Operation(summary = "系统设置-组织-用户组-获取成员下拉选项")
@RequiresPermissions(value = {PermissionConstants.ORGANIZATION_USER_ROLE_READ})
public List<UserExtend> getMember(@PathVariable String organizationId, @PathVariable String roleId) {
return organizationUserRoleService.getMember(organizationId, roleId);
}
@PostMapping("/list-member")
@Operation(summary = "获取组织用户组-成员")
@Operation(summary = "系统设置-组织-用户组-获取成员列表")
@RequiresPermissions(value = {PermissionConstants.ORGANIZATION_USER_ROLE_READ})
public Pager<List<User>> listMember(@Validated @RequestBody OrganizationUserRoleMemberRequest request) {
Page<Object> page = PageHelper.startPage(request.getCurrent(), request.getPageSize());
@ -111,7 +111,7 @@ public class OrganizationUserRoleController {
}
@PostMapping("/add-member")
@Operation(summary = "添加组织用户组成员")
@Operation(summary = "系统设置-组织-用户组-添加用户组成员")
@RequiresPermissions(PermissionConstants.ORGANIZATION_USER_ROLE_READ_UPDATE)
@Log(type = OperationLogType.UPDATE, expression = "#msClass.editMemberLog(#request)", msClass = OrganizationUserRoleLogService.class)
public void addMember(@Validated @RequestBody OrganizationUserRoleMemberEditRequest request) {
@ -119,7 +119,7 @@ public class OrganizationUserRoleController {
}
@PostMapping("/remove-member")
@Operation(summary = "删除组织用户组成员")
@Operation(summary = "系统设置-组织-用户组-删除用户组成员")
@RequiresPermissions(PermissionConstants.ORGANIZATION_USER_ROLE_READ_UPDATE)
@Log(type = OperationLogType.UPDATE, expression = "#msClass.editMemberLog(#request)", msClass = OrganizationUserRoleLogService.class)
public void removeMember(@Validated @RequestBody OrganizationUserRoleMemberEditRequest request) {

20
backend/services/system-setting/src/main/java/io/metersphere/system/controller/SystemOrganizationController.java
View File

@ -35,7 +35,7 @@ import java.util.Map;
/**
* @author song-cc-rock
*/
@Tag(name = "系统-组织")
@Tag(name = "系统设置-系统-组织与项目-组织")
@RestController
@RequestMapping("/system/organization")
public class SystemOrganizationController {
@ -48,7 +48,7 @@ public class SystemOrganizationController {
private OrganizationService organizationService;
@PostMapping("/list")
@Operation(summary = "获取组织列表")
@Operation(summary = "系统设置-系统-组织与项目-组织-获取组织列表")
@RequiresPermissions(PermissionConstants.SYSTEM_ORGANIZATION_PROJECT_READ)
public Pager<List<OrganizationDTO>> list(@Validated @RequestBody OrganizationRequest request) {
Page<Object> page = PageHelper.startPage(request.getCurrent(), request.getPageSize(),
@ -57,14 +57,14 @@ public class SystemOrganizationController {
}
@PostMapping("/option/all")
@Operation(summary = "获取系统所有组织下拉选项")
@Operation(summary = "系统设置-系统-组织与项目-组织-获取系统所有组织下拉选项")
@RequiresPermissions(PermissionConstants.SYSTEM_ORGANIZATION_PROJECT_READ)
public List<OptionDTO> listAll() {
return organizationService.listAll();
}
@PostMapping("/list-member")
@Operation(summary = "获取组织成员")
@Operation(summary = "系统设置-系统-组织与项目-组织-获取组织成员列表")
@RequiresPermissions(value = {PermissionConstants.SYSTEM_ORGANIZATION_PROJECT_READ, PermissionConstants.SYSTEM_USER_READ})
public Pager<List<UserExtend>> listMember(@Validated @RequestBody OrganizationRequest request) {
Page<Object> page = PageHelper.startPage(request.getCurrent(), request.getPageSize(), true);
@ -72,14 +72,14 @@ public class SystemOrganizationController {
}
@PostMapping("/add-member")
@Operation(summary = "添加组织成员")
@Operation(summary = "系统设置-系统-组织与项目-组织-添加组织成员")
@RequiresPermissions(PermissionConstants.SYSTEM_ORGANIZATION_PROJECT_MEMBER_ADD)
public void addMember(@Validated @RequestBody OrganizationMemberRequest request) {
organizationService.addMemberBySystem(request, SessionUtils.getUserId());
}
@GetMapping("/remove-member/{organizationId}/{userId}")
@Operation(summary = "删除组织成员")
@Operation(summary = "系统设置-系统-组织与项目-组织-删除组织成员")
@Parameters({
@Parameter(name = "organizationId", description = "组织ID", schema = @Schema(requiredMode = Schema.RequiredMode.REQUIRED)),
@Parameter(name = "userId", description = "成员ID", schema = @Schema(requiredMode = Schema.RequiredMode.REQUIRED))
@ -90,14 +90,14 @@ public class SystemOrganizationController {
}
@GetMapping("/default")
@Operation(summary = "获取系统默认组织")
@Operation(summary = "系统设置-系统-组织与项目-组织-获取系统默认组织")
@RequiresPermissions(PermissionConstants.SYSTEM_ORGANIZATION_PROJECT_READ)
public OrganizationDTO getDefault() {
return organizationService.getDefault();
}
@PostMapping("/list-project")
@Operation(summary = "获取组织下的项目列表")
@Operation(summary = "系统设置-系统-组织与项目-组织-获取组织下的项目列表")
@RequiresPermissions(PermissionConstants.SYSTEM_ORGANIZATION_PROJECT_READ)
public Pager<List<ProjectDTO>> listProject(@Validated @RequestBody OrganizationProjectRequest request) {
Page<Object> page = PageHelper.startPage(request.getCurrent(), request.getPageSize(),
@ -108,14 +108,14 @@ public class SystemOrganizationController {
}
@GetMapping("/total")
@Operation(summary = "获取组织和项目总数")
@Operation(summary = "系统设置-系统-组织与项目-组织-获取组织和项目总数")
@RequiresPermissions(PermissionConstants.SYSTEM_ORGANIZATION_PROJECT_READ)
public Map<String, Long> getTotal(@RequestParam(value = "organizationId",required = false) String organizationId) {
return organizationService.getTotal(organizationId);
}
@GetMapping("/get-option/{sourceId}")
@Operation(summary = "系统-组织及项目, 获取成员抽屉下拉用户选项")
@Operation(summary = "系统设置-系统-组织与项目-获取成员下拉选项")
@RequiresPermissions(value = {PermissionConstants.SYSTEM_ORGANIZATION_PROJECT_READ})
@Parameter(name = "sourceId", description = "组织ID或项目ID", schema = @Schema(requiredMode = Schema.RequiredMode.REQUIRED))
public List<UserExtend> getMemberOption(@PathVariable String sourceId) {