From 8986299feab1112f9b463114ce66d1d6a413e811 Mon Sep 17 00:00:00 2001 From: gaibu <1016771049@qq.com> Date: Sat, 4 Feb 2023 23:59:25 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E4=BF=AE=E6=94=B9=E5=89=A9=E4=BD=99?= =?UTF-8?q?=E9=83=A8=E5=88=86=20swagger=20=E6=B3=A8=E8=A7=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../yudao/gateway/swagger/SwaggerHandler.java | 108 +++++----- .../gateway/swagger/SwaggerProvider.java | 204 +++++++++--------- .../definition/vo/form/BpmFormBaseVO.java | 4 +- .../vo/form/BpmFormCreateReqVO.java | 6 +- .../definition/vo/form/BpmFormRespVO.java | 4 +- .../vo/form/BpmFormUpdateReqVO.java | 6 +- .../vo/group/BpmUserGroupBaseVO.java | 2 +- .../vo/group/BpmUserGroupCreateReqVO.java | 2 +- .../vo/group/BpmUserGroupRespVO.java | 3 +- .../vo/group/BpmUserGroupUpdateReqVO.java | 2 +- .../vo/model/BpmModeImportReqVO.java | 2 +- .../definition/vo/model/BpmModelBaseVO.java | 12 +- .../vo/model/BpmModelPageItemRespVO.java | 2 +- .../vo/model/BpmModelPageReqVO.java | 6 +- .../vo/model/BpmModelUpdateReqVO.java | 12 +- .../vo/model/BpmModelUpdateStateReqVO.java | 2 +- .../BpmProcessDefinitionListReqVO.java | 2 +- .../BpmProcessDefinitionPageReqVO.java | 2 +- .../process/BpmProcessDefinitionRespVO.java | 20 +- .../admin/oa/vo/BpmOALeaveBaseVO.java | 2 +- .../admin/oa/vo/BpmOALeaveCreateReqVO.java | 4 +- .../admin/oa/vo/BpmOALeavePageReqVO.java | 8 +- .../admin/oa/vo/BpmOALeaveRespVO.java | 4 +- .../admin/task/BpmActivityController.java | 3 +- .../task/vo/activity/BpmActivityRespVO.java | 2 +- .../BpmProcessInstanceMyPageReqVO.java | 6 +- .../BpmProcessInstancePageItemRespVO.java | 6 +- .../vo/instance/BpmProcessInstanceRespVO.java | 24 +-- .../vo/task/BpmTaskDonePageItemRespVO.java | 2 +- .../vo/task/BpmTaskTodoPageItemRespVO.java | 2 +- .../admin/codegen/vo/CodegenDetailRespVO.java | 4 +- .../codegen/vo/CodegenPreviewRespVO.java | 2 +- .../vo/column/CodegenColumnBaseVO.java | 2 +- .../codegen/vo/table/CodegenTableBaseVO.java | 4 +- .../vo/table/CodegenTablePageReqVO.java | 4 +- .../admin/config/vo/ConfigExportReqVO.java | 4 +- .../admin/config/vo/ConfigPageReqVO.java | 4 +- .../admin/config/vo/ConfigRespVO.java | 2 +- .../admin/db/DatabaseDocController.java | 9 +- .../admin/db/vo/DataSourceConfigBaseVO.java | 3 +- .../db/vo/DataSourceConfigCreateReqVO.java | 3 +- .../admin/db/vo/DataSourceConfigRespVO.java | 3 +- .../db/vo/DataSourceConfigUpdateReqVO.java | 3 +- .../file/vo/config/FileConfigCreateReqVO.java | 4 +- .../file/vo/config/FileConfigRespVO.java | 2 +- .../file/vo/config/FileConfigUpdateReqVO.java | 2 +- .../admin/file/vo/file/FilePageReqVO.java | 4 +- .../admin/file/vo/file/FileRespVO.java | 2 +- .../admin/file/vo/file/FileUploadReqVO.java | 2 +- .../vo/apiaccesslog/ApiAccessLogBaseVO.java | 2 +- .../apiaccesslog/ApiAccessLogExportReqVO.java | 6 +- .../apiaccesslog/ApiAccessLogPageReqVO.java | 4 +- .../apierrorlog/ApiErrorLogExportReqVO.java | 2 +- .../admin/redis/vo/RedisKeyValueRespVO.java | 2 +- .../admin/redis/vo/RedisMonitorRespVO.java | 2 +- .../admin/test/TestDemoController.java | 2 +- .../admin/test/vo/TestDemoBaseVO.java | 3 +- .../admin/test/vo/TestDemoCreateReqVO.java | 2 +- .../admin/test/vo/TestDemoExcelVO.java | 2 - .../admin/test/vo/TestDemoExportReqVO.java | 2 +- .../admin/test/vo/TestDemoUpdateReqVO.java | 2 +- .../admin/auth/vo/AuthMenuRespVO.java | 6 +- .../admin/dept/vo/dept/DeptListReqVO.java | 4 +- .../admin/dept/vo/dept/DeptRespVO.java | 2 +- .../admin/dict/vo/data/DictDataBaseVO.java | 4 +- .../admin/dict/vo/type/DictTypeBaseVO.java | 2 +- .../dict/vo/type/DictTypeExportReqVO.java | 6 +- .../admin/dict/vo/type/DictTypePageReqVO.java | 6 +- .../vo/account/MailAccountCreateReqVO.java | 4 +- .../admin/mail/vo/log/MailLogBaseVO.java | 4 +- .../admin/mail/vo/log/MailLogPageReqVO.java | 6 +- .../mail/vo/template/MailTemplateBaseVO.java | 2 +- .../vo/template/MailTemplateCreateReqVO.java | 4 +- .../vo/template/MailTemplatePageReqVO.java | 6 +- .../admin/notice/vo/NoticeBaseVO.java | 2 +- .../admin/notice/vo/NoticeCreateReqVO.java | 4 +- .../admin/notice/vo/NoticePageReqVO.java | 4 +- .../admin/notify/NotifyMessageController.java | 4 +- .../vo/message/NotifyMessageBaseVO.java | 2 +- .../vo/template/NotifyTemplateBaseVO.java | 4 +- .../template/NotifyTemplateCreateReqVO.java | 4 +- .../vo/template/NotifyTemplatePageReqVO.java | 2 +- .../admin/oauth2/OAuth2OpenController.java | 2 +- .../oauth2/vo/client/OAuth2ClientBaseVO.java | 4 +- .../vo/client/OAuth2ClientCreateReqVO.java | 2 +- .../vo/client/OAuth2ClientPageReqVO.java | 6 +- .../vo/open/OAuth2OpenAccessTokenRespVO.java | 4 +- .../open/OAuth2OpenAuthorizeInfoRespVO.java | 2 +- .../vo/open/OAuth2OpenCheckTokenRespVO.java | 4 +- .../vo/token/OAuth2AccessTokenPageReqVO.java | 2 +- .../vo/token/OAuth2AccessTokenRespVO.java | 2 +- .../oauth2/vo/user/OAuth2UserInfoRespVO.java | 2 +- .../oauth2/vo/user/OAuth2UserUpdateReqVO.java | 2 +- .../admin/permission/vo/menu/MenuBaseVO.java | 12 +- .../permission/vo/menu/MenuCreateReqVO.java | 4 +- .../permission/vo/menu/MenuListReqVO.java | 4 +- .../admin/permission/vo/menu/MenuRespVO.java | 2 +- .../permission/vo/menu/MenuSimpleRespVO.java | 2 +- .../PermissionAssignRoleDataScopeReqVO.java | 4 +- .../permission/vo/role/RoleExportReqVO.java | 6 +- .../permission/vo/role/RolePageReqVO.java | 6 +- .../admin/permission/vo/role/RoleRespVO.java | 6 +- .../vo/role/RoleUpdateStatusReqVO.java | 2 +- .../sensitiveword/vo/SensitiveWordBaseVO.java | 8 +- .../vo/SensitiveWordCreateReqVO.java | 4 +- .../sms/vo/channel/SmsChannelCreateReqVO.java | 2 +- .../sms/vo/channel/SmsChannelPageReqVO.java | 2 +- .../sms/vo/channel/SmsChannelRespVO.java | 2 +- .../vo/channel/SmsChannelSimpleRespVO.java | 2 +- .../sms/vo/template/SmsTemplateBaseVO.java | 4 +- .../vo/template/SmsTemplateCreateReqVO.java | 4 +- .../admin/socail/vo/SocialUserBindReqVO.java | 2 +- .../vo/packages/TenantPackageCreateReqVO.java | 4 +- .../vo/packages/TenantPackageUpdateReqVO.java | 3 +- .../admin/user/vo/user/UserBaseVO.java | 2 +- 115 files changed, 367 insertions(+), 392 deletions(-) diff --git a/yudao-gateway/src/main/java/cn/iocoder/yudao/gateway/swagger/SwaggerHandler.java b/yudao-gateway/src/main/java/cn/iocoder/yudao/gateway/swagger/SwaggerHandler.java index 7cae3c810..3b30a4786 100644 --- a/yudao-gateway/src/main/java/cn/iocoder/yudao/gateway/swagger/SwaggerHandler.java +++ b/yudao-gateway/src/main/java/cn/iocoder/yudao/gateway/swagger/SwaggerHandler.java @@ -1,54 +1,54 @@ -package cn.iocoder.yudao.gateway.swagger; - - -import org.springframework.beans.factory.annotation.Autowired; -import org.springframework.http.HttpStatus; -import org.springframework.http.ResponseEntity; -import org.springframework.web.bind.annotation.GetMapping; -import org.springframework.web.bind.annotation.RequestMapping; -import org.springframework.web.bind.annotation.RestController; -import reactor.core.publisher.Mono; -import springfox.documentation.swagger.web.*; - -import javax.annotation.Resource; -import java.util.List; -import java.util.Optional; - -/** - * Swagger Controller - * - * @author zxliu - * @date 2022-10-25 11:24 - */ -@RestController -@RequestMapping("/swagger-resources") -public class SwaggerHandler { - - @Resource - private SwaggerResourcesProvider swaggerResources; - - @SuppressWarnings("SpringJavaAutowiredFieldsWarningInspection") // 只有 @Autowired 可以实现可选注入 - @Autowired(required = false) - private SecurityConfiguration securityConfiguration; - @SuppressWarnings("SpringJavaAutowiredFieldsWarningInspection") // 只有 @Autowired 可以实现可选注入 - @Autowired(required = false) - private UiConfiguration uiConfiguration; - - @GetMapping("") - public Mono>> swaggerResources() { - return Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK))); - } - - @GetMapping("/configuration/security") - public Mono> securityConfiguration() { - return Mono.just(new ResponseEntity<>(Optional.ofNullable(securityConfiguration) - .orElse(SecurityConfigurationBuilder.builder().build()), HttpStatus.OK)); - } - - @GetMapping("/configuration/ui") - public Mono> uiConfiguration() { - return Mono.just(new ResponseEntity<>(Optional.ofNullable(uiConfiguration) - .orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK)); - } - -} +//package cn.iocoder.yudao.gateway.swagger; +// +// +//import org.springframework.beans.factory.annotation.Autowired; +//import org.springframework.http.HttpStatus; +//import org.springframework.http.ResponseEntity; +//import org.springframework.web.bind.annotation.GetMapping; +//import org.springframework.web.bind.annotation.RequestMapping; +//import org.springframework.web.bind.annotation.RestController; +//import reactor.core.publisher.Mono; +//import springfox.documentation.swagger.web.*; +// +//import javax.annotation.Resource; +//import java.util.List; +//import java.util.Optional; +// +///** +// * Swagger Controller +// * +// * @author zxliu +// * @date 2022-10-25 11:24 +// */ +//@RestController +//@RequestMapping("/swagger-resources") +//public class SwaggerHandler { +// +// @Resource +// private SwaggerResourcesProvider swaggerResources; +// +// @SuppressWarnings("SpringJavaAutowiredFieldsWarningInspection") // 只有 @Autowired 可以实现可选注入 +// @Autowired(required = false) +// private SecurityConfiguration securityConfiguration; +// @SuppressWarnings("SpringJavaAutowiredFieldsWarningInspection") // 只有 @Autowired 可以实现可选注入 +// @Autowired(required = false) +// private UiConfiguration uiConfiguration; +// +// @GetMapping("") +// public Mono>> swaggerResources() { +// return Mono.just((new ResponseEntity<>(swaggerResources.get(), HttpStatus.OK))); +// } +// +// @GetMapping("/configuration/security") +// public Mono> securityConfiguration() { +// return Mono.just(new ResponseEntity<>(Optional.ofNullable(securityConfiguration) +// .orElse(SecurityConfigurationBuilder.builder().build()), HttpStatus.OK)); +// } +// +// @GetMapping("/configuration/ui") +// public Mono> uiConfiguration() { +// return Mono.just(new ResponseEntity<>(Optional.ofNullable(uiConfiguration) +// .orElse(UiConfigurationBuilder.builder().build()), HttpStatus.OK)); +// } +// +//} diff --git a/yudao-gateway/src/main/java/cn/iocoder/yudao/gateway/swagger/SwaggerProvider.java b/yudao-gateway/src/main/java/cn/iocoder/yudao/gateway/swagger/SwaggerProvider.java index a67e66d70..8b1cb86a3 100644 --- a/yudao-gateway/src/main/java/cn/iocoder/yudao/gateway/swagger/SwaggerProvider.java +++ b/yudao-gateway/src/main/java/cn/iocoder/yudao/gateway/swagger/SwaggerProvider.java @@ -1,102 +1,102 @@ -package cn.iocoder.yudao.gateway.swagger; - -import cn.hutool.core.collection.CollUtil; -import cn.hutool.core.util.StrUtil; -import lombok.extern.slf4j.Slf4j; -import org.springframework.cloud.gateway.config.GatewayProperties; -import org.springframework.cloud.gateway.handler.predicate.PredicateDefinition; -import org.springframework.cloud.gateway.route.RouteDefinition; -import org.springframework.cloud.gateway.support.NameUtils; -import org.springframework.context.annotation.Primary; -import org.springframework.stereotype.Component; -import springfox.documentation.swagger.web.SwaggerResource; -import springfox.documentation.swagger.web.SwaggerResourcesProvider; - -import javax.annotation.Resource; -import java.util.ArrayList; -import java.util.HashSet; -import java.util.List; -import java.util.Set; - -/** - * Swagger 资源的 Provider 实现类 - * - * @author zxliu - * @date 2022-10-25 11:23 - */ -@Component -@Primary -@Slf4j -public class SwaggerProvider implements SwaggerResourcesProvider { - - @Resource - private GatewayProperties gatewayProperties; - - /** - * 获得 SwaggerResource 列表 - * - * @return SwaggerResource 列表 - */ - @Override - public List get() { - // 将 RouteDefinition 转换成 SwaggerResource - List resources = new ArrayList<>(); - Set serviceNames = new HashSet<>(); // 已处理的服务名，避免重复 - gatewayProperties.getRoutes().forEach(route -> { - // 已存在的服务，直接忽略 - String serviceName = route.getUri().getHost(); - if (StrUtil.isEmpty(serviceName)) { - return; - } - if (!serviceNames.add(serviceName)) { - return; - } - - // 获得 Path PredicateDefinition - String path = getRoutePath(route); - if (path == null) { - return; - } - - // 重要：构建最终的 SwaggerResource 对象 - resources.add(buildSwaggerResource(serviceName, path)); - }); - return resources; - } - - private SwaggerResource buildSwaggerResource(String name, String location) { - SwaggerResource swaggerResource = new SwaggerResource(); - swaggerResource.setName(name); - swaggerResource.setLocation(location); - swaggerResource.setSwaggerVersion("2.0"); - return swaggerResource; - } - - /** - * 获得路由的 Path - * - * ① 输入： - * predicates: - * - Path=/admin-api/system/** - * ② 输出： - * /admin-api/system/v2/api-docs - * - * @param route 路由 - * @return 路由 - */ - private String getRoutePath(RouteDefinition route) { - PredicateDefinition pathDefinition = CollUtil.findOne(route.getPredicates(), - predicateDefinition -> "Path".equals(predicateDefinition.getName())); - if (pathDefinition == null) { - log.info("[get][Route({}) 没有 Path 条件，忽略接口文档]", route.getId()); - return null; - } - String path = pathDefinition.getArgs().get(NameUtils.GENERATED_NAME_PREFIX + "0"); - if (StrUtil.isEmpty(path)) { - log.info("[get][Route({}) Path 的值为空，忽略接口文档]", route.getId()); - return null; - } - return path.replace("/**", "/v2/api-docs"); - } - -} +//package cn.iocoder.yudao.gateway.swagger; +// +//import cn.hutool.core.collection.CollUtil; +//import cn.hutool.core.util.StrUtil; +//import lombok.extern.slf4j.Slf4j; +//import org.springframework.cloud.gateway.config.GatewayProperties; +//import org.springframework.cloud.gateway.handler.predicate.PredicateDefinition; +//import org.springframework.cloud.gateway.route.RouteDefinition; +//import org.springframework.cloud.gateway.support.NameUtils; +//import org.springframework.context.annotation.Primary; +//import org.springframework.stereotype.Component; +//import springfox.documentation.swagger.web.SwaggerResource; +//import springfox.documentation.swagger.web.SwaggerResourcesProvider; +// +//import javax.annotation.Resource; +//import java.util.ArrayList; +//import java.util.HashSet; +//import java.util.List; +//import java.util.Set; +// +///** +// * Swagger 资源的 Provider 实现类 +// * +// * @author zxliu +// * @date 2022-10-25 11:23 +// */ +//@Component +//@Primary +//@Slf4j +//public class SwaggerProvider implements SwaggerResourcesProvider { +// +// @Resource +// private GatewayProperties gatewayProperties; +// +// /** +// * 获得 SwaggerResource 列表 +// * +// * @return SwaggerResource 列表 +// */ +// @Override +// public List get() { +// // 将 RouteDefinition 转换成 SwaggerResource +// List resources = new ArrayList<>(); +// Set serviceNames = new HashSet<>(); // 已处理的服务名，避免重复 +// gatewayProperties.getRoutes().forEach(route -> { +// // 已存在的服务，直接忽略 +// String serviceName = route.getUri().getHost(); +// if (StrUtil.isEmpty(serviceName)) { +// return; +// } +// if (!serviceNames.add(serviceName)) { +// return; +// } +// +// // 获得 Path PredicateDefinition +// String path = getRoutePath(route); +// if (path == null) { +// return; +// } +// +// // 重要：构建最终的 SwaggerResource 对象 +// resources.add(buildSwaggerResource(serviceName, path)); +// }); +// return resources; +// } +// +// private SwaggerResource buildSwaggerResource(String name, String location) { +// SwaggerResource swaggerResource = new SwaggerResource(); +// swaggerResource.setName(name); +// swaggerResource.setLocation(location); +// swaggerResource.setSwaggerVersion("2.0"); +// return swaggerResource; +// } +// +// /** +// * 获得路由的 Path +// * +// * ① 输入： +// * predicates: +// * - Path=/admin-api/system/** +// * ② 输出： +// * /admin-api/system/v2/api-docs +// * +// * @param route 路由 +// * @return 路由 +// */ +// private String getRoutePath(RouteDefinition route) { +// PredicateDefinition pathDefinition = CollUtil.findOne(route.getPredicates(), +// predicateDefinition -> "Path".equals(predicateDefinition.getName())); +// if (pathDefinition == null) { +// log.info("[get][Route({}) 没有 Path 条件，忽略接口文档]", route.getId()); +// return null; +// } +// String path = pathDefinition.getArgs().get(NameUtils.GENERATED_NAME_PREFIX + "0"); +// if (StrUtil.isEmpty(path)) { +// log.info("[get][Route({}) Path 的值为空，忽略接口文档]", route.getId()); +// return null; +// } +// return path.replace("/**", "/v2/api-docs"); +// } +// +//} diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormBaseVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormBaseVO.java index f42a54635..b094ec5a4 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormBaseVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormBaseVO.java @@ -1,7 +1,7 @@ package cn.iocoder.yudao.module.bpm.controller.admin.definition.vo.form; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import io.swagger.annotations.*; import javax.validation.constraints.*; /** @@ -15,7 +15,7 @@ public class BpmFormBaseVO { @NotNull(message = "表单名称不能为空") private String name; - @Schema(description = "表单状态", required = true, notes = "参见 CommonStatusEnum 枚举", example = "1") + @Schema(description = "表单状态,参见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "表单状态不能为空") private Integer status; diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormCreateReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormCreateReqVO.java index 709cc9e84..ade43bc27 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormCreateReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormCreateReqVO.java @@ -1,7 +1,7 @@ package cn.iocoder.yudao.module.bpm.controller.admin.definition.vo.form; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import io.swagger.annotations.*; import javax.validation.constraints.NotNull; import java.util.List; @@ -12,11 +12,11 @@ import java.util.List; @ToString(callSuper = true) public class BpmFormCreateReqVO extends BpmFormBaseVO { - @Schema(description = "表单的配置", required = true, notes = "JSON 字符串") + @Schema(description = "表单的配置,JSON 字符串", required = true) @NotNull(message = "表单的配置不能为空") private String conf; - @Schema(description = "表单项的数组", required = true, notes = "JSON 字符串的数组") + @Schema(description = "表单项的数组,JSON 字符串的数组", required = true) @NotNull(message = "表单项的数组不能为空") private List fields; diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormRespVO.java index a193c64a4..563dde569 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormRespVO.java @@ -19,11 +19,11 @@ public class BpmFormRespVO extends BpmFormBaseVO { @Schema(description = "表单编号", required = true, example = "1024") private Long id; - @Schema(description = "表单的配置", required = true, notes = "JSON 字符串") + @Schema(description = "表单的配置,JSON 字符串", required = true) @NotNull(message = "表单的配置不能为空") private String conf; - @Schema(description = "表单项的数组", required = true, notes = "JSON 字符串的数组") + @Schema(description = "表单项的数组,JSON 字符串的数组", required = true) @NotNull(message = "表单项的数组不能为空") private List fields; diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormUpdateReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormUpdateReqVO.java index b165937ca..1d8d48b46 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormUpdateReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormUpdateReqVO.java @@ -1,7 +1,7 @@ package cn.iocoder.yudao.module.bpm.controller.admin.definition.vo.form; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import io.swagger.annotations.*; import javax.validation.constraints.*; import java.util.List; @@ -15,11 +15,11 @@ public class BpmFormUpdateReqVO extends BpmFormBaseVO { @NotNull(message = "表单编号不能为空") private Long id; - @Schema(description = "表单的配置", required = true, notes = "JSON 字符串") + @Schema(description = "表单的配置,JSON 字符串", required = true) @NotNull(message = "表单的配置不能为空") private String conf; - @Schema(description = "表单项的数组", required = true, notes = "JSON 字符串的数组") + @Schema(description = "表单项的数组,JSON 字符串的数组", required = true) @NotNull(message = "表单项的数组不能为空") private List fields; diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupBaseVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupBaseVO.java index f8fb489cb..92c8e3be1 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupBaseVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupBaseVO.java @@ -1,8 +1,8 @@ package cn.iocoder.yudao.module.bpm.controller.admin.definition.vo.group; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import java.util.*; -import io.swagger.annotations.*; import javax.validation.constraints.*; /** diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupCreateReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupCreateReqVO.java index c28fa6ef2..fbfcbe39d 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupCreateReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupCreateReqVO.java @@ -1,7 +1,7 @@ package cn.iocoder.yudao.module.bpm.controller.admin.definition.vo.group; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import io.swagger.annotations.*; @Schema(description = "管理后台 - 用户组创建 Request VO") @Data diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupRespVO.java index 69fb2627d..607f56727 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupRespVO.java @@ -1,10 +1,9 @@ package cn.iocoder.yudao.module.bpm.controller.admin.definition.vo.group; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import java.time.LocalDateTime; -import java.util.*; -import io.swagger.annotations.*; @Schema(description = "管理后台 - 用户组 Response VO") @Data diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupUpdateReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupUpdateReqVO.java index eae33ff7a..fb011a6d3 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupUpdateReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupUpdateReqVO.java @@ -1,7 +1,7 @@ package cn.iocoder.yudao.module.bpm.controller.admin.definition.vo.group; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import io.swagger.annotations.*; import javax.validation.constraints.*; @Schema(description = "管理后台 - 用户组更新 Request VO") diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModeImportReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModeImportReqVO.java index 11ceb4cc5..acf68a3fb 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModeImportReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModeImportReqVO.java @@ -9,7 +9,7 @@ import org.springframework.web.multipart.MultipartFile; import javax.validation.constraints.NotNull; -@Schema(description = value = "管理后台 - 流程模型的导入 Request VO", description = "相比流程模型的新建来说，只是多了一个 bpmnFile 文件") +@Schema(description = "管理后台 - 流程模型的导入 Request VO,相比流程模型的新建来说，只是多了一个 bpmnFile 文件") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelBaseVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelBaseVO.java index 272a1a75b..803065282 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelBaseVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelBaseVO.java @@ -23,19 +23,17 @@ public class BpmModelBaseVO { @Schema(description = "流程描述", example = "我是描述") private String description; - @Schema(description = "流程分类", notes = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类,参见 bpm_model_category 数据字典", example = "1") @NotEmpty(message = "流程分类不能为空") private String category; - @Schema(description = "表单类型", notes = "参见 bpm_model_form_type 数据字典", example = "1") + @Schema(description = "表单类型,参见 bpm_model_form_type 数据字典", example = "1") private Integer formType; - @Schema(description = "表单编号", example = "1024", notes = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单编号,在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "1024") private Long formId; - @Schema(description = "自定义表单的提交路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/create", - notes = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的提交路径，使用 Vue 的路由地址,在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "/bpm/oa/leave/create") private String formCustomCreatePath; - @Schema(description = "自定义表单的查看路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/view", - notes = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的查看路径，使用 Vue 的路由地址,在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "/bpm/oa/leave/view" ) private String formCustomViewPath; } \ No newline at end of file diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelPageItemRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelPageItemRespVO.java index 3861b6e24..9c543503e 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelPageItemRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelPageItemRespVO.java @@ -41,7 +41,7 @@ public class BpmModelPageItemRespVO extends BpmModelBaseVO { @Schema(description = "部署时间", required = true) private LocalDateTime deploymentTime; - @Schema(description = "中断状态", required = true, example = "1", notes = "参见 SuspensionState 枚举") + @Schema(description = "中断状态,参见 SuspensionState 枚举", required = true, example = "1") private Integer suspensionState; } diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelPageReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelPageReqVO.java index b901f9cc7..9e9bbde5a 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelPageReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelPageReqVO.java @@ -14,13 +14,13 @@ import lombok.ToString; @ToString(callSuper = true) public class BpmModelPageReqVO extends PageParam { - @Schema(description = "标识", example = "process1641042089407", notes = "精准匹配") + @Schema(description = "标识,精准匹配", example = "process1641042089407") private String key; - @Schema(description = "名字", example = "芋道", notes = "模糊匹配") + @Schema(description = "名字,精准匹配", example = "芋道") private String name; - @Schema(description = "流程分类", notes = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类,参见 bpm_model_category 数据字典", example = "1") private String category; } \ No newline at end of file diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelUpdateReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelUpdateReqVO.java index 0a4029c5f..bf20f225e 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelUpdateReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelUpdateReqVO.java @@ -20,21 +20,19 @@ public class BpmModelUpdateReqVO { @Schema(description = "流程描述", example = "我是描述") private String description; - @Schema(description = "流程分类", notes = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类,参见 bpm_model_category 数据字典", example = "1") private String category; @Schema(description = "BPMN XML", required = true) private String bpmnXml; - @Schema(description = "表单类型", notes = "参见 bpm_model_form_type 数据字典", example = "1") + @Schema(description = "表单类型,参见 bpm_model_form_type 数据字典", example = "1") private Integer formType; - @Schema(description = "表单编号", example = "1024", notes = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单编号,在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "1024") private Long formId; - @Schema(description = "自定义表单的提交路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/create", - notes = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的提交路径，使用 Vue 的路由地址,在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "/bpm/oa/leave/create") private String formCustomCreatePath; - @Schema(description = "自定义表单的查看路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/view", - notes = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的查看路径，使用 Vue 的路由地址,在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "/bpm/oa/leave/view" ) private String formCustomViewPath; } \ No newline at end of file diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelUpdateStateReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelUpdateStateReqVO.java index 81ed1160a..bc5632f3f 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelUpdateStateReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelUpdateStateReqVO.java @@ -14,7 +14,7 @@ public class BpmModelUpdateStateReqVO { @NotNull(message = "编号不能为空") private String id; - @Schema(description = "状态", required = true, example = "1", notes = "见 SuspensionState 枚举") + @Schema(description = "状态,见 SuspensionState 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer state; diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionListReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionListReqVO.java index ef5d90d3f..1a1230adb 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionListReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionListReqVO.java @@ -13,7 +13,7 @@ import lombok.ToString; @EqualsAndHashCode(callSuper = true) public class BpmProcessDefinitionListReqVO extends PageParam { - @Schema(description = "中断状态", example = "1", notes = "参见 SuspensionState 枚举") + @Schema(description = "中断状态,参见 SuspensionState 枚举", example = "1") private Integer suspensionState; } \ No newline at end of file diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionPageReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionPageReqVO.java index e01ec4746..e197e83cc 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionPageReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionPageReqVO.java @@ -13,7 +13,7 @@ import lombok.ToString; @EqualsAndHashCode(callSuper = true) public class BpmProcessDefinitionPageReqVO extends PageParam { - @Schema(description = "标识", example = "process1641042089407", notes = "精准匹配") + @Schema(description = "标识,精准匹配", example = "process1641042089407") private String key; } \ No newline at end of file diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionRespVO.java index 6c51e40d2..84b183627 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionRespVO.java @@ -25,28 +25,24 @@ public class BpmProcessDefinitionRespVO { @Schema(description = "流程描述", example = "我是描述") private String description; - @Schema(description = "流程分类", notes = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类,参见 bpm_model_category 数据字典", example = "1") @NotEmpty(message = "流程分类不能为空") private String category; - @Schema(description = "表单类型", notes = "参见 bpm_model_form_type 数据字典", example = "1") + @Schema(description = "表单类型,参见 bpm_model_form_type 数据字典", example = "1") private Integer formType; - @Schema(description = "表单编号", example = "1024", notes = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单编号,在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "1024") private Long formId; - @Schema(description = "表单的配置", required = true, - notes = "JSON 字符串。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单的配置,JSON 字符串。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", required = true ) private String formConf; - @Schema(description = "表单项的数组", required = true, - notes = "JSON 字符串的数组。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单项的数组,JSON 字符串的数组。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", required = true ) private List formFields; - @Schema(description = "自定义表单的提交路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/create", - notes = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的提交路径，使用 Vue 的路由地址,在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "/bpm/oa/leave/create" ) private String formCustomCreatePath; - @Schema(description = "自定义表单的查看路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/view", - notes = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的查看路径，使用 Vue 的路由地址,在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "/bpm/oa/leave/view") private String formCustomViewPath; - @Schema(description = "中断状态", required = true, example = "1", notes = "参见 SuspensionState 枚举") + @Schema(description = "中断状态,参见 SuspensionState 枚举", required = true, example = "1") private Integer suspensionState; } \ No newline at end of file diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeaveBaseVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeaveBaseVO.java index ec84b3794..e33884bba 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeaveBaseVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeaveBaseVO.java @@ -25,7 +25,7 @@ public class BpmOALeaveBaseVO { @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime endTime; - @Schema(description = "请假类型", required = true, example = "1", notes = "参见 bpm_oa_type 枚举") + @Schema(description = "请假类型,参见 bpm_oa_type 枚举", required = true, example = "1") private Integer type; @Schema(description = "原因", required = true, example = "阅读芋道源码") diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeaveCreateReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeaveCreateReqVO.java index 5230e2722..39ce08021 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeaveCreateReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeaveCreateReqVO.java @@ -1,13 +1,13 @@ package cn.iocoder.yudao.module.bpm.controller.admin.oa.vo; -import io.swagger.annotations.ApiModel; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; import javax.validation.constraints.AssertTrue; -@ApiModel("管理后台 - 请假申请创建 Request VO") +@Schema(description = "管理后台 - 请假申请创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeavePageReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeavePageReqVO.java index 98ac0cd22..88eb1c62f 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeavePageReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeavePageReqVO.java @@ -1,8 +1,8 @@ package cn.iocoder.yudao.module.bpm.controller.admin.oa.vo; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import java.util.*; -import io.swagger.annotations.*; import cn.iocoder.yudao.framework.common.pojo.PageParam; import org.springframework.format.annotation.DateTimeFormat; @@ -14,13 +14,13 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @ToString(callSuper = true) public class BpmOALeavePageReqVO extends PageParam { - @Schema(description = "状态", example = "1", notes = "参见 bpm_process_instance_result 枚举") + @Schema(description = "状态,参见 bpm_process_instance_result 枚举", example = "1") private Integer result; - @Schema(description = "请假类型", example = "1", notes = "参见 bpm_oa_type") + @Schema(description = "请假类型,参见 bpm_oa_type", example = "1") private Integer type; - @Schema(description = "原因", example = "阅读芋道源码", notes = "模糊匹配") + @Schema(description = "原因,模糊匹配", example = "阅读芋道源码") private String reason; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeaveRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeaveRespVO.java index 1da373aa8..cf18e25ad 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeaveRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/oa/vo/BpmOALeaveRespVO.java @@ -1,7 +1,7 @@ package cn.iocoder.yudao.module.bpm.controller.admin.oa.vo; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import io.swagger.annotations.*; import org.springframework.format.annotation.DateTimeFormat; import javax.validation.constraints.NotNull; @@ -18,7 +18,7 @@ public class BpmOALeaveRespVO extends BpmOALeaveBaseVO { @Schema(description = "请假表单主键", required = true, example = "1024") private Long id; - @Schema(description = "状态", required = true, example = "1", notes = "参见 bpm_process_instance_result 枚举") + @Schema(description = "状态,参见 bpm_process_instance_result 枚举", required = true, example = "1") private Integer result; @Schema(description = "申请时间", required = true) diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/BpmActivityController.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/BpmActivityController.java index 718327eb8..966a920f3 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/BpmActivityController.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/BpmActivityController.java @@ -28,8 +28,7 @@ public class BpmActivityController { private BpmActivityService activityService; @GetMapping("/list") - @Operation(summary = "生成指定流程实例的高亮流程图", - notes = "只高亮进行中的任务。不过要注意，该接口暂时没用，通过前端的 ProcessViewer.vue 界面的 highlightDiagram 方法生成") + @Operation(summary = "生成指定流程实例的高亮流程图,只高亮进行中的任务。不过要注意，该接口暂时没用，通过前端的 ProcessViewer.vue 界面的 highlightDiagram 方法生成") @Parameter(name = "processInstanceId", description = "流程实例的编号", required = true) @PreAuthorize("@ss.hasPermission('bpm:task:query')") public CommonResult> getActivityList( diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/activity/BpmActivityRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/activity/BpmActivityRespVO.java index a8fe5b7e1..f96dae69b 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/activity/BpmActivityRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/activity/BpmActivityRespVO.java @@ -20,7 +20,7 @@ public class BpmActivityRespVO { @Schema(description = "流程活动的结束时间", required = true) private LocalDateTime endTime; - @Schema(description = "关联的流程任务的编号", example = "2048", notes = "关联的流程任务，只有 UserTask 等类型才有") + @Schema(description = "关联的流程任务的编号,关联的流程任务，只有 UserTask 等类型才有", example = "2048") private String taskId; } \ No newline at end of file diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceMyPageReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceMyPageReqVO.java index c20f5d24b..13bd28c6d 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceMyPageReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceMyPageReqVO.java @@ -24,13 +24,13 @@ public class BpmProcessInstanceMyPageReqVO extends PageParam { @Schema(description = "流程定义的编号", example = "2048") private String processDefinitionId; - @Schema(description = "流程实例的状态", notes = "参见 bpm_process_instance_status", example = "1") + @Schema(description = "流程实例的状态,参见 bpm_process_instance_status", example = "1") private Integer status; - @Schema(description = "流程实例的结果", notes = "参见 bpm_process_instance_result", example = "2") + @Schema(description = "流程实例的结果,参见 bpm_process_instance_result", example = "2") private Integer result; - @Schema(description = "流程分类", notes = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类,参见 bpm_model_category 数据字典", example = "1") private String category; @Schema(description = "创建时间") diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstancePageItemRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstancePageItemRespVO.java index 1d3f54988..5ddf82151 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstancePageItemRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstancePageItemRespVO.java @@ -20,13 +20,13 @@ public class BpmProcessInstancePageItemRespVO { @Schema(description = "流程定义的编号", required = true, example = "2048") private String processDefinitionId; - @Schema(description = "流程分类", required = true, notes = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类,参见 bpm_model_category 数据字典", required = true, example = "1") private String category; - @Schema(description = "流程实例的状态", required = true, notes = "参见 bpm_process_instance_status", example = "1") + @Schema(description = "流程实例的状态,参见 bpm_process_instance_status", required = true, example = "1") private Integer status; - @Schema(description = "流程实例的结果", required = true, notes = "参见 bpm_process_instance_result", example = "2") + @Schema(description = "流程实例的结果,参见 bpm_process_instance_result", required = true, example = "2") private Integer result; @Schema(description = "提交时间", required = true) diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceRespVO.java index 9399da53c..526f90818 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceRespVO.java @@ -18,13 +18,13 @@ public class BpmProcessInstanceRespVO { @Schema(description = "流程名称", required = true, example = "芋道") private String name; - @Schema(description = "流程分类", required = true, notes = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类,参见 bpm_model_category 数据字典", required = true, example = "1") private String category; - @Schema(description = "流程实例的状态", required = true, notes = "参见 bpm_process_instance_status", example = "1") + @Schema(description = "流程实例的状态,参见 bpm_process_instance_status", required = true, example = "1") private Integer status; - @Schema(description = "流程实例的结果", required = true, notes = "参见 bpm_process_instance_result", example = "2") + @Schema(description = "流程实例的结果,参见 bpm_process_instance_result", required = true, example = "2") private Integer result; @Schema(description = "提交时间", required = true) @@ -36,7 +36,7 @@ public class BpmProcessInstanceRespVO { @Schema(description = "提交的表单值", required = true) private Map formVariables; - @Schema(description = "业务的唯一标识", example = "1", notes = "例如说，请假申请的编号") + @Schema(description = "业务的唯一标识,例如说，请假申请的编号", example = "1") private String businessKey; /** @@ -72,21 +72,17 @@ public class BpmProcessInstanceRespVO { @Schema(description = "编号", required = true, example = "1024") private String id; - @Schema(description = "表单类型", notes = "参见 bpm_model_form_type 数据字典", example = "1") + @Schema(description = "表单类型,参见 bpm_model_form_type 数据字典", example = "1") private Integer formType; - @Schema(description = "表单编号", example = "1024", notes = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单编号,在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "1024") private Long formId; - @Schema(description = "表单的配置", required = true, - notes = "JSON 字符串。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单的配置,JSON 字符串。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", required = true) private String formConf; - @Schema(description = "表单项的数组", required = true, - notes = "JSON 字符串的数组。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单项的数组,JSON 字符串的数组。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", required = true) private List formFields; - @Schema(description = "自定义表单的提交路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/create", - notes = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的提交路径，使用 Vue 的路由地址,在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "/bpm/oa/leave/create") private String formCustomCreatePath; - @Schema(description = "自定义表单的查看路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/view", - notes = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的查看路径，使用 Vue 的路由地址,在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "/bpm/oa/leave/view") private String formCustomViewPath; @Schema(description = "BPMN XML", required = true) diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskDonePageItemRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskDonePageItemRespVO.java index b75d6d86f..cb78d1988 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskDonePageItemRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskDonePageItemRespVO.java @@ -19,7 +19,7 @@ public class BpmTaskDonePageItemRespVO extends BpmTaskTodoPageItemRespVO { @Schema(description = "持续时间", required = true, example = "1000") private Long durationInMillis; - @Schema(description = "任务结果", required = true, notes = "参见 bpm_process_instance_result", example = "2") + @Schema(description = "任务结果,参见 bpm_process_instance_result", required = true, example = "2") private Integer result; @Schema(description = "审批建议", required = true, example = "不请假了！") private String reason; diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskTodoPageItemRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskTodoPageItemRespVO.java index ed5db34bc..811db66e7 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskTodoPageItemRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskTodoPageItemRespVO.java @@ -22,7 +22,7 @@ public class BpmTaskTodoPageItemRespVO { @Schema(description = "创建时间", required = true) private LocalDateTime createTime; - @Schema(description = "激活状态", required = true, example = "1", notes = "参见 SuspensionState 枚举") + @Schema(description = "激活状态,参见 SuspensionState 枚举", required = true, example = "1") private Integer suspensionState; /** diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenDetailRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenDetailRespVO.java index fd2220c3c..35922c14b 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenDetailRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenDetailRespVO.java @@ -12,10 +12,10 @@ import java.util.List; @Data public class CodegenDetailRespVO { - @ApiModelProperty("表定义") + @Schema(description = "表定义") private CodegenTableRespVO table; - @ApiModelProperty("字段定义") + @Schema(description = "字段定义") private List columns; } \ No newline at end of file diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenPreviewRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenPreviewRespVO.java index fb1b3134e..2997bcd11 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenPreviewRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenPreviewRespVO.java @@ -4,7 +4,7 @@ import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(description = value = "管理后台 - 代码生成预览 Response VO", description ="注意，每个文件都是一个该对象") +@Schema(description = "管理后台 - 代码生成预览 Response VO，注意，每个文件都是一个该对象") @Data public class CodegenPreviewRespVO { diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/column/CodegenColumnBaseVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/column/CodegenColumnBaseVO.java index 348e1af5a..0fdbc1a7a 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/column/CodegenColumnBaseVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/column/CodegenColumnBaseVO.java @@ -70,7 +70,7 @@ public class CodegenColumnBaseVO { @NotNull(message = "是否为 List 查询操作的字段不能为空") private Boolean listOperation; - @Schema(description = "List 查询操作的条件类型", required = true, example = "LIKE", notes = "参见 CodegenColumnListConditionEnum 枚举") + @Schema(description = "List 查询操作的条件类型,参见 CodegenColumnListConditionEnum 枚举", required = true, example = "LIKE") @NotNull(message = "List 查询操作的条件类型不能为空") private String listOperationCondition; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/CodegenTableBaseVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/CodegenTableBaseVO.java index d58deb2d9..4c05c10f2 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/CodegenTableBaseVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/CodegenTableBaseVO.java @@ -12,7 +12,7 @@ import javax.validation.constraints.NotNull; @Data public class CodegenTableBaseVO { - @Schema(description = "生成场景", required = true, example = "1", notes = "参见 CodegenSceneEnum 枚举") + @Schema(description = "生成场景，参见 CodegenSceneEnum 枚举", required = true, example = "1") @NotNull(message = "导入类型不能为空") private Integer scene; @@ -47,7 +47,7 @@ public class CodegenTableBaseVO { @NotNull(message = "作者不能为空") private String author; - @Schema(description = "模板类型", required = true, example = "1", notes = "参见 CodegenTemplateTypeEnum 枚举") + @Schema(description = "模板类型，参见 CodegenTemplateTypeEnum 枚举", required = true, example = "1") @NotNull(message = "模板类型不能为空") private Integer templateType; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/CodegenTablePageReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/CodegenTablePageReqVO.java index eed1daeb9..290f80e44 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/CodegenTablePageReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/CodegenTablePageReqVO.java @@ -18,10 +18,10 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @ToString(callSuper = true) public class CodegenTablePageReqVO extends PageParam { - @Schema(description = "表名称", example = "yudao", notes = "模糊匹配") + @Schema(description = "表名称,模糊匹配", example = "yudao") private String tableName; - @Schema(description = "表描述", example = "芋道", notes = "模糊匹配") + @Schema(description = "表描述,模糊匹配", example = "芋道") private String tableComment; @Schema(description = "创建时间", example = "[2022-07-01 00:00:00, 2022-07-01 23:59:59]") diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigExportReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigExportReqVO.java index 4782d7da3..e959346c7 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigExportReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigExportReqVO.java @@ -16,10 +16,10 @@ public class ConfigExportReqVO { @Schema(description = "参数名称", example = "模糊匹配") private String name; - @Schema(description = "参数键名", example = "yunai.db.username", notes = "模糊匹配") + @Schema(description = "参数键名,模糊匹配", example = "yunai.db.username") private String key; - @Schema(description = "参数类型", example = "1", notes = "参见 SysConfigTypeEnum 枚举") + @Schema(description = "参数类型,参见 SysConfigTypeEnum 枚举", example = "1") private Integer type; @Schema(description = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigPageReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigPageReqVO.java index ff2653fc3..3219fc633 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigPageReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigPageReqVO.java @@ -21,10 +21,10 @@ public class ConfigPageReqVO extends PageParam { @Schema(description = "数据源名称", example = "模糊匹配") private String name; - @Schema(description = "参数键名", example = "yunai.db.username", notes = "模糊匹配") + @Schema(description = "参数键名,模糊匹配", example = "yunai.db.username") private String key; - @Schema(description = "参数类型", example = "1", notes = "参见 SysConfigTypeEnum 枚举") + @Schema(description = "参数类型,参见 SysConfigTypeEnum 枚举", example = "1") private Integer type; @Schema(description = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigRespVO.java index 02f44f57f..cbb289e5b 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigRespVO.java @@ -22,7 +22,7 @@ public class ConfigRespVO extends ConfigBaseVO { @Size(max = 100, message = "参数键名长度不能超过100个字符") private String key; - @Schema(description = "参数类型", required = true, example = "1", notes = "参见 SysConfigTypeEnum 枚举") + @Schema(description = "参数类型,参见 SysConfigTypeEnum 枚举", required = true, example = "1") private Integer type; @Schema(description = "创建时间", required = true, example = "时间戳格式") diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/DatabaseDocController.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/DatabaseDocController.java index 09a3eba59..8a44df1df 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/DatabaseDocController.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/DatabaseDocController.java @@ -43,8 +43,7 @@ public class DatabaseDocController { @GetMapping("/export-html") @Operation(summary = "导出 html 格式的数据文档") - @Parameter(name = "deleteFile", description = "是否删除在服务器本地生成的数据库文档", example = "true", - dataTypeClass = Boolean.class) + @Parameter(name = "deleteFile", description = "是否删除在服务器本地生成的数据库文档", example = "true") public void exportHtml(@RequestParam(defaultValue = "true") Boolean deleteFile, HttpServletResponse response) throws IOException { doExportFile(EngineFileType.HTML, deleteFile, response); @@ -52,8 +51,7 @@ public class DatabaseDocController { @GetMapping("/export-word") @Operation(summary = "导出 word 格式的数据文档") - @Parameter(name = "deleteFile", description = "是否删除在服务器本地生成的数据库文档", example = "true", - dataTypeClass = Boolean.class) + @Parameter(name = "deleteFile", description = "是否删除在服务器本地生成的数据库文档", example = "true") public void exportWord(@RequestParam(defaultValue = "true") Boolean deleteFile, HttpServletResponse response) throws IOException { doExportFile(EngineFileType.WORD, deleteFile, response); @@ -61,8 +59,7 @@ public class DatabaseDocController { @GetMapping("/export-markdown") @Operation(summary = "导出 markdown 格式的数据文档") - @Parameter(name = "deleteFile", description = "是否删除在服务器本地生成的数据库文档", example = "true", - dataTypeClass = Boolean.class) + @Parameter(name = "deleteFile", description = "是否删除在服务器本地生成的数据库文档", example = "true") public void exportMarkdown(@RequestParam(defaultValue = "true") Boolean deleteFile, HttpServletResponse response) throws IOException { doExportFile(EngineFileType.MD, deleteFile, response); diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigBaseVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigBaseVO.java index f16dbe9d8..ff410ce65 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigBaseVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigBaseVO.java @@ -1,8 +1,7 @@ package cn.iocoder.yudao.module.infra.controller.admin.db.vo; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import java.util.*; -import io.swagger.annotations.*; import javax.validation.constraints.*; /** diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigCreateReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigCreateReqVO.java index 4d1ea2394..b67797baf 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigCreateReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigCreateReqVO.java @@ -1,8 +1,7 @@ package cn.iocoder.yudao.module.infra.controller.admin.db.vo; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import java.util.*; -import io.swagger.annotations.*; import javax.validation.constraints.*; @Schema(description = "管理后台 - 数据源配置创建 Request VO") diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigRespVO.java index 36f656863..4002d4f06 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigRespVO.java @@ -1,10 +1,9 @@ package cn.iocoder.yudao.module.infra.controller.admin.db.vo; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import java.time.LocalDateTime; -import java.util.*; -import io.swagger.annotations.*; @Schema(description = "管理后台 - 数据源配置 Response VO") @Data diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigUpdateReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigUpdateReqVO.java index 4808a4552..6bf318e9a 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigUpdateReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/db/vo/DataSourceConfigUpdateReqVO.java @@ -1,8 +1,7 @@ package cn.iocoder.yudao.module.infra.controller.admin.db.vo; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import java.util.*; -import io.swagger.annotations.*; import javax.validation.constraints.*; @Schema(description = "管理后台 - 数据源配置更新 Request VO") diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigCreateReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigCreateReqVO.java index e097ce862..1830f23a4 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigCreateReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigCreateReqVO.java @@ -15,11 +15,11 @@ import java.util.Map; @ToString(callSuper = true) public class FileConfigCreateReqVO extends FileConfigBaseVO { - @Schema(description = "存储器", required = true, example = "1", notes = "参见 FileStorageEnum 枚举类") + @Schema(description = "存储器,参见 FileStorageEnum 枚举类", required = true, example = "1") @NotNull(message = "存储器不能为空") private Integer storage; - @Schema(description = "存储配置", required = true, notes = "配置是动态参数，所以使用 Map 接收") + @Schema(description = "存储配置,配置是动态参数，所以使用 Map 接收", required = true) @NotNull(message = "存储配置不能为空") private Map config; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigRespVO.java index db92744d8..ac0834bbd 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigRespVO.java @@ -19,7 +19,7 @@ public class FileConfigRespVO extends FileConfigBaseVO { @Schema(description = "编号", required = true, example = "1") private Long id; - @Schema(description = "存储器", required = true, example = "1", notes = "参见 FileStorageEnum 枚举类") + @Schema(description = "存储器,参见 FileStorageEnum 枚举类", required = true, example = "1") @NotNull(message = "存储器不能为空") private Integer storage; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigUpdateReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigUpdateReqVO.java index 061bc4db5..5b5fe2224 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigUpdateReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigUpdateReqVO.java @@ -19,7 +19,7 @@ public class FileConfigUpdateReqVO extends FileConfigBaseVO { @NotNull(message = "编号不能为空") private Long id; - @Schema(description = "存储配置", required = true, notes = "配置是动态参数，所以使用 Map 接收") + @Schema(description = "存储配置,配置是动态参数，所以使用 Map 接收", required = true) @NotNull(message = "存储配置不能为空") private Map config; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/file/FilePageReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/file/FilePageReqVO.java index 6e0aa90c8..2c240d4a4 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/file/FilePageReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/file/FilePageReqVO.java @@ -18,10 +18,10 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @ToString(callSuper = true) public class FilePageReqVO extends PageParam { - @Schema(description = "文件路径", example = "yudao", notes = "模糊匹配") + @Schema(description = "文件路径,模糊匹配", example = "yudao") private String path; - @Schema(description = "文件类型", example = "jpg", notes = "模糊匹配") + @Schema(description = "文件类型,模糊匹配", example = "jpg") private String type; @Schema(description = "创建时间", example = "[2022-07-01 00:00:00, 2022-07-01 23:59:59]") diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/file/FileRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/file/FileRespVO.java index d54476640..a8344ee21 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/file/FileRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/file/FileRespVO.java @@ -6,7 +6,7 @@ import lombok.Data; import java.time.LocalDateTime; -@Schema(description = value = "管理后台 - 文件 Response VO", description = "不返回 content 字段，太大") +@Schema(description = "管理后台 - 文件 Response VO,不返回 content 字段，太大" ) @Data public class FileRespVO { diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/file/FileUploadReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/file/FileUploadReqVO.java index 412a6ef82..83d38c81e 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/file/FileUploadReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/file/FileUploadReqVO.java @@ -7,7 +7,7 @@ import org.springframework.web.multipart.MultipartFile; import javax.validation.constraints.NotNull; -@Schema(description = value = "管理后台 - 上传文件 Request VO") +@Schema(description = "管理后台 - 上传文件 Request VO") @Data public class FileUploadReqVO { diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogBaseVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogBaseVO.java index cf62d004e..94e17c9af 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogBaseVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogBaseVO.java @@ -24,7 +24,7 @@ public class ApiAccessLogBaseVO { @NotNull(message = "用户编号不能为空") private Long userId; - @Schema(description = "用户类型", required = true, example = "2", notes = "参见 UserTypeEnum 枚举") + @Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2") @NotNull(message = "用户类型不能为空") private Integer userType; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogExportReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogExportReqVO.java index 2ab42340f..82ae47ef8 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogExportReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogExportReqVO.java @@ -9,7 +9,7 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(description = value = "管理后台 - API 访问日志 Excel 导出 Request VO", description = "参数和 ApiAccessLogPageReqVO 是一致的") +@Schema(description = "管理后台 - API 访问日志 Excel 导出 Request VO,参数和 ApiAccessLogPageReqVO 是一致的") @Data public class ApiAccessLogExportReqVO { @@ -22,14 +22,14 @@ public class ApiAccessLogExportReqVO { @Schema(description = "应用名", example = "dashboard") private String applicationName; - @Schema(description = "请求地址", example = "/xxx/yyy", notes = "模糊匹配") + @Schema(description = "请求地址,模糊匹配", example = "/xxx/yyy") private String requestUrl; @Schema(description = "开始时间", example = "[2022-07-01 00:00:00, 2022-07-01 23:59:59]") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime[] beginTime; - @Schema(description = "执行时长", example = "100", notes = "大于等于，单位：毫秒") + @Schema(description = "执行时长,大于等于，单位：毫秒", example = "100") private Integer duration; @Schema(description = "结果码", example = "0") diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogPageReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogPageReqVO.java index 3e660ff5d..31ca93e77 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogPageReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogPageReqVO.java @@ -27,14 +27,14 @@ public class ApiAccessLogPageReqVO extends PageParam { @Schema(description = "应用名", example = "dashboard") private String applicationName; - @Schema(description = "请求地址", example = "/xxx/yyy", notes = "模糊匹配") + @Schema(description = "请求地址,模糊匹配", example = "/xxx/yyy") private String requestUrl; @Schema(description = "开始时间", example = "[2022-07-01 00:00:00, 2022-07-01 23:59:59]") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime[] beginTime; - @Schema(description = "执行时长", example = "100", notes = "大于等于，单位：毫秒") + @Schema(description = "执行时长,大于等于，单位：毫秒", example = "100") private Integer duration; @Schema(description = "结果码", example = "0") diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogExportReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogExportReqVO.java index 8050126e4..c618d2f5c 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogExportReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogExportReqVO.java @@ -9,7 +9,7 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(description = value = "管理后台 - API 错误日志 Excel 导出 Request VO", description = "参数和 ApiErrorLogPageReqVO 是一致的") +@Schema(description = "管理后台 - API 错误日志 Excel 导出 Request VO,参数和 ApiErrorLogPageReqVO 是一致的") @Data public class ApiErrorLogExportReqVO { diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/redis/vo/RedisKeyValueRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/redis/vo/RedisKeyValueRespVO.java index 23a193e85..52075abc1 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/redis/vo/RedisKeyValueRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/redis/vo/RedisKeyValueRespVO.java @@ -13,7 +13,7 @@ public class RedisKeyValueRespVO { @Schema(description = "c5f6990767804a928f4bb96ca249febf", required = true, example = "String") private String key; - @ApiModelProperty(required = true, example = "String") + @Schema(required = true, example = "String") private String value; } \ No newline at end of file diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/redis/vo/RedisMonitorRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/redis/vo/RedisMonitorRespVO.java index 6f708ef68..51a91b23f 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/redis/vo/RedisMonitorRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/redis/vo/RedisMonitorRespVO.java @@ -15,7 +15,7 @@ import java.util.Properties; @AllArgsConstructor public class RedisMonitorRespVO { - @Schema(description = "Redis info 指令结果", required = true, notes = "具体字段，查看 Redis 文档") + @Schema(description = "Redis info 指令结果,具体字段，查看 Redis 文档", required = true) private Properties info; @Schema(description = "Redis key 数量", required = true, example = "1024") diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/TestDemoController.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/TestDemoController.java index bdd32e4b0..8bf3dd3f2 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/TestDemoController.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/TestDemoController.java @@ -69,7 +69,7 @@ public class TestDemoController { @GetMapping("/list") @Operation(summary = "获得字典类型列表") - @Parameter(name = "ids", description = "编号列表", required = true, example = "1024,2048", dataTypeClass = List.class) + @Parameter(name = "ids", description = "编号列表", required = true, example = "1024,2048") @PreAuthorize("@ss.hasPermission('infra:test-demo:query')") public CommonResult> getTestDemoList(@RequestParam("ids") Collection ids) { List list = testDemoService.getTestDemoList(ids); diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoBaseVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoBaseVO.java index 72e3b0a39..fcc5c0761 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoBaseVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoBaseVO.java @@ -1,8 +1,7 @@ package cn.iocoder.yudao.module.infra.controller.admin.test.vo; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import java.util.*; -import io.swagger.annotations.*; import javax.validation.constraints.*; /** diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoCreateReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoCreateReqVO.java index 0432da0c1..2f84f6376 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoCreateReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoCreateReqVO.java @@ -1,7 +1,7 @@ package cn.iocoder.yudao.module.infra.controller.admin.test.vo; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import io.swagger.annotations.*; @Schema(description = "管理后台 - 字典类型创建 Request VO") @Data diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoExcelVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoExcelVO.java index 27a1f21c6..be94c31d7 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoExcelVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoExcelVO.java @@ -3,8 +3,6 @@ package cn.iocoder.yudao.module.infra.controller.admin.test.vo; import lombok.*; import java.time.LocalDateTime; -import java.util.*; -import io.swagger.annotations.*; import com.alibaba.excel.annotation.ExcelProperty; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoExportReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoExportReqVO.java index 39116010e..115d92aef 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoExportReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoExportReqVO.java @@ -9,7 +9,7 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(description = value = "管理后台 - 字典类型 Excel 导出 Request VO", description = "参数和 TestDemoPageReqVO 是一致的") +@Schema(description = "管理后台 - 字典类型 Excel 导出 Request VO,参数和 TestDemoPageReqVO 是一致的") @Data public class TestDemoExportReqVO { diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoUpdateReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoUpdateReqVO.java index 53660be02..12765e561 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoUpdateReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoUpdateReqVO.java @@ -1,7 +1,7 @@ package cn.iocoder.yudao.module.infra.controller.admin.test.vo; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import io.swagger.annotations.*; import javax.validation.constraints.*; @Schema(description = "管理后台 - 字典类型更新 Request VO") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthMenuRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthMenuRespVO.java index 86c28fb19..92a419bff 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthMenuRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthMenuRespVO.java @@ -25,13 +25,13 @@ public class AuthMenuRespVO { @Schema(description = "菜单名称", required = true, example = "芋道") private String name; - @Schema(description = "路由地址", example = "post", notes = "仅菜单类型为菜单或者目录时，才需要传") + @Schema(description = "路由地址，仅菜单类型为菜单或者目录时，才需要传", example = "post") private String path; - @Schema(description = "组件路径", example = "system/post/index", notes = "仅菜单类型为菜单时，才需要传") + @Schema(description = "组件路径，仅菜单类型为菜单时，才需要传", example = "system/post/index") private String component; - @Schema(description = "菜单图标", example = "/menu/list", notes = "仅菜单类型为菜单或者目录时，才需要传") + @Schema(description = "菜单图标，仅菜单类型为菜单或者目录时，才需要传", example = "/menu/list") private String icon; @Schema(description = "是否可见", required = true, example = "false") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptListReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptListReqVO.java index 822630f5d..ae20e774b 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptListReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptListReqVO.java @@ -8,10 +8,10 @@ import lombok.Data; @Data public class DeptListReqVO { - @Schema(description = "部门名称", example = "芋道", notes = "模糊匹配") + @Schema(description = "部门名称,模糊匹配", example = "芋道") private String name; - @Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; } \ No newline at end of file diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptRespVO.java index e61f71a3c..36e977729 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptRespVO.java @@ -15,7 +15,7 @@ public class DeptRespVO extends DeptBaseVO { @Schema(description = "部门编号", required = true, example = "1024") private Long id; - @Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1") private Integer status; @Schema(description = "创建时间", required = true, example = "时间戳格式") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataBaseVO.java index 7964b3c25..099f21625 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataBaseVO.java @@ -35,12 +35,12 @@ public class DictDataBaseVO { @Size(max = 100, message = "字典类型长度不能超过100个字符") private String dictType; - @Schema(description = "状态", required = true, example = "1", notes = "见 CommonStatusEnum 枚举") + @Schema(description = "状态,见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") // @InEnum(value = CommonStatusEnum.class, message = "修改状态必须是 {value}") private Integer status; - @Schema(description = "颜色类型", example = "default", notes = "default、primary、success、info、warning、danger") + @Schema(description = "颜色类型,default、primary、success、info、warning、danger", example = "default") private String colorType; @Schema(description = "css 样式", example = "btn-visible") private String cssClass; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeBaseVO.java index 92fd7e5d7..25c5f1b2f 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeBaseVO.java @@ -19,7 +19,7 @@ public class DictTypeBaseVO { @Size(max = 100, message = "字典类型名称长度不能超过100个字符") private String name; - @Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态，参见 CommonStatusEnum 枚举类", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeExportReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeExportReqVO.java index 10e3f436e..e4d043974 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeExportReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeExportReqVO.java @@ -13,13 +13,13 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @Data public class DictTypeExportReqVO { - @Schema(description = "字典类型名称", example = "芋道", notes = "模糊匹配") + @Schema(description = "字典类型名称，模糊匹配", example = "芋道") private String name; - @Schema(description = "字典类型", example = "sys_common_sex", notes = "模糊匹配") + @Schema(description = "字典类型，模糊匹配", example = "sys_common_sex") private String type; - @Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态，参见 CommonStatusEnum 枚举类", example = "1") private Integer status; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypePageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypePageReqVO.java index 06165b792..a7ae4dccf 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypePageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypePageReqVO.java @@ -17,14 +17,14 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @EqualsAndHashCode(callSuper = true) public class DictTypePageReqVO extends PageParam { - @Schema(description = "字典类型名称", example = "芋道", notes = "模糊匹配") + @Schema(description = "字典类型名称，模糊匹配", example = "芋道") private String name; - @Schema(description = "字典类型", example = "sys_common_sex", notes = "模糊匹配") + @Schema(description = "字典类型，模糊匹配", example = "sys_common_sex") @Size(max = 100, message = "字典类型类型长度不能超过100个字符") private String type; - @Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态，参见 CommonStatusEnum 枚举类", example = "1") private Integer status; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/account/MailAccountCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/account/MailAccountCreateReqVO.java index 8585e9d75..6776ad9f7 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/account/MailAccountCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/account/MailAccountCreateReqVO.java @@ -1,11 +1,11 @@ package cn.iocoder.yudao.module.system.controller.admin.mail.vo.account; -import io.swagger.annotations.ApiModel; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@ApiModel("管理后台 - 邮箱账号创建 Request VO") +@Schema(description = "管理后台 - 邮箱账号创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogBaseVO.java index 012b7cc3e..5d8b0f578 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogBaseVO.java @@ -20,7 +20,7 @@ public class MailLogBaseVO { @Schema(description = "用户编号", example = "30883") private Long userId; - @Schema(description = "用户类型", example = "2", notes = "参见 UserTypeEnum 枚举") + @Schema(description = "用户类型,参见 UserTypeEnum 枚举", example = "2" ) private Byte userType; @Schema(description = "接收邮箱地址", required = true, example = "76854@qq.com") @@ -58,7 +58,7 @@ public class MailLogBaseVO { @NotNull(message = "邮件参数不能为空") private Map templateParams; - @Schema(description = "发送状态", required = true, example = "1", notes = "参见 MailSendStatusEnum 枚举") + @Schema(description = "发送状态，参见 MailSendStatusEnum 枚举", required = true, example = "1" ) @NotNull(message = "发送状态不能为空") private Byte sendStatus; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogPageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogPageReqVO.java index b2780976b..ad6938059 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogPageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogPageReqVO.java @@ -21,10 +21,10 @@ public class MailLogPageReqVO extends PageParam { @Schema(description = "用户编号", example = "30883") private Long userId; - @Schema(description = "用户类型", example = "2", notes = "参见 UserTypeEnum 枚举") + @Schema(description = "用户类型，参见 UserTypeEnum 枚举", example = "2" ) private Integer userType; - @Schema(description = "接收邮箱地址", example = "76854@qq.com", notes = "模糊匹配") + @Schema(description = "接收邮箱地址，模糊匹配", example = "76854@qq.com" ) private String toMail; @Schema(description = "邮箱账号编号", example = "18107") @@ -33,7 +33,7 @@ public class MailLogPageReqVO extends PageParam { @Schema(description = "模板编号", example = "5678") private Long templateId; - @Schema(description = "发送状态", example = "1", notes = "参见 MailSendStatusEnum 枚举") + @Schema(description = "发送状态，参见 MailSendStatusEnum 枚举", example = "1" ) private Integer sendStatus; @Schema(description = "发送时间") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateBaseVO.java index 2d2208822..5bc0797dd 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateBaseVO.java @@ -36,7 +36,7 @@ public class MailTemplateBaseVO { @NotEmpty(message = "内容不能为空") private String content; - @Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态，参见 CommonStatusEnum 枚举", required = true, example = "1" ) @NotNull(message = "状态不能为空") private Integer status; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateCreateReqVO.java index 6eab6e9ab..b8b47e3b2 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateCreateReqVO.java @@ -1,11 +1,11 @@ package cn.iocoder.yudao.module.system.controller.admin.mail.vo.template; -import io.swagger.annotations.ApiModel; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@ApiModel("管理后台 - 邮件模版创建 Request VO") +@Schema(description = "管理后台 - 邮件模版创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplatePageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplatePageReqVO.java index 95a67a125..037f37fa5 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplatePageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplatePageReqVO.java @@ -18,13 +18,13 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @ToString(callSuper = true) public class MailTemplatePageReqVO extends PageParam { - @Schema(description = "状态", example = "1", notes = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态,参见 CommonStatusEnum 枚举", example = "1") private Integer status; - @Schema(description = "标识", example = "code_1024", notes = "模糊匹配") + @Schema(description = "标识,模糊匹配", example = "code_1024") private String code; - @Schema(description = "名称", example = "芋头", notes = "模糊匹配") + @Schema(description = "名称,模糊匹配", example = "芋头") private String name; @Schema(description = "账号编号", example = "2048") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeBaseVO.java index f661318cf..75f013764 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeBaseVO.java @@ -26,7 +26,7 @@ public class NoticeBaseVO { @Schema(description = "公告内容", required = true, example = "半生编码") private String content; - @Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态，参见 CommonStatusEnum 枚举类", required = true, example = "1") private Integer status; } \ No newline at end of file diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeCreateReqVO.java index 49e671ce1..211f4f0cf 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeCreateReqVO.java @@ -1,10 +1,10 @@ package cn.iocoder.yudao.module.system.controller.admin.notice.vo; -import io.swagger.annotations.ApiModel; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; -@ApiModel("管理后台 - 通知公告创建 Request VO") +@Schema(description = "管理后台 - 通知公告创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class NoticeCreateReqVO extends NoticeBaseVO { diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticePageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticePageReqVO.java index de87c4795..74b11ab7d 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticePageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticePageReqVO.java @@ -11,10 +11,10 @@ import lombok.EqualsAndHashCode; @EqualsAndHashCode(callSuper = true) public class NoticePageReqVO extends PageParam { - @Schema(description = "通知公告名称", example = "芋道", notes = "模糊匹配") + @Schema(description = "通知公告名称,模糊匹配", example = "芋道") private String title; - @Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; } \ No newline at end of file diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/NotifyMessageController.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/NotifyMessageController.java index e9419572f..e34679f37 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/NotifyMessageController.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/NotifyMessageController.java @@ -63,7 +63,7 @@ public class NotifyMessageController { @PutMapping("/update-read") @Operation(summary = "标记站内信为已读") - @Parameter(name = "ids", description = "编号列表", required = true, example = "1024,2048", dataTypeClass = List.class) + @Parameter(name = "ids", description = "编号列表", required = true, example = "1024,2048") public CommonResult updateNotifyMessageRead(@RequestParam("ids") List ids) { notifyMessageService.updateNotifyMessageRead(ids, getLoginUserId(), UserTypeEnum.ADMIN.getValue()); return success(Boolean.TRUE); @@ -78,7 +78,7 @@ public class NotifyMessageController { @GetMapping("/get-unread-list") @Operation(summary = "获取当前用户的最新站内信列表，默认 10 条") - @Parameter(name = "size", description = "10", defaultValue = "10") + @Parameter(name = "size", description = "10") public CommonResult> getUnreadNotifyMessageList( @RequestParam(name = "size", defaultValue = "10") Integer size) { List list = notifyMessageService.getUnreadNotifyMessageList( diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/message/NotifyMessageBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/message/NotifyMessageBaseVO.java index 7e18ff9d4..e5402e461 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/message/NotifyMessageBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/message/NotifyMessageBaseVO.java @@ -21,7 +21,7 @@ public class NotifyMessageBaseVO { @NotNull(message = "用户编号不能为空") private Long userId; - @Schema(description = "用户类型", required = true, example = "1", notes = "参见 UserTypeEnum 枚举") + @Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "1") @NotNull(message = "用户类型不能为空") private Byte userType; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplateBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplateBaseVO.java index 53e04aa36..3e591feee 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplateBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplateBaseVO.java @@ -23,7 +23,7 @@ public class NotifyTemplateBaseVO { @NotNull(message = "模版编码不能为空") private String code; - @Schema(description = "模版类型", required = true, example = "1", notes = "对应 system_notify_template_type 字典") + @Schema(description = "模版类型,对应 system_notify_template_type 字典", required = true, example = "1") @NotNull(message = "模版类型不能为空") private Integer type; @@ -35,7 +35,7 @@ public class NotifyTemplateBaseVO { @NotEmpty(message = "模版内容不能为空") private String content; - @Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态,参见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") @InEnum(value = CommonStatusEnum.class, message = "状态必须是 {value}") private Integer status; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplateCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplateCreateReqVO.java index 6cb91efa0..82572c24b 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplateCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplateCreateReqVO.java @@ -1,11 +1,11 @@ package cn.iocoder.yudao.module.system.controller.admin.notify.vo.template; -import io.swagger.annotations.ApiModel; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@ApiModel("管理后台 - 站内信模版创建 Request VO") +@Schema(description = "管理后台 - 站内信模版创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplatePageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplatePageReqVO.java index df439432f..60035474b 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplatePageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplatePageReqVO.java @@ -24,7 +24,7 @@ public class NotifyTemplatePageReqVO extends PageParam { @Schema(description = "模版名称", example = "我是名称") private String name; - @Schema(description = "状态", example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; @Schema(description = "创建时间") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/OAuth2OpenController.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/OAuth2OpenController.java index 5c4dc9ade..a94da1728 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/OAuth2OpenController.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/OAuth2OpenController.java @@ -213,7 +213,7 @@ public class OAuth2OpenController { @Parameter(name = "client_id", required = true, description = "客户端编号", example = "tudou"), @Parameter(name = "scope", description = "授权范围", example = "userinfo.read"), // 使用 Map 格式，Spring MVC 暂时不支持这么接收参数 @Parameter(name = "redirect_uri", required = true, description = "重定向 URI", example = "https://www.iocoder.cn"), - @Parameter(name = "auto_approve", required = true, description = "用户是否接受", example = "true", dataTypeClass = Boolean.class), + @Parameter(name = "auto_approve", required = true, description = "用户是否接受", example = "true"), @Parameter(name = "state", example = "1") }) @OperateLog(enable = false) // 避免 Post 请求被记录操作日志 diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientBaseVO.java index 83f81ab0d..e90ccaa89 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientBaseVO.java @@ -38,7 +38,7 @@ public class OAuth2ClientBaseVO { @Schema(description = "应用描述", example = "我是一个应用") private String description; - @Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态,参见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; @@ -55,7 +55,7 @@ public class OAuth2ClientBaseVO { private List<@NotEmpty(message = "重定向的 URI 不能为空") @URL(message = "重定向的 URI 格式不正确") String> redirectUris; - @Schema(description = "授权类型", required = true, example = "password", notes = "参见 OAuth2GrantTypeEnum 枚举") + @Schema(description = "授权类型,参见 OAuth2GrantTypeEnum 枚举", required = true, example = "password") @NotNull(message = "授权类型不能为空") private List authorizedGrantTypes; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientCreateReqVO.java index bc01a1d3d..033ab9a7e 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientCreateReqVO.java @@ -1,7 +1,7 @@ package cn.iocoder.yudao.module.system.controller.admin.oauth2.vo.client; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import io.swagger.annotations.*; @Schema(description = "管理后台 - OAuth2 客户端创建 Request VO") @Data diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientPageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientPageReqVO.java index 296991e34..1982abedf 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientPageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientPageReqVO.java @@ -1,7 +1,7 @@ package cn.iocoder.yudao.module.system.controller.admin.oauth2.vo.client; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import io.swagger.annotations.*; import cn.iocoder.yudao.framework.common.pojo.PageParam; @Schema(description = "管理后台 - OAuth2 客户端分页 Request VO") @@ -10,10 +10,10 @@ import cn.iocoder.yudao.framework.common.pojo.PageParam; @ToString(callSuper = true) public class OAuth2ClientPageReqVO extends PageParam { - @Schema(description = "应用名", example = "土豆", notes = "模糊匹配") + @Schema(description = "应用名,模糊匹配", example = "土豆") private String name; - @Schema(description = "状态", example = "1", notes = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态,参见 CommonStatusEnum 枚举", example = "1") private Integer status; } \ No newline at end of file diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenAccessTokenRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenAccessTokenRespVO.java index d51285638..8ddd4b2e1 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenAccessTokenRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenAccessTokenRespVO.java @@ -25,11 +25,11 @@ public class OAuth2OpenAccessTokenRespVO { @JsonProperty("token_type") private String tokenType; - @Schema(description = "过期时间", required = true, example = "42430", notes = "单位：秒") + @Schema(description = "过期时间,单位：秒", required = true, example = "42430") @JsonProperty("expires_in") private Long expiresIn; - @Schema(description = "授权范围", example = "user_info", notes = "如果多个授权范围，使用空格分隔") + @Schema(description = "授权范围,如果多个授权范围，使用空格分隔", example = "user_info") private String scope; } \ No newline at end of file diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenAuthorizeInfoRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenAuthorizeInfoRespVO.java index dfc5e96db..c0132ff07 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenAuthorizeInfoRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenAuthorizeInfoRespVO.java @@ -20,7 +20,7 @@ public class OAuth2OpenAuthorizeInfoRespVO { */ private Client client; - @Schema(description = "scope 的选中信息", required = true, notes = "使用 List 保证有序性，Key 是 scope，Value 为是否选中") + @Schema(description = "scope 的选中信息,使用 List 保证有序性，Key 是 scope，Value 为是否选中", required = true) private List> scopes; @Data diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenCheckTokenRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenCheckTokenRespVO.java index 066f0ed5a..5d4b0fb8a 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenCheckTokenRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenCheckTokenRespVO.java @@ -18,7 +18,7 @@ public class OAuth2OpenCheckTokenRespVO { @Schema(description = "用户编号", required = true, example = "666") @JsonProperty("user_id") private Long userId; - @Schema(description = "用户类型", required = true, example = "2", notes = "参见 UserTypeEnum 枚举") + @Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2") @JsonProperty("user_type") private Integer userType; @Schema(description = "租户编号", required = true, example = "1024") @@ -34,7 +34,7 @@ public class OAuth2OpenCheckTokenRespVO { @JsonProperty("access_token") private String accessToken; - @Schema(description = "过期时间", required = true, example = "1593092157", notes = "时间戳 / 1000，即单位：秒") + @Schema(description = "过期时间,时间戳 / 1000，即单位：秒", required = true, example = "1593092157") private Long exp; } \ No newline at end of file diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/token/OAuth2AccessTokenPageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/token/OAuth2AccessTokenPageReqVO.java index 4b03b26c4..305ca78d8 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/token/OAuth2AccessTokenPageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/token/OAuth2AccessTokenPageReqVO.java @@ -14,7 +14,7 @@ public class OAuth2AccessTokenPageReqVO extends PageParam { @Schema(description = "用户编号", required = true, example = "666") private Long userId; - @Schema(description = "用户类型", required = true, example = "2", notes = "参见 UserTypeEnum 枚举") + @Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2") private Integer userType; @Schema(description = "客户端编号", required = true, example = "2") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/token/OAuth2AccessTokenRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/token/OAuth2AccessTokenRespVO.java index 764da10d1..7a1810948 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/token/OAuth2AccessTokenRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/token/OAuth2AccessTokenRespVO.java @@ -26,7 +26,7 @@ public class OAuth2AccessTokenRespVO { @Schema(description = "用户编号", required = true, example = "666") private Long userId; - @Schema(description = "用户类型", required = true, example = "2", notes = "参见 UserTypeEnum 枚举") + @Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2") private Integer userType; @Schema(description = "客户端编号", required = true, example = "2") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/user/OAuth2UserInfoRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/user/OAuth2UserInfoRespVO.java index d25d9755a..b155b9341 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/user/OAuth2UserInfoRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/user/OAuth2UserInfoRespVO.java @@ -28,7 +28,7 @@ public class OAuth2UserInfoRespVO { @Schema(description = "手机号码", example = "15601691300") private String mobile; - @Schema(description = "用户性别", example = "1", notes = "参见 SexEnum 枚举类") + @Schema(description = "用户性别,参见 SexEnum 枚举类", example = "1") private Integer sex; @Schema(description = "用户头像", example = "https://www.iocoder.cn/xxx.png") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/user/OAuth2UserUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/user/OAuth2UserUpdateReqVO.java index 042560eec..101e0f802 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/user/OAuth2UserUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/user/OAuth2UserUpdateReqVO.java @@ -29,7 +29,7 @@ public class OAuth2UserUpdateReqVO { @Length(min = 11, max = 11, message = "手机号长度必须 11 位") private String mobile; - @Schema(description = "用户性别", example = "1", notes = "参见 SexEnum 枚举类") + @Schema(description = "用户性别,参见 SexEnum 枚举类", example = "1") private Integer sex; } \ No newline at end of file diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuBaseVO.java index 3fbbe3950..bc7762b65 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuBaseVO.java @@ -19,11 +19,11 @@ public class MenuBaseVO { @Size(max = 50, message = "菜单名称长度不能超过50个字符") private String name; - @Schema(description = "权限标识", example = "sys:menu:add", notes = "仅菜单类型为按钮时，才需要传递") + @Schema(description = "权限标识,仅菜单类型为按钮时，才需要传递", example = "sys:menu:add") @Size(max = 100) private String permission; - @Schema(description = "类型", required = true, example = "1", notes = "参见 MenuTypeEnum 枚举类") + @Schema(description = "类型,参见 MenuTypeEnum 枚举类", required = true, example = "1") @NotNull(message = "菜单类型不能为空") private Integer type; @@ -35,18 +35,18 @@ public class MenuBaseVO { @NotNull(message = "父菜单 ID 不能为空") private Long parentId; - @Schema(description = "路由地址", example = "post", notes = "仅菜单类型为菜单或者目录时，才需要传") + @Schema(description = "路由地址,仅菜单类型为菜单或者目录时，才需要传", example = "post") @Size(max = 200, message = "路由地址不能超过200个字符") private String path; - @Schema(description = "菜单图标", example = "/menu/list", notes = "仅菜单类型为菜单或者目录时，才需要传") + @Schema(description = "菜单图标,仅菜单类型为菜单或者目录时，才需要传", example = "/menu/list") private String icon; - @Schema(description = "组件路径", example = "system/post/index", notes = "仅菜单类型为菜单时，才需要传") + @Schema(description = "组件路径,仅菜单类型为菜单时，才需要传", example = "system/post/index") @Size(max = 200, message = "组件路径不能超过255个字符") private String component; - @Schema(description = "状态", required = true, example = "1", notes = "见 CommonStatusEnum 枚举") + @Schema(description = "状态,见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuCreateReqVO.java index a793997ff..56721b7fe 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuCreateReqVO.java @@ -1,9 +1,9 @@ package cn.iocoder.yudao.module.system.controller.admin.permission.vo.menu; -import io.swagger.annotations.ApiModel; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@ApiModel("管理后台 - 菜单创建 Request VO") +@Schema(description = "管理后台 - 菜单创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class MenuCreateReqVO extends MenuBaseVO { diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuListReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuListReqVO.java index 1256e11ec..6378320bb 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuListReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuListReqVO.java @@ -8,10 +8,10 @@ import lombok.Data; @Data public class MenuListReqVO { - @Schema(description = "菜单名称", example = "芋道", notes = "模糊匹配") + @Schema(description = "菜单名称，模糊匹配", example = "芋道") private String name; - @Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态，参见 CommonStatusEnum 枚举类", example = "1") private Integer status; } \ No newline at end of file diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuRespVO.java index b9cc62c42..9b5c942a0 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuRespVO.java @@ -19,7 +19,7 @@ public class MenuRespVO extends MenuBaseVO { @Schema(description = "菜单编号", required = true, example = "1024") private Long id; - @Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态，参见 CommonStatusEnum 枚举类", required = true, example = "1") private Integer status; @Schema(description = "创建时间", required = true, example = "时间戳格式") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuSimpleRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuSimpleRespVO.java index 8154ee123..68e00180c 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuSimpleRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuSimpleRespVO.java @@ -23,7 +23,7 @@ public class MenuSimpleRespVO { @Schema(description = "父菜单 ID", required = true, example = "1024") private Long parentId; - @Schema(description = "类型", required = true, example = "1", notes = "参见 MenuTypeEnum 枚举类") + @Schema(description = "类型，参见 MenuTypeEnum 枚举类", required = true, example = "1") private Integer type; } \ No newline at end of file diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignRoleDataScopeReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignRoleDataScopeReqVO.java index 19120ba68..55b69ccd7 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignRoleDataScopeReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignRoleDataScopeReqVO.java @@ -16,12 +16,12 @@ public class PermissionAssignRoleDataScopeReqVO { @NotNull(message = "角色编号不能为空") private Long roleId; - @Schema(description = "数据范围", required = true, example = "1", notes = "参见 DataScopeEnum 枚举类") + @Schema(description = "数据范围，参见 DataScopeEnum 枚举类", required = true, example = "1") @NotNull(message = "数据范围不能为空") // TODO 这里要多一个枚举校验 private Integer dataScope; - @Schema(description = "部门编号列表", example = "1,3,5", notes = "只有范围类型为 DEPT_CUSTOM 时，该字段才需要") + @Schema(description = "部门编号列表，只有范围类型为 DEPT_CUSTOM 时，该字段才需要", example = "1,3,5") private Set dataScopeDeptIds = Collections.emptySet(); // 兜底 } \ No newline at end of file diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleExportReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleExportReqVO.java index db9b4c61e..567ed0cd6 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleExportReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleExportReqVO.java @@ -13,13 +13,13 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @Data public class RoleExportReqVO { - @Schema(description = "角色名称", example = "芋道", notes = "模糊匹配") + @Schema(description = "角色名称，模糊匹配", example = "芋道") private String name; - @Schema(description = "角色标识", example = "yudao", notes = "模糊匹配") + @Schema(description = "角色标识，模糊匹配", example = "yudao") private String code; - @Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态，参见 CommonStatusEnum 枚举类", example = "1") private Integer status; @Schema(description = "开始时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RolePageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RolePageReqVO.java index 9f99f2b94..b612ad999 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RolePageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RolePageReqVO.java @@ -16,13 +16,13 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @EqualsAndHashCode(callSuper = true) public class RolePageReqVO extends PageParam { - @Schema(description = "角色名称", example = "芋道", notes = "模糊匹配") + @Schema(description = "角色名称，模糊匹配", example = "芋道") private String name; - @Schema(description = "角色标识", example = "yudao", notes = "模糊匹配") + @Schema(description = "角色标识，模糊匹配", example = "yudao") private String code; - @Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态，参见 CommonStatusEnum 枚举类", example = "1") private Integer status; @Schema(description = "开始时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleRespVO.java index accdd21ce..0afea1aed 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleRespVO.java @@ -20,16 +20,16 @@ public class RoleRespVO extends RoleBaseVO { @Schema(description = "角色编号", required = true, example = "1") private Long id; - @Schema(description = "数据范围", required = true, example = "1", notes = "参见 DataScopeEnum 枚举类") + @Schema(description = "数据范围，参见 DataScopeEnum 枚举类", required = true, example = "1") private Integer dataScope; @Schema(description = "数据范围(指定部门数组)", example = "1") private Set dataScopeDeptIds; - @Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态，参见 CommonStatusEnum 枚举类", required = true, example = "1") private Integer status; - @Schema(description = "角色类型", required = true, example = "1", notes = "参见 RoleTypeEnum 枚举类") + @Schema(description = "角色类型，参见 RoleTypeEnum 枚举类", required = true, example = "1") private Integer type; @Schema(description = "创建时间", required = true, example = "时间戳格式") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleUpdateStatusReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleUpdateStatusReqVO.java index c4cf97df4..3124308c0 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleUpdateStatusReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleUpdateStatusReqVO.java @@ -14,7 +14,7 @@ public class RoleUpdateStatusReqVO { @NotNull(message = "角色编号不能为空") private Long id; - @Schema(description = "状态", required = true, example = "1", notes = "见 CommonStatusEnum 枚举") + @Schema(description = "状态，见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") // @InEnum(value = CommonStatusEnum.class, message = "修改状态必须是 {value}") private Integer status; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordBaseVO.java index df8557d3d..bc5b752ba 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordBaseVO.java @@ -7,9 +7,9 @@ import javax.validation.constraints.NotNull; import java.util.List; /** -* 敏感词 Base VO，提供给添加、修改、详细的子 VO 使用 -* 如果子 VO 存在差异的字段，请不要添加到这里，影响 Swagger 文档生成 -*/ + * 敏感词 Base VO，提供给添加、修改、详细的子 VO 使用 + * 如果子 VO 存在差异的字段，请不要添加到这里，影响 Swagger 文档生成 + */ @Data public class SensitiveWordBaseVO { @@ -21,7 +21,7 @@ public class SensitiveWordBaseVO { @NotNull(message = "标签不能为空") private List tags; - @Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordCreateReqVO.java index bb206652b..2e2e89df5 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordCreateReqVO.java @@ -1,11 +1,11 @@ package cn.iocoder.yudao.module.system.controller.admin.sensitiveword.vo; -import io.swagger.annotations.ApiModel; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@ApiModel("管理后台 - 敏感词创建 Request VO") +@Schema(description = "管理后台 - 敏感词创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelCreateReqVO.java index 6cb352677..58b42f4d9 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelCreateReqVO.java @@ -14,7 +14,7 @@ import javax.validation.constraints.NotNull; @ToString(callSuper = true) public class SmsChannelCreateReqVO extends SmsChannelBaseVO { - @Schema(description = "渠道编码", required = true, example = "YUN_PIAN", notes = "参见 SmsChannelEnum 枚举类") + @Schema(description = "渠道编码,参见 SmsChannelEnum 枚举类", required = true, example = "YUN_PIAN" ) @NotNull(message = "渠道编码不能为空") private String code; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelPageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelPageReqVO.java index 475aebce6..18e4f96a3 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelPageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelPageReqVO.java @@ -21,7 +21,7 @@ public class SmsChannelPageReqVO extends PageParam { @Schema(description = "任务状态", example = "1") private Integer status; - @Schema(description = "短信签名", example = "芋道源码", notes = "模糊匹配") + @Schema(description = "短信签名，模糊匹配", example = "芋道源码" ) private String signature; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelRespVO.java index 87e0bc85b..5b9ea72f4 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelRespVO.java @@ -17,7 +17,7 @@ public class SmsChannelRespVO extends SmsChannelBaseVO { @Schema(description = "编号", required = true, example = "1024") private Long id; - @Schema(description = "渠道编码", required = true, example = "YUN_PIAN", notes = "参见 SmsChannelEnum 枚举类") + @Schema(description = "渠道编码，参见 SmsChannelEnum 枚举类", required = true, example = "YUN_PIAN" ) private String code; @Schema(description = "创建时间", required = true) diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelSimpleRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelSimpleRespVO.java index cfc42e879..4c59f2a61 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelSimpleRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelSimpleRespVO.java @@ -18,7 +18,7 @@ public class SmsChannelSimpleRespVO { @NotNull(message = "短信签名不能为空") private String signature; - @Schema(description = "渠道编码", required = true, example = "YUN_PIAN", notes = "参见 SmsChannelEnum 枚举类") + @Schema(description = "渠道编码，参见 SmsChannelEnum 枚举类", required = true, example = "YUN_PIAN" ) private String code; } \ No newline at end of file diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateBaseVO.java index 01a187847..d3e4b0db9 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateBaseVO.java @@ -12,11 +12,11 @@ import javax.validation.constraints.NotNull; @Data public class SmsTemplateBaseVO { - @Schema(description = "短信类型", required = true, example = "1", notes = "参见 SmsTemplateTypeEnum 枚举类") + @Schema(description = "短信类型，参见 SmsTemplateTypeEnum 枚举类", required = true, example = "1" ) @NotNull(message = "短信类型不能为空") private Integer type; - @Schema(description = "开启状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类") + @Schema(description = "开启状态，参见 CommonStatusEnum 枚举类", required = true, example = "1" ) @NotNull(message = "开启状态不能为空") private Integer status; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateCreateReqVO.java index ab8b89ebd..069ebb127 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateCreateReqVO.java @@ -1,11 +1,11 @@ package cn.iocoder.yudao.module.system.controller.admin.sms.vo.template; -import io.swagger.annotations.ApiModel; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@ApiModel("管理后台 - 短信模板创建 Request VO") +@Schema(description = "管理后台 - 短信模板创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/socail/vo/SocialUserBindReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/socail/vo/SocialUserBindReqVO.java index 5d33789d8..5129895c5 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/socail/vo/SocialUserBindReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/socail/vo/SocialUserBindReqVO.java @@ -19,7 +19,7 @@ import javax.validation.constraints.NotNull; @Builder public class SocialUserBindReqVO { - @Schema(description = "社交平台的类型", required = true, example = "10", notes = "参见 UserSocialTypeEnum 枚举值") + @Schema(description = "社交平台的类型,参见 UserSocialTypeEnum 枚举值", required = true, example = "10" ) @InEnum(SocialTypeEnum.class) @NotNull(message = "社交平台的类型不能为空") private Integer type; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageCreateReqVO.java index 2290e5ca6..255971447 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageCreateReqVO.java @@ -1,11 +1,11 @@ package cn.iocoder.yudao.module.system.controller.admin.tenant.vo.packages; -import io.swagger.annotations.ApiModel; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@ApiModel("管理后台 - 租户套餐创建 Request VO") +@Schema(description = "管理后台 - 租户套餐创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageUpdateReqVO.java index ec907430c..0e1f46b71 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageUpdateReqVO.java @@ -1,8 +1,7 @@ package cn.iocoder.yudao.module.system.controller.admin.tenant.vo.packages; +import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -import java.util.*; -import io.swagger.annotations.*; import javax.validation.constraints.*; @Schema(description = "管理后台 - 租户套餐更新 Request VO") diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserBaseVO.java index fe4218bd4..7b862e50b 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserBaseVO.java @@ -45,7 +45,7 @@ public class UserBaseVO { @Mobile private String mobile; - @Schema(description = "用户性别", example = "1", notes = "参见 SexEnum 枚举类") + @Schema(description = "用户性别，参见 SexEnum 枚举类", example = "1") private Integer sex; @Schema(description = "用户头像", example = "https://www.iocoder.cn/xxx.png")