diff --git a/README.md b/README.md index 4c328a844..c29db5bf9 100644 --- a/README.md +++ b/README.md @@ -201,7 +201,7 @@ ps：核心功能已经实现，正在对接微信小程序中... | [Hibernate Validator](https://github.com/hibernate/hibernate-validator) | 参数校验组件 | 6.2.5 | [文档](http://www.iocoder.cn/Spring-Boot/Validation/?yudao) | | [Flowable](https://github.com/flowable/flowable-engine) | 工作流引擎 | 6.7.2 | [文档](https://doc.iocoder.cn/bpm/) | | [Quartz](https://github.com/quartz-scheduler) | 任务调度组件 | 2.3.2 | [文档](http://www.iocoder.cn/Spring-Boot/Job/?yudao) | -| [Knife4j](https://gitee.com/xiaoym/knife4j) | Swagger 增强 UI 实现 | 3.0.3 | [文档](http://www.iocoder.cn/Spring-Boot/Swagger/?yudao) | +| [Knife4j](https://gitee.com/xiaoym/knife4j) | Swagger 增强 UI 实现 | 4.0.0 | [文档](http://www.iocoder.cn/Spring-Boot/Swagger/?yudao) | | [Resilience4j](https://github.com/resilience4j/resilience4j) | 服务保障组件 | 1.7.1 | [文档](http://www.iocoder.cn/Spring-Boot/Resilience4j/?yudao) | | [SkyWalking](https://skywalking.apache.org/) | 分布式应用追踪系统 | 8.12.0 | [文档](http://www.iocoder.cn/Spring-Boot/SkyWalking/?yudao) | | [Spring Boot Admin](https://github.com/codecentric/spring-boot-admin) | Spring Boot 监控平台 | 2.7.9 | [文档](http://www.iocoder.cn/Spring-Boot/Admin/?yudao) | diff --git a/yudao-dependencies/pom.xml b/yudao-dependencies/pom.xml index 128165c44..a6f23dfe1 100644 --- a/yudao-dependencies/pom.xml +++ b/yudao-dependencies/pom.xml @@ -19,7 +19,7 @@ 2.7.6 1.6.14 - 3.0.3 + 4.0.0 2.5 1.2.15 @@ -158,9 +158,9 @@ - org.springdoc - springdoc-openapi-webmvc-core - ${springdoc.version} + com.github.xiaoymin + knife4j-openapi3-spring-boot-starter + ${knife4j.version} diff --git a/yudao-framework/yudao-common/pom.xml b/yudao-framework/yudao-common/pom.xml index d46e4c7d6..24fc39dec 100644 --- a/yudao-framework/yudao-common/pom.xml +++ b/yudao-framework/yudao-common/pom.xml @@ -59,10 +59,9 @@ - org.springdoc - springdoc-openapi-webmvc-core + com.github.xiaoymin + knife4j-openapi3-spring-boot-starter - org.apache.skywalking diff --git a/yudao-framework/yudao-common/src/main/java/cn/iocoder/yudao/framework/common/pojo/PageParam.java b/yudao-framework/yudao-common/src/main/java/cn/iocoder/yudao/framework/common/pojo/PageParam.java index 3cb1fc3ad..9c553055a 100644 --- a/yudao-framework/yudao-common/src/main/java/cn/iocoder/yudao/framework/common/pojo/PageParam.java +++ b/yudao-framework/yudao-common/src/main/java/cn/iocoder/yudao/framework/common/pojo/PageParam.java @@ -8,19 +8,19 @@ import javax.validation.constraints.Max; import javax.validation.constraints.NotNull; import java.io.Serializable; -@Schema(title="分页参数") +@Schema(description="分页参数") @Data public class PageParam implements Serializable { private static final Integer PAGE_NO = 1; private static final Integer PAGE_SIZE = 10; - @Schema(title = "页码，从 1 开始", required = true,example = "1") + @Schema(description = "页码，从 1 开始", required = true,example = "1") @NotNull(message = "页码不能为空") @Min(value = 1, message = "页码最小值为 1") private Integer pageNo = PAGE_NO; - @Schema(title = "每页条数，最大值为 100", required = true, example = "10") + @Schema(description = "每页条数，最大值为 100", required = true, example = "10") @NotNull(message = "每页条数不能为空") @Min(value = 1, message = "每页条数最小值为 1") @Max(value = 100, message = "每页条数最大值为 100") diff --git a/yudao-framework/yudao-common/src/main/java/cn/iocoder/yudao/framework/common/pojo/PageResult.java b/yudao-framework/yudao-common/src/main/java/cn/iocoder/yudao/framework/common/pojo/PageResult.java index 655dea180..f0048517d 100644 --- a/yudao-framework/yudao-common/src/main/java/cn/iocoder/yudao/framework/common/pojo/PageResult.java +++ b/yudao-framework/yudao-common/src/main/java/cn/iocoder/yudao/framework/common/pojo/PageResult.java @@ -6,14 +6,14 @@ import java.io.Serializable; import java.util.ArrayList; import java.util.List; -@Schema(title = "分页结果") +@Schema(description = "分页结果") @Data public final class PageResult implements Serializable { - @Schema(title = "数据", required = true) + @Schema(description = "数据", required = true) private List list; - @Schema(title = "总量", required = true) + @Schema(description = "总量", required = true) private Long total; public PageResult() { diff --git a/yudao-framework/yudao-spring-boot-starter-web/pom.xml b/yudao-framework/yudao-spring-boot-starter-web/pom.xml index 9c820e956..0e7e7854a 100644 --- a/yudao-framework/yudao-spring-boot-starter-web/pom.xml +++ b/yudao-framework/yudao-spring-boot-starter-web/pom.xml @@ -34,8 +34,8 @@ - org.springdoc - springdoc-openapi-webmvc-core + com.github.xiaoymin + knife4j-openapi3-spring-boot-starter diff --git a/yudao-framework/yudao-spring-boot-starter-web/src/main/java/cn/iocoder/yudao/framework/swagger/config/YudaoSwaggerAutoConfiguration.java b/yudao-framework/yudao-spring-boot-starter-web/src/main/java/cn/iocoder/yudao/framework/swagger/config/YudaoSwaggerAutoConfiguration.java index acdc21467..4bb2d77ac 100644 --- a/yudao-framework/yudao-spring-boot-starter-web/src/main/java/cn/iocoder/yudao/framework/swagger/config/YudaoSwaggerAutoConfiguration.java +++ b/yudao-framework/yudao-spring-boot-starter-web/src/main/java/cn/iocoder/yudao/framework/swagger/config/YudaoSwaggerAutoConfiguration.java @@ -57,10 +57,10 @@ public class YudaoSwaggerAutoConfiguration { } @Bean - public GroupedOpenApi publicApi() { + public GroupedOpenApi appApi() { return GroupedOpenApi.builder() .group("app") - .pathsToMatch("/app/**") + .pathsToMatch("/app-api/**") .build(); } @@ -68,7 +68,7 @@ public class YudaoSwaggerAutoConfiguration { public GroupedOpenApi adminApi() { return GroupedOpenApi.builder() .group("admin") - .pathsToMatch("/admin/**") + .pathsToMatch("/admin-api/**") .build(); } 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 3345adb52..c51984f0c 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 @@ -10,15 +10,15 @@ import javax.validation.constraints.*; @Data public class BpmFormBaseVO { - @Schema(title = "表单名称", required = true, example = "芋道") + @Schema(description = "表单名称", required = true, example = "芋道") @NotNull(message = "表单名称不能为空") private String name; - @Schema(title = "表单状态", required = true, description = "参见 CommonStatusEnum 枚举", example = "1") + @Schema(description = "表单状态-参见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "表单状态不能为空") private Integer status; - @Schema(title = "备注", example = "我是备注") + @Schema(description = "备注", example = "我是备注") private String remark; } 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 ce3410ced..5a096667a 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 @@ -5,17 +5,17 @@ import lombok.*; import javax.validation.constraints.NotNull; import java.util.List; -@Schema(title = "管理后台 - 动态表单创建 Request VO") +@Schema(description = "管理后台 - 动态表单创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmFormCreateReqVO extends BpmFormBaseVO { - @Schema(title = "表单的配置", required = true, description = "JSON 字符串") + @Schema(description = "表单的配置-JSON 字符串", required = true) @NotNull(message = "表单的配置不能为空") private String conf; - @Schema(title = "表单项的数组", required = true, description = "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/BpmFormPageReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormPageReqVO.java index 87adc3f63..0227e0ad9 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormPageReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormPageReqVO.java @@ -6,13 +6,13 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 动态表单分页 Request VO") +@Schema(description = "管理后台 - 动态表单分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmFormPageReqVO extends PageParam { - @Schema(title = "表单名称", example = "芋道") + @Schema(description = "表单名称", example = "芋道") private String name; } 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 b93b66012..5d7f4e765 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 @@ -8,24 +8,24 @@ import javax.validation.constraints.NotNull; import java.time.LocalDateTime; import java.util.List; -@Schema(title = "管理后台 - 动态表单 Response VO") +@Schema(description = "管理后台 - 动态表单 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmFormRespVO extends BpmFormBaseVO { - @Schema(title = "表单编号", required = true, example = "1024") + @Schema(description = "表单编号", required = true, example = "1024") private Long id; - @Schema(title = "表单的配置", required = true, description = "JSON 字符串") + @Schema(description = "表单的配置-JSON 字符串", required = true) @NotNull(message = "表单的配置不能为空") private String conf; - @Schema(title = "表单项的数组", required = true, description = "JSON 字符串的数组") + @Schema(description = "表单项的数组-JSON 字符串的数组", required = true) @NotNull(message = "表单项的数组不能为空") private List fields; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormSimpleRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormSimpleRespVO.java index 9764a9835..2e19f441c 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormSimpleRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/form/BpmFormSimpleRespVO.java @@ -3,14 +3,14 @@ package cn.iocoder.yudao.module.bpm.controller.admin.definition.vo.form; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(title = "管理后台 - 流程表单精简 Response VO") +@Schema(description = "管理后台 - 流程表单精简 Response VO") @Data public class BpmFormSimpleRespVO { - @Schema(title = "表单编号", required = true, example = "1024") + @Schema(description = "表单编号", required = true, example = "1024") private Long id; - @Schema(title = "表单名称", required = true, example = "芋道") + @Schema(description = "表单名称", required = true, example = "芋道") private String name; } 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 641e57617..e315ef370 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 @@ -4,21 +4,21 @@ import lombok.*; import javax.validation.constraints.*; import java.util.List; -@Schema(title = "管理后台 - 动态表单更新 Request VO") +@Schema(description = "管理后台 - 动态表单更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmFormUpdateReqVO extends BpmFormBaseVO { - @Schema(title = "表单编号", required = true, example = "1024") + @Schema(description = "表单编号", required = true, example = "1024") @NotNull(message = "表单编号不能为空") private Long id; - @Schema(title = "表单的配置", required = true, description = "JSON 字符串") + @Schema(description = "表单的配置-JSON 字符串", required = true) @NotNull(message = "表单的配置不能为空") private String conf; - @Schema(title = "表单项的数组", required = true, description = "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 b82f6d1d5..d78d3c02d 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 @@ -11,19 +11,19 @@ import javax.validation.constraints.*; @Data public class BpmUserGroupBaseVO { - @Schema(title = "组名", required = true, example = "芋道") + @Schema(description = "组名", required = true, example = "芋道") @NotNull(message = "组名不能为空") private String name; - @Schema(title = "描述", required = true, example = "芋道源码") + @Schema(description = "描述", required = true, example = "芋道源码") @NotNull(message = "描述不能为空") private String description; - @Schema(title = "成员编号数组", required = true, example = "1,2,3") + @Schema(description = "成员编号数组", required = true, example = "1,2,3") @NotNull(message = "成员编号数组不能为空") private Set memberUserIds; - @Schema(title = "状态", required = true, example = "1") + @Schema(description = "状态", 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/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 7509746a7..416c4793a 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 @@ -2,7 +2,7 @@ package cn.iocoder.yudao.module.bpm.controller.admin.definition.vo.group; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@Schema(title = "管理后台 - 用户组创建 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/definition/vo/group/BpmUserGroupPageReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupPageReqVO.java index c5d417131..05f17788a 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupPageReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupPageReqVO.java @@ -10,20 +10,20 @@ import org.springframework.format.annotation.DateTimeFormat; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 用户组分页 Request VO") +@Schema(description = "管理后台 - 用户组分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmUserGroupPageReqVO extends PageParam { - @Schema(title = "组名", example = "芋道") + @Schema(description = "组名", example = "芋道") private String name; - @Schema(title = "状态", example = "1") + @Schema(description = "状态", example = "1") private Integer status; @DateTimeFormat(pattern = DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } 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 e7399d228..2a390a9cf 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 @@ -5,16 +5,16 @@ import lombok.*; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 用户组 Response VO") +@Schema(description = "管理后台 - 用户组 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmUserGroupRespVO extends BpmUserGroupBaseVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupSimpleRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupSimpleRespVO.java index 785e9e571..aedd100f3 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupSimpleRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/group/BpmUserGroupSimpleRespVO.java @@ -5,16 +5,16 @@ import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; -@Schema(title = "管理后台 - 用户组精简信息 Response VO") +@Schema(description = "管理后台 - 用户组精简信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor public class BpmUserGroupSimpleRespVO { - @Schema(title = "用户组编号", required = true, example = "1024") + @Schema(description = "用户组编号", required = true, example = "1024") private Long id; - @Schema(title = "用户组名字", required = true, example = "芋道") + @Schema(description = "用户组名字", required = true, example = "芋道") private String name; } 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 88846644f..81db5649d 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 @@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 用户组更新 Request VO") +@Schema(description = "管理后台 - 用户组更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmUserGroupUpdateReqVO extends BpmUserGroupBaseVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") @NotNull(message = "编号不能为空") private Long id; 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 79771bfcb..007cfed10 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 @@ -8,13 +8,13 @@ import org.springframework.web.multipart.MultipartFile; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 流程模型的导入 Request VO", description = "相比流程模型的新建来说，只是多了一个 bpmnFile 文件") +@Schema(description = "管理后台 - 流程模型的导入 Request VO 相比流程模型的新建来说，只是多了一个 bpmnFile 文件") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmModeImportReqVO extends BpmModelCreateReqVO { - @Schema(title = "BPMN 文件", required = true) + @Schema(description = "BPMN 文件", required = true) @NotNull(message = "BPMN 文件不能为空") private MultipartFile bpmnFile; 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 639967286..8750ad913 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 @@ -11,30 +11,30 @@ import javax.validation.constraints.NotEmpty; @Data public class BpmModelBaseVO { - @Schema(title = "流程标识", required = true, example = "process_yudao") + @Schema(description = "流程标识", required = true, example = "process_yudao") @NotEmpty(message = "流程标识不能为空") private String key; - @Schema(title = "流程名称", required = true, example = "芋道") + @Schema(description = "流程名称", required = true, example = "芋道") @NotEmpty(message = "流程名称不能为空") private String name; - @Schema(title = "流程描述", example = "我是描述") + @Schema(description = "流程描述", example = "我是描述") private String description; - @Schema(title = "流程分类", description = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类-参见 bpm_model_category 数据字典", example = "1") @NotEmpty(message = "流程分类不能为空") private String category; - @Schema(title = "表单类型", description = "参见 bpm_model_form_type 数据字典", example = "1") + @Schema(description = "表单类型-参见 bpm_model_form_type 数据字典", example = "1") private Integer formType; - @Schema(title = "表单编号", example = "1024", description = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单编号-在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "1024") private Long formId; - @Schema(title = "自定义表单的提交路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/create", - description = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的提交路径，使用 Vue 的路由地址-在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", + example = "/bpm/oa/leave/create") private String formCustomCreatePath; - @Schema(title = "自定义表单的查看路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/view", - description = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的查看路径，使用 Vue 的路由地址-在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", + example = "/bpm/oa/leave/view") private String formCustomViewPath; } diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelCreateReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelCreateReqVO.java index d100b744f..5b77bc2de 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelCreateReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelCreateReqVO.java @@ -7,19 +7,19 @@ import lombok.ToString; import javax.validation.constraints.NotEmpty; -@Schema(title = "管理后台 - 流程模型的创建 Request VO") +@Schema(description = "管理后台 - 流程模型的创建 Request VO") @Data public class BpmModelCreateReqVO { - @Schema(title = "流程标识", required = true, example = "process_yudao") + @Schema(description = "流程标识", required = true, example = "process_yudao") @NotEmpty(message = "流程标识不能为空") private String key; - @Schema(title = "流程名称", required = true, example = "芋道") + @Schema(description = "流程名称", required = true, example = "芋道") @NotEmpty(message = "流程名称不能为空") private String name; - @Schema(title = "流程描述", example = "我是描述") + @Schema(description = "流程描述", example = "我是描述") private String description; } 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 cfd646ebc..9edc119c9 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 @@ -7,19 +7,19 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 流程模型的分页的每一项 Response VO") +@Schema(description = "管理后台 - 流程模型的分页的每一项 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmModelPageItemRespVO extends BpmModelBaseVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") private String id; - @Schema(title = "表单名字", example = "请假表单") + @Schema(description = "表单名字", example = "请假表单") private String formName; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; /** @@ -27,20 +27,20 @@ public class BpmModelPageItemRespVO extends BpmModelBaseVO { */ private ProcessDefinition processDefinition; - @Schema(title = "流程定义") + @Schema(description = "流程定义") @Data public static class ProcessDefinition { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") private String id; - @Schema(title = "版本", required = true, example = "1") + @Schema(description = "版本", required = true, example = "1") private Integer version; - @Schema(title = "部署时间", required = true) + @Schema(description = "部署时间", required = true) private LocalDateTime deploymentTime; - @Schema(title = "中断状态", required = true, example = "1", description = "参见 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 ce2f4ae1c..15283208e 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 @@ -7,19 +7,19 @@ import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 流程模型分页 Request VO") +@Schema(description = "管理后台 - 流程模型分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmModelPageReqVO extends PageParam { - @Schema(title = "标识", example = "process1641042089407", description = "精准匹配") + @Schema(description = "标识-精准匹配", example = "process1641042089407") private String key; - @Schema(title = "名字", example = "芋道", description = "模糊匹配") + @Schema(description = "名字-模糊匹配", example = "芋道") private String name; - @Schema(title = "流程分类", description = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类-参见 bpm_model_category 数据字典", example = "1") private String category; } diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelRespVO.java index f8e520078..26bc2f9a6 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/model/BpmModelRespVO.java @@ -7,19 +7,19 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 流程模型的创建 Request VO") +@Schema(description = "管理后台 - 流程模型的创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmModelRespVO extends BpmModelBaseVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") private String id; - @Schema(title = "BPMN XML", required = true) + @Schema(description = "BPMN XML", required = true) private String bpmnXml; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } 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 b480d0b1f..94271034b 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 @@ -5,35 +5,35 @@ import lombok.Data; import javax.validation.constraints.NotEmpty; -@Schema(title = "管理后台 - 流程模型的更新 Request VO") +@Schema(description = "管理后台 - 流程模型的更新 Request VO") @Data public class BpmModelUpdateReqVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") @NotEmpty(message = "编号不能为空") private String id; - @Schema(title = "流程名称", example = "芋道") + @Schema(description = "流程名称", example = "芋道") private String name; - @Schema(title = "流程描述", example = "我是描述") + @Schema(description = "流程描述", example = "我是描述") private String description; - @Schema(title = "流程分类", description = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类-参见 bpm_model_category 数据字典", example = "1") private String category; - @Schema(title = "BPMN XML", required = true) + @Schema(description = "BPMN XML", required = true) private String bpmnXml; - @Schema(title = "表单类型", description = "参见 bpm_model_form_type 数据字典", example = "1") + @Schema(description = "表单类型-参见 bpm_model_form_type 数据字典", example = "1") private Integer formType; - @Schema(title = "表单编号", example = "1024", description = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单编号-在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "1024") private Long formId; - @Schema(title = "自定义表单的提交路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/create", - description = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的提交路径，使用 Vue 的路由地址-在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", + example = "/bpm/oa/leave/create") private String formCustomCreatePath; - @Schema(title = "自定义表单的查看路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/view", - description = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的查看路径，使用 Vue 的路由地址-在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", + example = "/bpm/oa/leave/view") private String formCustomViewPath; } 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 d07b3b249..e59cc32fb 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 @@ -5,15 +5,15 @@ import lombok.Data; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 流程模型更新状态 Request VO") +@Schema(description = "管理后台 - 流程模型更新状态 Request VO") @Data public class BpmModelUpdateStateReqVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") @NotNull(message = "编号不能为空") private String id; - @Schema(title = "状态", required = true, example = "1", description = "见 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 664d3b27b..35243d2ac 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 @@ -6,13 +6,13 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 流程定义列表 Request VO") +@Schema(description = "管理后台 - 流程定义列表 Request VO") @Data @ToString(callSuper = true) @EqualsAndHashCode(callSuper = true) public class BpmProcessDefinitionListReqVO extends PageParam { - @Schema(title = "中断状态", example = "1", description = "参见 SuspensionState 枚举") + @Schema(description = "中断状态-参见 SuspensionState 枚举", 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/process/BpmProcessDefinitionPageItemRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionPageItemRespVO.java index 5bf9bf42a..26bc79c80 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionPageItemRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/process/BpmProcessDefinitionPageItemRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 流程定义的分页的每一项 Response VO") +@Schema(description = "管理后台 - 流程定义的分页的每一项 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmProcessDefinitionPageItemRespVO extends BpmProcessDefinitionRespVO { - @Schema(title = "表单名字", example = "请假表单") + @Schema(description = "表单名字", example = "请假表单") private String formName; - @Schema(title = "部署时间", required = true) + @Schema(description = "部署时间", required = true) private LocalDateTime deploymentTime; } 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 0b92700e3..f5c7f36d6 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 @@ -6,13 +6,13 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 流程定义分页 Request VO") +@Schema(description = "管理后台 - 流程定义分页 Request VO") @Data @ToString(callSuper = true) @EqualsAndHashCode(callSuper = true) public class BpmProcessDefinitionPageReqVO extends PageParam { - @Schema(title = "标识", example = "process1641042089407", description = "精准匹配") + @Schema(description = "标识-精准匹配", example = "process1641042089407") private String key; } 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 f4c540f2d..5fee0dd4e 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 @@ -7,45 +7,43 @@ import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; import java.util.List; -@Schema(title = "管理后台 - 流程定义 Response VO") +@Schema(description = "管理后台 - 流程定义 Response VO") @Data public class BpmProcessDefinitionRespVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") private String id; - @Schema(title = "版本", required = true, example = "1") + @Schema(description = "版本", required = true, example = "1") private Integer version; - @Schema(title = "流程名称", required = true, example = "芋道") + @Schema(description = "流程名称", required = true, example = "芋道") @NotEmpty(message = "流程名称不能为空") private String name; - @Schema(title = "流程描述", example = "我是描述") + @Schema(description = "流程描述", example = "我是描述") private String description; - @Schema(title = "流程分类", description = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类-参见 bpm_model_category 数据字典", example = "1") @NotEmpty(message = "流程分类不能为空") private String category; - @Schema(title = "表单类型", description = "参见 bpm_model_form_type 数据字典", example = "1") + @Schema(description = "表单类型-参见 bpm_model_form_type 数据字典", example = "1") private Integer formType; - @Schema(title = "表单编号", example = "1024", description = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单编号-在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "1024") private Long formId; - @Schema(title = "表单的配置", required = true, - description = "JSON 字符串。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单的配置-JSON 字符串。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", required = true) private String formConf; - @Schema(title = "表单项的数组", required = true, - description = "JSON 字符串的数组。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单项的数组-JSON 字符串的数组。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", required = true) private List formFields; - @Schema(title = "自定义表单的提交路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/create", - description = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的提交路径，使用 Vue 的路由地址-在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", + example = "/bpm/oa/leave/create") private String formCustomCreatePath; - @Schema(title = "自定义表单的查看路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/view", - description = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的查看路径，使用 Vue 的路由地址-在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", + example = "/bpm/oa/leave/view") private String formCustomViewPath; - @Schema(title = "中断状态", required = true, example = "1", description = "参见 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/rule/BpmTaskAssignRuleBaseVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleBaseVO.java index 8ec779bad..7efb1c312 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleBaseVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleBaseVO.java @@ -13,11 +13,11 @@ import java.util.Set; @Data public class BpmTaskAssignRuleBaseVO { - @Schema(title = "规则类型", required = true, example = "bpm_task_assign_rule_type") + @Schema(description = "规则类型", required = true, example = "bpm_task_assign_rule_type") @NotNull(message = "规则类型不能为空") private Integer type; - @Schema(title = "规则值数组", required = true, example = "1,2,3") + @Schema(description = "规则值数组", required = true, example = "1,2,3") @NotNull(message = "规则值数组不能为空") private Set options; diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleCreateReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleCreateReqVO.java index b1cc63c18..97bb2de8f 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleCreateReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleCreateReqVO.java @@ -7,17 +7,17 @@ import lombok.ToString; import javax.validation.constraints.NotEmpty; -@Schema(title = "管理后台 - 流程任务分配规则的创建 Request VO") +@Schema(description = "管理后台 - 流程任务分配规则的创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmTaskAssignRuleCreateReqVO extends BpmTaskAssignRuleBaseVO { - @Schema(title = "流程模型的编号", required = true, example = "1024") + @Schema(description = "流程模型的编号", required = true, example = "1024") @NotEmpty(message = "流程模型的编号不能为空") private String modelId; - @Schema(title = "流程任务定义的编号", required = true, example = "2048") + @Schema(description = "流程任务定义的编号", required = true, example = "2048") @NotEmpty(message = "流程任务定义的编号不能为空") private String taskDefinitionKey; diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleRespVO.java index 630952e14..50626edc7 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleRespVO.java @@ -5,24 +5,24 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 流程任务分配规则的 Response VO") +@Schema(description = "管理后台 - 流程任务分配规则的 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmTaskAssignRuleRespVO extends BpmTaskAssignRuleBaseVO { - @Schema(title = "任务分配规则的编号", required = true, example = "1024") + @Schema(description = "任务分配规则的编号", required = true, example = "1024") private Long id; - @Schema(title = "流程模型的编号", required = true, example = "2048") + @Schema(description = "流程模型的编号", required = true, example = "2048") private String modelId; - @Schema(title = "流程定义的编号", required = true, example = "4096") + @Schema(description = "流程定义的编号", required = true, example = "4096") private String processDefinitionId; - @Schema(title = "流程任务定义的编号", required = true, example = "2048") + @Schema(description = "流程任务定义的编号", required = true, example = "2048") private String taskDefinitionKey; - @Schema(title = "流程任务定义的名字", required = true, example = "关注芋道") + @Schema(description = "流程任务定义的名字", required = true, example = "关注芋道") private String taskDefinitionName; } diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleUpdateReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleUpdateReqVO.java index bb6f44374..5799f139f 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleUpdateReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/definition/vo/rule/BpmTaskAssignRuleUpdateReqVO.java @@ -7,13 +7,13 @@ import lombok.ToString; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 流程任务分配规则的更新 Request VO") +@Schema(description = "管理后台 - 流程任务分配规则的更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmTaskAssignRuleUpdateReqVO extends BpmTaskAssignRuleBaseVO { - @Schema(title = "任务分配规则的编号", required = true, example = "1024") + @Schema(description = "任务分配规则的编号", required = true, example = "1024") @NotNull(message = "任务分配规则的编号不能为空") private Long id; 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 9d883af85..2ce0b1c52 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 @@ -14,19 +14,19 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @Data public class BpmOALeaveBaseVO { - @Schema(title = "请假的开始时间", required = true) + @Schema(description = "请假的开始时间", required = true) @NotNull(message = "开始时间不能为空") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime startTime; - @Schema(title = "请假的结束时间", required = true) + @Schema(description = "请假的结束时间", required = true) @NotNull(message = "结束时间不能为空") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime endTime; - @Schema(title = "请假类型", required = true, example = "1", description = "参见 bpm_oa_type 枚举") + @Schema(description = "请假类型-参见 bpm_oa_type 枚举", required = true, example = "1") private Integer type; - @Schema(title = "原因", required = true, example = "阅读芋道源码") + @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/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 e1d7d082b..9bfd4488f 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 @@ -6,7 +6,7 @@ import lombok.ToString; import javax.validation.constraints.AssertTrue; -@Schema(title = "管理后台 - 请假申请创建 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 4341bd974..903a0fcf2 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 @@ -7,23 +7,23 @@ import org.springframework.format.annotation.DateTimeFormat; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 请假申请分页 Request VO") +@Schema(description = "管理后台 - 请假申请分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmOALeavePageReqVO extends PageParam { - @Schema(title = "状态", example = "1", description = "参见 bpm_process_instance_result 枚举") + @Schema(description = "状态-参见 bpm_process_instance_result 枚举", example = "1") private Integer result; - @Schema(title = "请假类型", example = "1", description = "参见 bpm_oa_type") + @Schema(description = "请假类型-参见 bpm_oa_type", example = "1") private Integer type; - @Schema(title = "原因", example = "阅读芋道源码", description = "模糊匹配") + @Schema(description = "原因-模糊匹配", example = "阅读芋道源码") private String reason; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "申请时间") + @Schema(description = "申请时间") private LocalDateTime[] createTime; } 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 a30c41676..d79dac7d3 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 @@ -8,24 +8,24 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 请假申请 Response VO") +@Schema(description = "管理后台 - 请假申请 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmOALeaveRespVO extends BpmOALeaveBaseVO { - @Schema(title = "请假表单主键", required = true, example = "1024") + @Schema(description = "请假表单主键", required = true, example = "1024") private Long id; - @Schema(title = "状态", required = true, example = "1", description = "参见 bpm_process_instance_result 枚举") + @Schema(description = "状态-参见 bpm_process_instance_result 枚举", required = true, example = "1") private Integer result; - @Schema(title = "申请时间", required = true) + @Schema(description = "申请时间", required = true) @NotNull(message = "申请时间不能为空") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime createTime; - @Schema(title = "流程id") + @Schema(description = "流程id") private String processInstanceId; } 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 997b8bce0..1958fc739 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 @@ -5,21 +5,21 @@ import lombok.Data; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 流程活动的 Response VO") +@Schema(description = "管理后台 - 流程活动的 Response VO") @Data public class BpmActivityRespVO { - @Schema(title = "流程活动的标识", required = true, example = "1024") + @Schema(description = "流程活动的标识", required = true, example = "1024") private String key; - @Schema(title = "流程活动的类型", required = true, example = "StartEvent") + @Schema(description = "流程活动的类型", required = true, example = "StartEvent") private String type; - @Schema(title = "流程活动的开始时间", required = true) + @Schema(description = "流程活动的开始时间", required = true) private LocalDateTime startTime; - @Schema(title = "流程活动的结束时间", required = true) + @Schema(description = "流程活动的结束时间", required = true) private LocalDateTime endTime; - @Schema(title = "关联的流程任务的编号", example = "2048", description = "关联的流程任务，只有 UserTask 等类型才有") + @Schema(description = "关联的流程任务的编号-关联的流程任务，只有 UserTask 等类型才有", example = "2048") private String taskId; } diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceCancelReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceCancelReqVO.java index 3a2ea654c..c0903279b 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceCancelReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceCancelReqVO.java @@ -7,15 +7,15 @@ import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; import java.util.Map; -@Schema(title = "管理后台 - 流程实例的取消 Request VO") +@Schema(description = "管理后台 - 流程实例的取消 Request VO") @Data public class BpmProcessInstanceCancelReqVO { - @Schema(title = "流程实例的编号", required = true, example = "1024") + @Schema(description = "流程实例的编号", required = true, example = "1024") @NotEmpty(message = "流程实例的编号不能为空") private String id; - @Schema(title = "取消原因", required = true, example = "不请假了！") + @Schema(description = "取消原因", required = true, example = "不请假了！") @NotEmpty(message = "取消原因不能为空") 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/instance/BpmProcessInstanceCreateReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceCreateReqVO.java index 588de54fd..48becaad2 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceCreateReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/instance/BpmProcessInstanceCreateReqVO.java @@ -6,15 +6,15 @@ import lombok.Data; import javax.validation.constraints.NotEmpty; import java.util.Map; -@Schema(title = "管理后台 - 流程实例的创建 Request VO") +@Schema(description = "管理后台 - 流程实例的创建 Request VO") @Data public class BpmProcessInstanceCreateReqVO { - @Schema(title = "流程定义的编号", required = true, example = "1024") + @Schema(description = "流程定义的编号", required = true, example = "1024") @NotEmpty(message = "流程定义编号不能为空") private String processDefinitionId; - @Schema(title = "变量实例") + @Schema(description = "变量实例") private Map variables; } 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 111c73b5d..5b5d9fb26 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 @@ -11,28 +11,28 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 流程实例的分页 Item Response VO") +@Schema(description = "管理后台 - 流程实例的分页 Item Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmProcessInstanceMyPageReqVO extends PageParam { - @Schema(title = "流程名称", example = "芋道") + @Schema(description = "流程名称", example = "芋道") private String name; - @Schema(title = "流程定义的编号", example = "2048") + @Schema(description = "流程定义的编号", example = "2048") private String processDefinitionId; - @Schema(title = "流程实例的状态", description = "参见 bpm_process_instance_status", example = "1") + @Schema(description = "流程实例的状态-参见 bpm_process_instance_status", example = "1") private Integer status; - @Schema(title = "流程实例的结果", description = "参见 bpm_process_instance_result", example = "2") + @Schema(description = "流程实例的结果-参见 bpm_process_instance_result", example = "2") private Integer result; - @Schema(title = "流程分类", description = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类-参见 bpm_model_category 数据字典", example = "1") private String category; - @Schema(title = "创建时间") + @Schema(description = "创建时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime[] createTime; 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 c367eaf5a..c38274138 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 @@ -6,32 +6,32 @@ import lombok.Data; import java.time.LocalDateTime; import java.util.List; -@Schema(title = "管理后台 - 流程实例的分页 Item Response VO") +@Schema(description = "管理后台 - 流程实例的分页 Item Response VO") @Data public class BpmProcessInstancePageItemRespVO { - @Schema(title = "流程实例的编号", required = true, example = "1024") + @Schema(description = "流程实例的编号", required = true, example = "1024") private String id; - @Schema(title = "流程名称", required = true, example = "芋道") + @Schema(description = "流程名称", required = true, example = "芋道") private String name; - @Schema(title = "流程定义的编号", required = true, example = "2048") + @Schema(description = "流程定义的编号", required = true, example = "2048") private String processDefinitionId; - @Schema(title = "流程分类", required = true, description = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类-参见 bpm_model_category 数据字典", required = true, example = "1") private String category; - @Schema(title = "流程实例的状态", required = true, description = "参见 bpm_process_instance_status", example = "1") + @Schema(description = "流程实例的状态-参见 bpm_process_instance_status", required = true, example = "1") private Integer status; - @Schema(title = "流程实例的结果", required = true, description = "参见 bpm_process_instance_result", example = "2") + @Schema(description = "流程实例的结果-参见 bpm_process_instance_result", required = true, example = "2") private Integer result; - @Schema(title = "提交时间", required = true) + @Schema(description = "提交时间", required = true) private LocalDateTime createTime; - @Schema(title = "结束时间", required = true) + @Schema(description = "结束时间", required = true) private LocalDateTime endTime; /** @@ -39,14 +39,14 @@ public class BpmProcessInstancePageItemRespVO { */ private List tasks; - @Schema(title = "流程任务") + @Schema(description = "流程任务") @Data public static class Task { - @Schema(title = "流程任务的编号", required = true, example = "1024") + @Schema(description = "流程任务的编号", required = true, example = "1024") private String id; - @Schema(title = "任务名称", required = true, example = "芋道") + @Schema(description = "任务名称", required = true, example = "芋道") private String name; } 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 8d02aec71..5c6d381a0 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 @@ -7,35 +7,35 @@ import java.time.LocalDateTime; import java.util.List; import java.util.Map; -@Schema(title = "管理后台 - 流程实例的 Response VO") +@Schema(description = "管理后台 - 流程实例的 Response VO") @Data public class BpmProcessInstanceRespVO { - @Schema(title = "流程实例的编号", required = true, example = "1024") + @Schema(description = "流程实例的编号", required = true, example = "1024") private String id; - @Schema(title = "流程名称", required = true, example = "芋道") + @Schema(description = "流程名称", required = true, example = "芋道") private String name; - @Schema(title = "流程分类", required = true, description = "参见 bpm_model_category 数据字典", example = "1") + @Schema(description = "流程分类-参见 bpm_model_category 数据字典", required = true, example = "1") private String category; - @Schema(title = "流程实例的状态", required = true, description = "参见 bpm_process_instance_status", example = "1") + @Schema(description = "流程实例的状态-参见 bpm_process_instance_status", required = true, example = "1") private Integer status; - @Schema(title = "流程实例的结果", required = true, description = "参见 bpm_process_instance_result", example = "2") + @Schema(description = "流程实例的结果-参见 bpm_process_instance_result", required = true, example = "2") private Integer result; - @Schema(title = "提交时间", required = true) + @Schema(description = "提交时间", required = true) private LocalDateTime createTime; - @Schema(title = "结束时间", required = true) + @Schema(description = "结束时间", required = true) private LocalDateTime endTime; - @Schema(title = "提交的表单值", required = true) + @Schema(description = "提交的表单值", required = true) private Map formVariables; - @Schema(title = "业务的唯一标识", example = "1", description = "例如说，请假申请的编号") + @Schema(description = "业务的唯一标识-例如说，请假申请的编号", example = "1") private String businessKey; /** @@ -48,47 +48,45 @@ public class BpmProcessInstanceRespVO { */ private ProcessDefinition processDefinition; - @Schema(title = "用户信息") + @Schema(description = "用户信息") @Data public static class User { - @Schema(title = "用户编号", required = true, example = "1") + @Schema(description = "用户编号", required = true, example = "1") private Long id; - @Schema(title = "用户昵称", required = true, example = "芋艿") + @Schema(description = "用户昵称", required = true, example = "芋艿") private String nickname; - @Schema(title = "部门编号", required = true, example = "1") + @Schema(description = "部门编号", required = true, example = "1") private Long deptId; - @Schema(title = "部门名称", required = true, example = "研发部") + @Schema(description = "部门名称", required = true, example = "研发部") private String deptName; } - @Schema(title = "流程定义信息") + @Schema(description = "流程定义信息") @Data public static class ProcessDefinition { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") private String id; - @Schema(title = "表单类型", description = "参见 bpm_model_form_type 数据字典", example = "1") + @Schema(description = "表单类型-参见 bpm_model_form_type 数据字典", example = "1") private Integer formType; - @Schema(title = "表单编号", example = "1024", description = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单编号-在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", example = "1024") private Long formId; - @Schema(title = "表单的配置", required = true, - description = "JSON 字符串。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单的配置-JSON 字符串。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", required = true) private String formConf; - @Schema(title = "表单项的数组", required = true, - description = "JSON 字符串的数组。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "表单项的数组-JSON 字符串的数组。在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", required = true) private List formFields; - @Schema(title = "自定义表单的提交路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/create", - description = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的提交路径，使用 Vue 的路由地址-在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", + example = "/bpm/oa/leave/create") private String formCustomCreatePath; - @Schema(title = "自定义表单的查看路径，使用 Vue 的路由地址", example = "/bpm/oa/leave/view", - description = "在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空") + @Schema(description = "自定义表单的查看路径，使用 Vue 的路由地址-在表单类型为 {@link BpmModelFormTypeEnum#CUSTOM} 时，必须非空", + example = "/bpm/oa/leave/view") private String formCustomViewPath; - @Schema(title = "BPMN XML", required = true) + @Schema(description = "BPMN XML", required = true) private String bpmnXml; } diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskApproveReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskApproveReqVO.java index 5e023f2c1..5214f4650 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskApproveReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskApproveReqVO.java @@ -5,15 +5,15 @@ import lombok.Data; import javax.validation.constraints.NotEmpty; -@Schema(title = "管理后台 - 通过流程任务的 Request VO") +@Schema(description = "管理后台 - 通过流程任务的 Request VO") @Data public class BpmTaskApproveReqVO { - @Schema(title = "任务编号", required = true, example = "1024") + @Schema(description = "任务编号", required = true, example = "1024") @NotEmpty(message = "任务编号不能为空") private String id; - @Schema(title = "审批意见", required = true, example = "不错不错！") + @Schema(description = "审批意见", required = true, example = "不错不错！") @NotEmpty(message = "审批意见不能为空") 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/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 a77fb1002..12fa019d9 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 @@ -7,20 +7,20 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 流程任务的 Done 已完成的分页项 Response VO") +@Schema(description = "管理后台 - 流程任务的 Done 已完成的分页项 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmTaskDonePageItemRespVO extends BpmTaskTodoPageItemRespVO { - @Schema(title = "结束时间", required = true) + @Schema(description = "结束时间", required = true) private LocalDateTime endTime; - @Schema(title = "持续时间", required = true, example = "1000") + @Schema(description = "持续时间", required = true, example = "1000") private Long durationInMillis; - @Schema(title = "任务结果", required = true, description = "参见 bpm_process_instance_result", example = "2") + @Schema(description = "任务结果-参见 bpm_process_instance_result", required = true, example = "2") private Integer result; - @Schema(title = "审批建议", required = true, example = "不请假了！") + @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/BpmTaskDonePageReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskDonePageReqVO.java index fa152186c..52daea445 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskDonePageReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskDonePageReqVO.java @@ -11,20 +11,20 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 流程任务的 Done 已办的分页 Request VO") +@Schema(description = "管理后台 - 流程任务的 Done 已办的分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmTaskDonePageReqVO extends PageParam { - @Schema(title = "流程任务名", example = "芋道") + @Schema(description = "流程任务名", example = "芋道") private String name; - @Schema(title = "开始的创建收间") + @Schema(description = "开始的创建收间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime beginCreateTime; - @Schema(title = "结束的创建时间") + @Schema(description = "结束的创建时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime endCreateTime; diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskRejectReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskRejectReqVO.java index 1b7d0d34f..f51a69185 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskRejectReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskRejectReqVO.java @@ -5,15 +5,15 @@ import lombok.Data; import javax.validation.constraints.NotEmpty; -@Schema(title = "管理后台 - 不通过流程任务的 Request VO") +@Schema(description = "管理后台 - 不通过流程任务的 Request VO") @Data public class BpmTaskRejectReqVO { - @Schema(title = "任务编号", required = true, example = "1024") + @Schema(description = "任务编号", required = true, example = "1024") @NotEmpty(message = "任务编号不能为空") private String id; - @Schema(title = "审批意见", required = true, example = "不错不错！") + @Schema(description = "审批意见", required = true, example = "不错不错！") @NotEmpty(message = "审批意见不能为空") 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/BpmTaskRespVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskRespVO.java index df1e10764..9459c30c1 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskRespVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskRespVO.java @@ -5,13 +5,13 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 流程任务的 Response VO") +@Schema(description = "管理后台 - 流程任务的 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmTaskRespVO extends BpmTaskDonePageItemRespVO { - @Schema(title = "任务定义的标识", required = true, example = "user-001") + @Schema(description = "任务定义的标识", required = true, example = "user-001") private String definitionKey; /** @@ -19,18 +19,18 @@ public class BpmTaskRespVO extends BpmTaskDonePageItemRespVO { */ private User assigneeUser; - @Schema(title = "用户信息") + @Schema(description = "用户信息") @Data public static class User { - @Schema(title = "用户编号", required = true, example = "1") + @Schema(description = "用户编号", required = true, example = "1") private Long id; - @Schema(title = "用户昵称", required = true, example = "芋艿") + @Schema(description = "用户昵称", required = true, example = "芋艿") private String nickname; - @Schema(title = "部门编号", required = true, example = "1") + @Schema(description = "部门编号", required = true, example = "1") private Long deptId; - @Schema(title = "部门名称", required = true, example = "研发部") + @Schema(description = "部门名称", required = true, example = "研发部") private String deptName; } 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 dbcdb7c14..cc71e1b2f 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 @@ -5,23 +5,23 @@ import lombok.Data; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 流程任务的 Running 进行中的分页项 Response VO") +@Schema(description = "管理后台 - 流程任务的 Running 进行中的分页项 Response VO") @Data public class BpmTaskTodoPageItemRespVO { - @Schema(title = "任务编号", required = true, example = "1024") + @Schema(description = "任务编号", required = true, example = "1024") private String id; - @Schema(title = "任务名字", required = true, example = "芋道") + @Schema(description = "任务名字", required = true, example = "芋道") private String name; - @Schema(title = "接收时间", required = true) + @Schema(description = "接收时间", required = true) private LocalDateTime claimTime; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; - @Schema(title = "激活状态", required = true, example = "1", description = "参见 SuspensionState 枚举") + @Schema(description = "激活状态-参见 SuspensionState 枚举", required = true, example = "1") private Integer suspensionState; /** @@ -30,22 +30,22 @@ public class BpmTaskTodoPageItemRespVO { private ProcessInstance processInstance; @Data - @Schema(title = "流程实例") + @Schema(description = "流程实例") public static class ProcessInstance { - @Schema(title = "流程实例编号", required = true, example = "1024") + @Schema(description = "流程实例编号", required = true, example = "1024") private String id; - @Schema(title = "流程实例名称", required = true, example = "芋道") + @Schema(description = "流程实例名称", required = true, example = "芋道") private String name; - @Schema(title = "发起人的用户编号", required = true, example = "1024") + @Schema(description = "发起人的用户编号", required = true, example = "1024") private Long startUserId; - @Schema(title = "发起人的用户昵称", required = true, example = "芋艿") + @Schema(description = "发起人的用户昵称", required = true, example = "芋艿") private String startUserNickname; - @Schema(title = "流程定义的编号", required = true, example = "2048") + @Schema(description = "流程定义的编号", required = true, example = "2048") private String processDefinitionId; } diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskTodoPageReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskTodoPageReqVO.java index d4994e272..7a4437e92 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskTodoPageReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskTodoPageReqVO.java @@ -11,20 +11,20 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 流程任务的 TODO 待办的分页 Request VO") +@Schema(description = "管理后台 - 流程任务的 TODO 待办的分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BpmTaskTodoPageReqVO extends PageParam { - @Schema(title = "流程任务名", example = "芋道") + @Schema(description = "流程任务名", example = "芋道") private String name; - @Schema(title = "开始的创建收间") + @Schema(description = "开始的创建收间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime beginCreateTime; - @Schema(title = "结束的创建时间") + @Schema(description = "结束的创建时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime endCreateTime; diff --git a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskUpdateAssigneeReqVO.java b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskUpdateAssigneeReqVO.java index 0bd364043..d0990a142 100644 --- a/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskUpdateAssigneeReqVO.java +++ b/yudao-module-bpm/yudao-module-bpm-biz/src/main/java/cn/iocoder/yudao/module/bpm/controller/admin/task/vo/task/BpmTaskUpdateAssigneeReqVO.java @@ -9,15 +9,15 @@ import net.bytebuddy.implementation.bind.annotation.Empty; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 流程任务的更新负责人的 Request VO") +@Schema(description = "管理后台 - 流程任务的更新负责人的 Request VO") @Data public class BpmTaskUpdateAssigneeReqVO { - @Schema(title = "任务编号", required = true, example = "1024") + @Schema(description = "任务编号", required = true, example = "1024") @NotEmpty(message = "任务编号不能为空") private String id; - @Schema(title = "新审批人的用户编号", required = true, example = "2048") + @Schema(description = "新审批人的用户编号", required = true, example = "2048") @NotNull(message = "新审批人的用户编号不能为空") private Long assigneeUserId; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenCreateListReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenCreateListReqVO.java index c2a1497df..da9e2c674 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenCreateListReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenCreateListReqVO.java @@ -6,15 +6,15 @@ import lombok.Data; import javax.validation.constraints.NotNull; import java.util.List; -@Schema(title = "管理后台 - 基于数据库的表结构，创建代码生成器的表和字段定义 Request VO") +@Schema(description = "管理后台 - 基于数据库的表结构，创建代码生成器的表和字段定义 Request VO") @Data public class CodegenCreateListReqVO { - @Schema(title = "数据源配置的编号", required = true, example = "1") + @Schema(description = "数据源配置的编号", required = true, example = "1") @NotNull(message = "数据源配置的编号不能为空") private Long dataSourceConfigId; - @Schema(title = "表名数组", required = true, example = "[1, 2, 3]") + @Schema(description = "表名数组", required = true, example = "[1, 2, 3]") @NotNull(message = "表名数组不能为空") private List tableNames; 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 3b8e13e94..f7d8a62a4 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 @@ -7,14 +7,14 @@ import lombok.Data; import java.util.List; -@Schema(title = "管理后台 - 代码生成表和字段的明细 Response VO") +@Schema(description = "管理后台 - 代码生成表和字段的明细 Response VO") @Data public class CodegenDetailRespVO { - @Schema(name = "表定义") + @Schema(description = "表定义") private CodegenTableRespVO table; - @Schema(name = "字段定义") + @Schema(description = "字段定义") private List columns; } 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 597d4de8f..89e98e6c0 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 @@ -3,14 +3,14 @@ package cn.iocoder.yudao.module.infra.controller.admin.codegen.vo; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(title = "管理后台 - 代码生成预览 Response VO", description ="注意，每个文件都是一个该对象") +@Schema(description = "管理后台 - 代码生成预览 Response VO,注意，每个文件都是一个该对象") @Data public class CodegenPreviewRespVO { - @Schema(title = "文件路径", required = true, example = "java/cn/iocoder/yudao/adminserver/modules/system/controller/test/SysTestDemoController.java") + @Schema(description = "文件路径", required = true, example = "java/cn/iocoder/yudao/adminserver/modules/system/controller/test/SysTestDemoController.java") private String filePath; - @Schema(title = "代码", required = true, example = "Hello World") + @Schema(description = "代码", required = true, example = "Hello World") private String code; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenUpdateReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenUpdateReqVO.java index 8ccde1284..b10885868 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenUpdateReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/CodegenUpdateReqVO.java @@ -14,7 +14,7 @@ import javax.validation.constraints.AssertTrue; import javax.validation.constraints.NotNull; import java.util.List; -@Schema(title = "管理后台 - 代码生成表和字段的修改 Request VO") +@Schema(description = "管理后台 - 代码生成表和字段的修改 Request VO") @Data public class CodegenUpdateReqVO { @@ -26,14 +26,14 @@ public class CodegenUpdateReqVO { @NotNull(message = "字段定义不能为空") private List columns; - @Schema(title = "更新表定义") + @Schema(description = "更新表定义") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) @Valid public static class Table extends CodegenTableBaseVO { - @Schema(title = "编号", required = true, example = "1") + @Schema(description = "编号", required = true, example = "1") private Long id; @AssertTrue(message = "上级菜单不能为空") @@ -45,13 +45,13 @@ public class CodegenUpdateReqVO { } - @Schema(title = "更新表定义") + @Schema(description = "更新表定义") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public static class Column extends CodegenColumnBaseVO { - @Schema(title = "编号", required = true, example = "1") + @Schema(description = "编号", required = true, example = "1") private Long id; } 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 f9a3a668b..abbb30983 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 @@ -11,73 +11,73 @@ import javax.validation.constraints.NotNull; @Data public class CodegenColumnBaseVO { - @Schema(title = "表编号", required = true, example = "1") + @Schema(description = "表编号", required = true, example = "1") @NotNull(message = "表编号不能为空") private Long tableId; - @Schema(title = "字段名", required = true, example = "user_age") + @Schema(description = "字段名", required = true, example = "user_age") @NotNull(message = "字段名不能为空") private String columnName; - @Schema(title = "字段类型", required = true, example = "int(11)") + @Schema(description = "字段类型", required = true, example = "int(11)") @NotNull(message = "字段类型不能为空") private String dataType; - @Schema(title = "字段描述", required = true, example = "年龄") + @Schema(description = "字段描述", required = true, example = "年龄") @NotNull(message = "字段描述不能为空") private String columnComment; - @Schema(title = "是否允许为空", required = true, example = "true") + @Schema(description = "是否允许为空", required = true, example = "true") @NotNull(message = "是否允许为空不能为空") private Boolean nullable; - @Schema(title = "是否主键", required = true, example = "false") + @Schema(description = "是否主键", required = true, example = "false") @NotNull(message = "是否主键不能为空") private Boolean primaryKey; - @Schema(title = "是否自增", required = true, example = "true") + @Schema(description = "是否自增", required = true, example = "true") @NotNull(message = "是否自增不能为空") private String autoIncrement; - @Schema(title = "排序", required = true, example = "10") + @Schema(description = "排序", required = true, example = "10") @NotNull(message = "排序不能为空") private Integer ordinalPosition; - @Schema(title = "Java 属性类型", required = true, example = "userAge") + @Schema(description = "Java 属性类型", required = true, example = "userAge") @NotNull(message = "Java 属性类型不能为空") private String javaType; - @Schema(title = "Java 属性名", required = true, example = "Integer") + @Schema(description = "Java 属性名", required = true, example = "Integer") @NotNull(message = "Java 属性名不能为空") private String javaField; - @Schema(title = "字典类型", example = "sys_gender") + @Schema(description = "字典类型", example = "sys_gender") private String dictType; - @Schema(title = "数据示例", example = "1024") + @Schema(description = "数据示例", example = "1024") private String example; - @Schema(title = "是否为 Create 创建操作的字段", required = true, example = "true") + @Schema(description = "是否为 Create 创建操作的字段", required = true, example = "true") @NotNull(message = "是否为 Create 创建操作的字段不能为空") private Boolean createOperation; - @Schema(title = "是否为 Update 更新操作的字段", required = true, example = "false") + @Schema(description = "是否为 Update 更新操作的字段", required = true, example = "false") @NotNull(message = "是否为 Update 更新操作的字段不能为空") private Boolean updateOperation; - @Schema(title = "是否为 List 查询操作的字段", required = true, example = "true") + @Schema(description = "是否为 List 查询操作的字段", required = true, example = "true") @NotNull(message = "是否为 List 查询操作的字段不能为空") private Boolean listOperation; - @Schema(title = "List 查询操作的条件类型", required = true, example = "LIKE", description = "参见 CodegenColumnListConditionEnum 枚举") + @Schema(description = "List 查询操作的条件类型,参见 CodegenColumnListConditionEnum 枚举", required = true, example = "LIKE") @NotNull(message = "List 查询操作的条件类型不能为空") private String listOperationCondition; - @Schema(title = "是否为 List 查询操作的返回字段", required = true, example = "true") + @Schema(description = "是否为 List 查询操作的返回字段", required = true, example = "true") @NotNull(message = "是否为 List 查询操作的返回字段不能为空") private Boolean listOperationResult; - @Schema(title = "显示类型", required = true, example = "input") + @Schema(description = "显示类型", required = true, example = "input") @NotNull(message = "显示类型不能为空") private String htmlType; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/column/CodegenColumnRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/column/CodegenColumnRespVO.java index c5abfa1e1..1ef17b0ea 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/column/CodegenColumnRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/column/CodegenColumnRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 代码生成字段定义 Response VO") +@Schema(description = "管理后台 - 代码生成字段定义 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class CodegenColumnRespVO extends CodegenColumnBaseVO { - @Schema(title = "编号", required = true, example = "1") + @Schema(description = "编号", required = true, example = "1") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } 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 01cb907f4..11ed1144a 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 @@ -5,52 +5,52 @@ import lombok.Data; import javax.validation.constraints.NotNull; /** -* 代码生成 Base VO，提供给添加、修改、详细的子 VO 使用 -* 如果子 VO 存在差异的字段，请不要添加到这里，影响 Swagger 文档生成 -*/ + * 代码生成 Base VO，提供给添加、修改、详细的子 VO 使用 + * 如果子 VO 存在差异的字段，请不要添加到这里，影响 Swagger 文档生成 + */ @Data public class CodegenTableBaseVO { - @Schema(title = "生成场景", required = true, example = "1", description = "参见 CodegenSceneEnum 枚举") + @Schema(description = "生成场景,参见 CodegenSceneEnum 枚举", required = true, example = "1") @NotNull(message = "导入类型不能为空") private Integer scene; - @Schema(title = "表名称", required = true, example = "yudao") + @Schema(description = "表名称", required = true, example = "yudao") @NotNull(message = "表名称不能为空") private String tableName; - @Schema(title = "表描述", required = true, example = "芋道") + @Schema(description = "表描述", required = true, example = "芋道") @NotNull(message = "表描述不能为空") private String tableComment; - @Schema(title = "备注", example = "我是备注") + @Schema(description = "备注", example = "我是备注") private String remark; - @Schema(title = "模块名", required = true, example = "system") + @Schema(description = "模块名", required = true, example = "system") @NotNull(message = "模块名不能为空") private String moduleName; - @Schema(title = "业务名", required = true, example = "codegen") + @Schema(description = "业务名", required = true, example = "codegen") @NotNull(message = "业务名不能为空") private String businessName; - @Schema(title = "类名称", required = true, example = "CodegenTable") + @Schema(description = "类名称", required = true, example = "CodegenTable") @NotNull(message = "类名称不能为空") private String className; - @Schema(title = "类描述", required = true, example = "代码生成器的表定义") + @Schema(description = "类描述", required = true, example = "代码生成器的表定义") @NotNull(message = "类描述不能为空") private String classComment; - @Schema(title = "作者", required = true, example = "芋道源码") + @Schema(description = "作者", required = true, example = "芋道源码") @NotNull(message = "作者不能为空") private String author; - @Schema(title = "模板类型", required = true, example = "1", description = "参见 CodegenTemplateTypeEnum 枚举") + @Schema(description = "模板类型，参见 CodegenTemplateTypeEnum 枚举", required = true, example = "1") @NotNull(message = "模板类型不能为空") private Integer templateType; - @Schema(title = "父菜单编号", example = "1024") + @Schema(description = "父菜单编号", example = "1024") private Long parentMenuId; } 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 648869d7b..bc93e73ea 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 @@ -11,19 +11,19 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 表定义分页 Request VO") +@Schema(description = "管理后台 - 表定义分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class CodegenTablePageReqVO extends PageParam { - @Schema(title = "表名称", example = "yudao", description = "模糊匹配") + @Schema(description = "表名称,模糊匹配", example = "yudao") private String tableName; - @Schema(title = "表描述", example = "芋道", description = "模糊匹配") + @Schema(description = "表描述,模糊匹配", example = "芋道") private String tableComment; - @Schema(title = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") + @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[] createTime; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/CodegenTableRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/CodegenTableRespVO.java index 4703fa4ae..af45018bd 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/CodegenTableRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/CodegenTableRespVO.java @@ -7,22 +7,22 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 代码生成表定义 Response VO") +@Schema(description = "管理后台 - 代码生成表定义 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class CodegenTableRespVO extends CodegenTableBaseVO { - @Schema(title = "编号", required = true, example = "1") + @Schema(description = "编号", required = true, example = "1") private Long id; - @Schema(title = "主键编号", required = true, example = "1024") + @Schema(description = "主键编号", required = true, example = "1024") private Integer dataSourceConfigId; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; - @Schema(title = "更新时间", required = true) + @Schema(description = "更新时间", required = true) private LocalDateTime updateTime; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/DatabaseTableRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/DatabaseTableRespVO.java index e2541666e..61668db15 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/DatabaseTableRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/codegen/vo/table/DatabaseTableRespVO.java @@ -3,14 +3,14 @@ package cn.iocoder.yudao.module.infra.controller.admin.codegen.vo.table; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(title = "管理后台 - 数据库的表定义 Response VO") +@Schema(description = "管理后台 - 数据库的表定义 Response VO") @Data public class DatabaseTableRespVO { - @Schema(title = "表名称", required = true, example = "yuanma") + @Schema(description = "表名称", required = true, example = "yuanma") private String name; - @Schema(title = "表描述", required = true, example = "芋道源码") + @Schema(description = "表描述", required = true, example = "芋道源码") private String comment; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigBaseVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigBaseVO.java index acd680290..155b2da81 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigBaseVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigBaseVO.java @@ -14,26 +14,26 @@ import javax.validation.constraints.Size; @Data public class ConfigBaseVO { - @Schema(title = "参数分组", required = true, example = "biz") + @Schema(description = "参数分组", required = true, example = "biz") @NotEmpty(message = "参数分组不能为空") @Size(max = 50, message = "参数名称不能超过50个字符") private String category; - @Schema(title = "参数名称", required = true, example = "数据库名") + @Schema(description = "参数名称", required = true, example = "数据库名") @NotBlank(message = "参数名称不能为空") @Size(max = 100, message = "参数名称不能超过100个字符") private String name; - @Schema(title = "参数键值", required = true, example = "1024") + @Schema(description = "参数键值", required = true, example = "1024") @NotBlank(message = "参数键值不能为空") @Size(max = 500, message = "参数键值长度不能超过500个字符") private String value; - @Schema(title = "是否敏感", required = true, example = "true") + @Schema(description = "是否敏感", required = true, example = "true") @NotNull(message = "是否敏感不能为空") private Boolean visible; - @Schema(title = "备注", example = "备注一下很帅气！") + @Schema(description = "备注", example = "备注一下很帅气！") private String remark; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigCreateReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigCreateReqVO.java index d9d369b20..186629b0f 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigCreateReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigCreateReqVO.java @@ -7,12 +7,12 @@ import lombok.EqualsAndHashCode; import javax.validation.constraints.NotBlank; import javax.validation.constraints.Size; -@Schema(title = "管理后台 - 参数配置创建 Request VO") +@Schema(description = "管理后台 - 参数配置创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class ConfigCreateReqVO extends ConfigBaseVO { - @Schema(title = "参数键名", required = true, example = "yunai.db.username") + @Schema(description = "参数键名", required = true, example = "yunai.db.username") @NotBlank(message = "参数键名长度不能为空") @Size(max = 100, message = "参数键名长度不能超过100个字符") private String key; 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 6bcf83a86..f0f4b4ff3 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 @@ -8,20 +8,20 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 参数配置导出 Request VO") +@Schema(description = "管理后台 - 参数配置导出 Request VO") @Data public class ConfigExportReqVO { - @Schema(title = "参数名称", example = "模糊匹配") + @Schema(description = "参数名称", example = "模糊匹配") private String name; - @Schema(title = "参数键名", example = "yunai.db.username", description = "模糊匹配") + @Schema(description = "参数键名,模糊匹配", example = "yunai.db.username") private String key; - @Schema(title = "参数类型", example = "1", description = "参见 SysConfigTypeEnum 枚举") + @Schema(description = "参数类型,参见 SysConfigTypeEnum 枚举", example = "1") private Integer type; - @Schema(title = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") + @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[] createTime; 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 34d9e5d88..8f87d6ee9 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 @@ -11,22 +11,22 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 参数配置分页 Request VO") +@Schema(description = "管理后台 - 参数配置分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ConfigPageReqVO extends PageParam { - @Schema(title = "数据源名称", example = "模糊匹配") + @Schema(description = "数据源名称,模糊匹配", example = "名称") private String name; - @Schema(title = "参数键名", example = "yunai.db.username", description = "模糊匹配") + @Schema(description = "参数键名,模糊匹配", example = "yunai.db.username") private String key; - @Schema(title = "参数类型", example = "1", description = "参见 SysConfigTypeEnum 枚举") + @Schema(description = "参数类型,参见 SysConfigTypeEnum 枚举", example = "1") private Integer type; - @Schema(title = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") + @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[] createTime; 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 e9746f9a4..738cd6481 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 @@ -8,23 +8,23 @@ import javax.validation.constraints.NotBlank; import javax.validation.constraints.Size; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 参数配置信息 Response VO") +@Schema(description = "管理后台 - 参数配置信息 Response VO") @Data @EqualsAndHashCode(callSuper = true) public class ConfigRespVO extends ConfigBaseVO { - @Schema(title = "参数配置序号", required = true, example = "1024") + @Schema(description = "参数配置序号", required = true, example = "1024") private Long id; - @Schema(title = "参数键名", required = true, example = "yunai.db.username") + @Schema(description = "参数键名", required = true, example = "yunai.db.username") @NotBlank(message = "参数键名长度不能为空") @Size(max = 100, message = "参数键名长度不能超过100个字符") private String key; - @Schema(title = "参数类型", required = true, example = "1", description = "参见 SysConfigTypeEnum 枚举") + @Schema(description = "参数类型,参见 SysConfigTypeEnum 枚举", required = true, example = "1") private Integer type; - @Schema(title = "创建时间", required = true, example = "时间戳格式") + @Schema(description = "创建时间", required = true, example = "时间戳格式") private LocalDateTime createTime; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigUpdateReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigUpdateReqVO.java index 175f8a4dc..efa689d42 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigUpdateReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/config/vo/ConfigUpdateReqVO.java @@ -7,13 +7,13 @@ import lombok.ToString; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 参数配置创建 Request VO") +@Schema(description = "管理后台 - 参数配置创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ConfigUpdateReqVO extends ConfigBaseVO { - @Schema(title = "参数配置序号", required = true, example = "1024") + @Schema(description = "参数配置序号", required = true, example = "1024") @NotNull(message = "参数配置编号不能为空") private Long id; 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 53230df01..a757b0882 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 @@ -10,15 +10,15 @@ import javax.validation.constraints.*; @Data public class DataSourceConfigBaseVO { - @Schema(title = "数据源名称", required = true, example = "test") + @Schema(description = "数据源名称", required = true, example = "test") @NotNull(message = "数据源名称不能为空") private String name; - @Schema(title = "数据源连接", required = true, example = "jdbc:mysql://127.0.0.1:3306/ruoyi-vue-pro") + @Schema(description = "数据源连接", required = true, example = "jdbc:mysql://127.0.0.1:3306/ruoyi-vue-pro") @NotNull(message = "数据源连接不能为空") private String url; - @Schema(title = "用户名", required = true, example = "root") + @Schema(description = "用户名", required = true, example = "root") @NotNull(message = "用户名不能为空") private String username; 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 9f244c817..e8f4cc97d 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 @@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 数据源配置创建 Request VO") +@Schema(description = "管理后台 - 数据源配置创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class DataSourceConfigCreateReqVO extends DataSourceConfigBaseVO { - @Schema(title = "密码", required = true, example = "123456") + @Schema(description = "密码", required = true, example = "123456") @NotNull(message = "密码不能为空") private String password; 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 2f3b02faf..02bdff415 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 @@ -4,16 +4,16 @@ import lombok.*; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 数据源配置 Response VO") +@Schema(description = "管理后台 - 数据源配置 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class DataSourceConfigRespVO extends DataSourceConfigBaseVO { - @Schema(title = "主键编号", required = true, example = "1024") + @Schema(description = "主键编号", required = true, example = "1024") private Integer id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } 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 019ed0a20..5fac798ea 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 @@ -3,17 +3,17 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 数据源配置更新 Request VO") +@Schema(description = "管理后台 - 数据源配置更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class DataSourceConfigUpdateReqVO extends DataSourceConfigBaseVO { - @Schema(title = "主键编号", required = true, example = "1024") + @Schema(description = "主键编号", required = true, example = "1024") @NotNull(message = "主键编号不能为空") private Long id; - @Schema(title = "密码", required = true, example = "123456") + @Schema(description = "密码", required = true, example = "123456") @NotNull(message = "密码不能为空") private String password; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigBaseVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigBaseVO.java index c9a1f9e4d..d7bc42d73 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigBaseVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigBaseVO.java @@ -11,11 +11,11 @@ import javax.validation.constraints.NotNull; @Data public class FileConfigBaseVO { - @Schema(title = "配置名", required = true, example = "S3 - 阿里云") + @Schema(description = "配置名", required = true, example = "S3 - 阿里云") @NotNull(message = "配置名不能为空") private String name; - @Schema(title = "备注", example = "我是备注") + @Schema(description = "备注", example = "我是备注") private String remark; } 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 10602bfd9..db64205f4 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 @@ -8,17 +8,17 @@ import lombok.ToString; import javax.validation.constraints.NotNull; import java.util.Map; -@Schema(title = "管理后台 - 文件配置创建 Request VO") +@Schema(description = "管理后台 - 文件配置创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class FileConfigCreateReqVO extends FileConfigBaseVO { - @Schema(title = "存储器", required = true, example = "1", description = "参见 FileStorageEnum 枚举类") + @Schema(description = "存储器,参见 FileStorageEnum 枚举类参见 FileStorageEnum 枚举类", required = true, example = "1") @NotNull(message = "存储器不能为空") private Integer storage; - @Schema(title = "存储配置", required = true, description = "配置是动态参数，所以使用 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/FileConfigPageReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigPageReqVO.java index a8888f788..9d254adb1 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigPageReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/file/vo/config/FileConfigPageReqVO.java @@ -11,20 +11,20 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 文件配置分页 Request VO") +@Schema(description = "管理后台 - 文件配置分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class FileConfigPageReqVO extends PageParam { - @Schema(title = "配置名", example = "S3 - 阿里云") + @Schema(description = "配置名", example = "S3 - 阿里云") private String name; - @Schema(title = "存储器", example = "1") + @Schema(description = "存储器", example = "1") private Integer storage; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } 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 25f1ebec3..ae194cd31 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 @@ -9,27 +9,27 @@ import lombok.ToString; import javax.validation.constraints.NotNull; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 文件配置 Response VO") +@Schema(description = "管理后台 - 文件配置 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class FileConfigRespVO extends FileConfigBaseVO { - @Schema(title = "编号", required = true, example = "1") + @Schema(description = "编号", required = true, example = "1") private Long id; - @Schema(title = "存储器", required = true, example = "1", description = "参见 FileStorageEnum 枚举类") + @Schema(description = "存储器,参见 FileStorageEnum 枚举类", required = true, example = "1") @NotNull(message = "存储器不能为空") private Integer storage; - @Schema(title = "是否为主配置", required = true, example = "true") + @Schema(description = "是否为主配置", required = true, example = "true") @NotNull(message = "是否为主配置不能为空") private Boolean master; - @Schema(title = "存储配置", required = true) + @Schema(description = "存储配置", required = true) private FileClientConfig config; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } 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 079c67dc8..cd0c10802 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 @@ -8,17 +8,17 @@ import lombok.ToString; import javax.validation.constraints.NotNull; import java.util.Map; -@Schema(title = "管理后台 - 文件配置更新 Request VO") +@Schema(description = "管理后台 - 文件配置更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class FileConfigUpdateReqVO extends FileConfigBaseVO { - @Schema(title = "编号", required = true, example = "1") + @Schema(description = "编号", required = true, example = "1") @NotNull(message = "编号不能为空") private Long id; - @Schema(title = "存储配置", required = true, description = "配置是动态参数，所以使用 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 823a65bd5..fa8b84eef 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 @@ -11,20 +11,20 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 文件分页 Request VO") +@Schema(description = "管理后台 - 文件分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class FilePageReqVO extends PageParam { - @Schema(title = "文件路径", example = "yudao", description = "模糊匹配") + @Schema(description = "文件路径,模糊匹配", example = "yudao") private String path; - @Schema(title = "文件类型", example = "application/octet-stream", description = "模糊匹配") + @Schema(description = "文件类型,模糊匹配", example = "application/octet-stream") private String type; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } 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 beccb8ccd..80607d8d0 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 @@ -5,32 +5,32 @@ import lombok.Data; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 文件 Response VO", description = "不返回 content 字段，太大") +@Schema(description = "管理后台 - 文件 Response VO,不返回 content 字段，太大") @Data public class FileRespVO { - @Schema(title = "文件编号", required = true, example = "1024") + @Schema(description = "文件编号", required = true, example = "1024") private Long id; - @Schema(title = "配置编号", required = true, example = "11") + @Schema(description = "配置编号", required = true, example = "11") private Long configId; - @Schema(title = "文件路径", required = true, example = "yudao.jpg") + @Schema(description = "文件路径", required = true, example = "yudao.jpg") private String path; - @Schema(title = "原文件名", required = true, example = "yudao.jpg") + @Schema(description = "原文件名", required = true, example = "yudao.jpg") private String name; - @Schema(title = "文件 URL", required = true, example = "https://www.iocoder.cn/yudao.jpg") + @Schema(description = "文件 URL", required = true, example = "https://www.iocoder.cn/yudao.jpg") private String url; - @Schema(title = "文件MIME类型", example = "application/octet-stream") + @Schema(description = "文件MIME类型", example = "application/octet-stream") private String type; - @Schema(title = "文件大小", example = "2048", required = true) + @Schema(description = "文件大小", example = "2048", required = true) private Integer size; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } 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 06b54a34d..7a4dcb1c2 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 @@ -6,15 +6,15 @@ import org.springframework.web.multipart.MultipartFile; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 上传文件 Request VO") +@Schema(description = "管理后台 - 上传文件 Request VO") @Data public class FileUploadReqVO { - @Schema(title = "文件附件", required = true) + @Schema(description = "文件附件", required = true) @NotNull(message = "文件附件不能为空") private MultipartFile file; - @Schema(title = "文件附件", example = "yudaoyuanma.png") + @Schema(description = "文件附件", example = "yudaoyuanma.png") private String path; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobBaseVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobBaseVO.java index 9cbecd604..e5927fe14 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobBaseVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobBaseVO.java @@ -11,26 +11,26 @@ import javax.validation.constraints.NotNull; @Data public class JobBaseVO { - @Schema(title = "任务名称", required = true, example = "测试任务") + @Schema(description = "任务名称", required = true, example = "测试任务") @NotNull(message = "任务名称不能为空") private String name; - @Schema(title = "处理器的参数", example = "yudao") + @Schema(description = "处理器的参数", example = "yudao") private String handlerParam; - @Schema(title = "CRON 表达式", required = true, example = "0/10 * * * * ? *") + @Schema(description = "CRON 表达式", required = true, example = "0/10 * * * * ? *") @NotNull(message = "CRON 表达式不能为空") private String cronExpression; - @Schema(title = "重试次数", required = true, example = "3") + @Schema(description = "重试次数", required = true, example = "3") @NotNull(message = "重试次数不能为空") private Integer retryCount; - @Schema(title = "重试间隔", required = true, example = "1000") + @Schema(description = "重试间隔", required = true, example = "1000") @NotNull(message = "重试间隔不能为空") private Integer retryInterval; - @Schema(title = "监控超时时间", example = "1000") + @Schema(description = "监控超时时间", example = "1000") private Integer monitorTimeout; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobCreateReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobCreateReqVO.java index f4cd23a53..528392b52 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobCreateReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobCreateReqVO.java @@ -7,13 +7,13 @@ import lombok.ToString; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 定时任务创建 Request VO") +@Schema(description = "管理后台 - 定时任务创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class JobCreateReqVO extends JobBaseVO { - @Schema(title = "处理器的名字", required = true, example = "sysUserSessionTimeoutJob") + @Schema(description = "处理器的名字", required = true, example = "sysUserSessionTimeoutJob") @NotNull(message = "处理器的名字不能为空") private String handlerName; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobExportReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobExportReqVO.java index 530d8fc99..49b7e83d3 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobExportReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobExportReqVO.java @@ -3,17 +3,17 @@ package cn.iocoder.yudao.module.infra.controller.admin.job.vo.job; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(title = "管理后台 - 定时任务 Excel 导出 Request VO", description = "参数和 JobPageReqVO 是一致的") +@Schema(description = "管理后台 - 定时任务 Excel 导出 Request VO-参数和 JobPageReqVO 是一致的") @Data public class JobExportReqVO { - @Schema(title = "任务名称", example = "测试任务", description = "模糊匹配") + @Schema(description = "任务名称-模糊匹配", example = "测试任务") private String name; - @Schema(title = "任务状态", example = "1", description = "参见 JobStatusEnum 枚举") + @Schema(description = "任务状态-参见 JobStatusEnum 枚举", example = "1") private Integer status; - @Schema(title = "处理器的名字", example = "UserSessionTimeoutJob", description = "模糊匹配") + @Schema(description = "处理器的名字-模糊匹配", example = "UserSessionTimeoutJob") private String handlerName; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobPageReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobPageReqVO.java index 860a14546..670c30f5c 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobPageReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobPageReqVO.java @@ -6,19 +6,19 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 定时任务分页 Request VO") +@Schema(description = "管理后台 - 定时任务分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class JobPageReqVO extends PageParam { - @Schema(title = "任务名称", example = "测试任务", description = "模糊匹配") + @Schema(description = "任务名称,模糊匹配", example = "测试任务") private String name; - @Schema(title = "任务状态", example = "1", description = "参见 JobStatusEnum 枚举") + @Schema(description = "任务状态,参见 JobStatusEnum 枚举", example = "1") private Integer status; - @Schema(title = "处理器的名字", example = "sysUserSessionTimeoutJob", description = "模糊匹配") + @Schema(description = "处理器的名字,模糊匹配", example = "sysUserSessionTimeoutJob") private String handlerName; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobRespVO.java index fc0c4cc97..be73b1a06 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobRespVO.java @@ -8,23 +8,23 @@ import lombok.ToString; import javax.validation.constraints.NotNull; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 定时任务 Response VO") +@Schema(description = "管理后台 - 定时任务 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class JobRespVO extends JobBaseVO { - @Schema(title = "任务编号", required = true, example = "1024") + @Schema(description = "任务编号", required = true, example = "1024") private Long id; - @Schema(title = "任务状态", required = true, example = "1") + @Schema(description = "任务状态", required = true, example = "1") private Integer status; - @Schema(title = "处理器的名字", required = true, example = "sysUserSessionTimeoutJob") + @Schema(description = "处理器的名字", required = true, example = "sysUserSessionTimeoutJob") @NotNull(message = "处理器的名字不能为空") private String handlerName; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobUpdateReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobUpdateReqVO.java index 013522be1..9587888b6 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobUpdateReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/job/JobUpdateReqVO.java @@ -7,13 +7,13 @@ import lombok.ToString; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 定时任务更新 Request VO") +@Schema(description = "管理后台 - 定时任务更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class JobUpdateReqVO extends JobBaseVO { - @Schema(title = "任务编号", required = true, example = "1024") + @Schema(description = "任务编号", required = true, example = "1024") @NotNull(message = "任务编号不能为空") private Long id; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogBaseVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogBaseVO.java index 03863815f..de95ca38d 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogBaseVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogBaseVO.java @@ -15,38 +15,38 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @Data public class JobLogBaseVO { - @Schema(title = "任务编号", required = true, example = "1024") + @Schema(description = "任务编号", required = true, example = "1024") @NotNull(message = "任务编号不能为空") private Long jobId; - @Schema(title = "处理器的名字", required = true, example = "sysUserSessionTimeoutJob") + @Schema(description = "处理器的名字", required = true, example = "sysUserSessionTimeoutJob") @NotNull(message = "处理器的名字不能为空") private String handlerName; - @Schema(title = "处理器的参数", example = "yudao") + @Schema(description = "处理器的参数", example = "yudao") private String handlerParam; - @Schema(title = "第几次执行", required = true, example = "1") + @Schema(description = "第几次执行", required = true, example = "1") @NotNull(message = "第几次执行不能为空") private Integer executeIndex; - @Schema(title = "开始执行时间", required = true) + @Schema(description = "开始执行时间", required = true) @NotNull(message = "开始执行时间不能为空") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime beginTime; - @Schema(title = "结束执行时间") + @Schema(description = "结束执行时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime endTime; - @Schema(title = "执行时长", example = "123") + @Schema(description = "执行时长", example = "123") private Integer duration; - @Schema(title = "任务状态", required = true, example = "1", description = "参见 JobLogStatusEnum 枚举") + @Schema(description = "任务状态,参见 JobLogStatusEnum 枚举", required = true, example = "1") @NotNull(message = "任务状态不能为空") private Integer status; - @Schema(title = "结果数据", example = "执行成功") + @Schema(description = "结果数据", example = "执行成功") private String result; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogExportReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogExportReqVO.java index 8a4c468a4..6f5c7f69f 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogExportReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogExportReqVO.java @@ -8,25 +8,25 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 定时任务 Excel 导出 Request VO", description = "参数和 JobLogPageReqVO 是一致的") +@Schema(description = "管理后台 - 定时任务 Excel 导出 Request VO,参数和 JobLogPageReqVO 是一致的") @Data public class JobLogExportReqVO { - @Schema(title = "任务编号", example = "10") + @Schema(description = "任务编号", example = "10") private Long jobId; - @Schema(title = "处理器的名字", description = "模糊匹配") + @Schema(description = "处理器的名字,模糊匹配") private String handlerName; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "开始执行时间") + @Schema(description = "开始执行时间") private LocalDateTime beginTime; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "结束执行时间") + @Schema(description = "结束执行时间") private LocalDateTime endTime; - @Schema(title = "任务状态", description = "参见 JobLogStatusEnum 枚举") + @Schema(description = "任务状态,参见 JobLogStatusEnum 枚举") private Integer status; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogPageReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogPageReqVO.java index 6be08ce52..84bf9ca34 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogPageReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogPageReqVO.java @@ -11,27 +11,27 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 定时任务日志分页 Request VO") +@Schema(description = "管理后台 - 定时任务日志分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class JobLogPageReqVO extends PageParam { - @Schema(title = "任务编号", example = "10") + @Schema(description = "任务编号", example = "10") private Long jobId; - @Schema(title = "处理器的名字", description = "模糊匹配") + @Schema(description = "处理器的名字,模糊匹配") private String handlerName; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "开始执行时间") + @Schema(description = "开始执行时间") private LocalDateTime beginTime; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "结束执行时间") + @Schema(description = "结束执行时间") private LocalDateTime endTime; - @Schema(title = "任务状态", description = "参见 JobLogStatusEnum 枚举") + @Schema(description = "任务状态,参见 JobLogStatusEnum 枚举") private Integer status; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogRespVO.java index e0412950b..79cce519b 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/job/vo/log/JobLogRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 定时任务日志 Response VO") +@Schema(description = "管理后台 - 定时任务日志 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class JobLogRespVO extends JobLogBaseVO { - @Schema(title = "日志编号", required = true, example = "1024") + @Schema(description = "日志编号", required = true, example = "1024") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } 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 e819c3d81..ec2a8e377 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 @@ -15,60 +15,60 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @Data public class ApiAccessLogBaseVO { - @Schema(title = "链路追踪编号", required = true, example = "66600cb6-7852-11eb-9439-0242ac130002") + @Schema(description = "链路追踪编号", required = true, example = "66600cb6-7852-11eb-9439-0242ac130002") @NotNull(message = "链路追踪编号不能为空") private String traceId; - @Schema(title = "用户编号", required = true, example = "666") + @Schema(description = "用户编号", required = true, example = "666") @NotNull(message = "用户编号不能为空") private Long userId; - @Schema(title = "用户类型", required = true, example = "2", description = "参见 UserTypeEnum 枚举") + @Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2") @NotNull(message = "用户类型不能为空") private Integer userType; - @Schema(title = "应用名", required = true, example = "dashboard") + @Schema(description = "应用名", required = true, example = "dashboard") @NotNull(message = "应用名不能为空") private String applicationName; - @Schema(title = "请求方法名", required = true, example = "GET") + @Schema(description = "请求方法名", required = true, example = "GET") @NotNull(message = "请求方法名不能为空") private String requestMethod; - @Schema(title = "请求地址", required = true, example = "/xxx/yyy") + @Schema(description = "请求地址", required = true, example = "/xxx/yyy") @NotNull(message = "请求地址不能为空") private String requestUrl; - @Schema(title = "请求参数") + @Schema(description = "请求参数") private String requestParams; - @Schema(title = "用户 IP", required = true, example = "127.0.0.1") + @Schema(description = "用户 IP", required = true, example = "127.0.0.1") @NotNull(message = "用户 IP不能为空") private String userIp; - @Schema(title = "浏览器 UA", required = true, example = "Mozilla/5.0") + @Schema(description = "浏览器 UA", required = true, example = "Mozilla/5.0") @NotNull(message = "浏览器 UA不能为空") private String userAgent; - @Schema(title = "开始请求时间", required = true) + @Schema(description = "开始请求时间", required = true) @NotNull(message = "开始请求时间不能为空") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime beginTime; - @Schema(title = "结束请求时间", required = true) + @Schema(description = "结束请求时间", required = true) @NotNull(message = "结束请求时间不能为空") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime endTime; - @Schema(title = "执行时长", required = true, example = "100") + @Schema(description = "执行时长", required = true, example = "100") @NotNull(message = "执行时长不能为空") private Integer duration; - @Schema(title = "结果码", required = true, example = "0") + @Schema(description = "结果码", required = true, example = "0") @NotNull(message = "结果码不能为空") private Integer resultCode; - @Schema(title = "结果提示", example = "芋道源码，牛逼！") + @Schema(description = "结果提示", example = "芋道源码，牛逼！") private String resultMsg; } 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 70cd57afe..8894b82f8 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 @@ -8,30 +8,30 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - API 访问日志 Excel 导出 Request VO", description = "参数和 ApiAccessLogPageReqVO 是一致的") +@Schema(description = "管理后台 - API 访问日志 Excel 导出 Request VO,参数和 ApiAccessLogPageReqVO 是一致的") @Data public class ApiAccessLogExportReqVO { - @Schema(title = "用户编号", example = "666") + @Schema(description = "用户编号", example = "666") private Long userId; - @Schema(title = "用户类型", example = "2") + @Schema(description = "用户类型", example = "2") private Integer userType; - @Schema(title = "应用名", example = "dashboard") + @Schema(description = "应用名", example = "dashboard") private String applicationName; - @Schema(title = "请求地址", example = "/xxx/yyy", description = "模糊匹配") + @Schema(description = "请求地址,模糊匹配", example = "/xxx/yyy") private String requestUrl; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "开始请求时间") + @Schema(description = "开始请求时间") private LocalDateTime[] beginTime; - @Schema(title = "执行时长", example = "100", description = "大于等于，单位：毫秒") + @Schema(description = "执行时长,大于等于，单位：毫秒", example = "100") private Integer duration; - @Schema(title = "结果码", example = "0") + @Schema(description = "结果码", example = "0") private Integer resultCode; } 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 ca1074450..daf2c616e 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 @@ -11,32 +11,32 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - API 访问日志分页 Request VO") +@Schema(description = "管理后台 - API 访问日志分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ApiAccessLogPageReqVO extends PageParam { - @Schema(title = "用户编号", example = "666") + @Schema(description = "用户编号", example = "666") private Long userId; - @Schema(title = "用户类型", example = "2") + @Schema(description = "用户类型", example = "2") private Integer userType; - @Schema(title = "应用名", example = "dashboard") + @Schema(description = "应用名", example = "dashboard") private String applicationName; - @Schema(title = "请求地址", example = "/xxx/yyy", description = "模糊匹配") + @Schema(description = "请求地址,模糊匹配", example = "/xxx/yyy") private String requestUrl; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "开始请求时间") + @Schema(description = "开始请求时间") private LocalDateTime[] beginTime; - @Schema(title = "执行时长", example = "100", description = "大于等于，单位：毫秒") + @Schema(description = "执行时长,大于等于，单位：毫秒", example = "100") private Integer duration; - @Schema(title = "结果码", example = "0") + @Schema(description = "结果码", example = "0") private Integer resultCode; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogRespVO.java index 9ab73751e..52bbb3184 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apiaccesslog/ApiAccessLogRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - API 访问日志 Response VO") +@Schema(description = "管理后台 - API 访问日志 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ApiAccessLogRespVO extends ApiAccessLogBaseVO { - @Schema(title = "日志主键", required = true, example = "1024") + @Schema(description = "日志主键", required = true, example = "1024") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogBaseVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogBaseVO.java index c05b0f2e7..6045e903e 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogBaseVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogBaseVO.java @@ -15,80 +15,80 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @Data public class ApiErrorLogBaseVO { - @Schema(title = "链路追踪编号", required = true, example = "66600cb6-7852-11eb-9439-0242ac130002") + @Schema(description = "链路追踪编号", required = true, example = "66600cb6-7852-11eb-9439-0242ac130002") @NotNull(message = "链路追踪编号不能为空") private String traceId; - @Schema(title = "用户编号", required = true, example = "666") + @Schema(description = "用户编号", required = true, example = "666") @NotNull(message = "用户编号不能为空") private Integer userId; - @Schema(title = "用户类型", required = true, example = "1") + @Schema(description = "用户类型", required = true, example = "1") @NotNull(message = "用户类型不能为空") private Integer userType; - @Schema(title = "应用名", required = true, example = "dashboard") + @Schema(description = "应用名", required = true, example = "dashboard") @NotNull(message = "应用名不能为空") private String applicationName; - @Schema(title = "请求方法名", required = true, example = "GET") + @Schema(description = "请求方法名", required = true, example = "GET") @NotNull(message = "请求方法名不能为空") private String requestMethod; - @Schema(title = "请求地址", required = true, example = "/xx/yy") + @Schema(description = "请求地址", required = true, example = "/xx/yy") @NotNull(message = "请求地址不能为空") private String requestUrl; - @Schema(title = "请求参数", required = true) + @Schema(description = "请求参数", required = true) @NotNull(message = "请求参数不能为空") private String requestParams; - @Schema(title = "用户 IP", required = true, example = "127.0.0.1") + @Schema(description = "用户 IP", required = true, example = "127.0.0.1") @NotNull(message = "用户 IP不能为空") private String userIp; - @Schema(title = "浏览器 UA", required = true, example = "Mozilla/5.0") + @Schema(description = "浏览器 UA", required = true, example = "Mozilla/5.0") @NotNull(message = "浏览器 UA不能为空") private String userAgent; - @Schema(title = "异常发生时间", required = true) + @Schema(description = "异常发生时间", required = true) @NotNull(message = "异常发生时间不能为空") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime exceptionTime; - @Schema(title = "异常名", required = true) + @Schema(description = "异常名", required = true) @NotNull(message = "异常名不能为空") private String exceptionName; - @Schema(title = "异常导致的消息", required = true) + @Schema(description = "异常导致的消息", required = true) @NotNull(message = "异常导致的消息不能为空") private String exceptionMessage; - @Schema(title = "异常导致的根消息", required = true) + @Schema(description = "异常导致的根消息", required = true) @NotNull(message = "异常导致的根消息不能为空") private String exceptionRootCauseMessage; - @Schema(title = "异常的栈轨迹", required = true) + @Schema(description = "异常的栈轨迹", required = true) @NotNull(message = "异常的栈轨迹不能为空") private String exceptionStackTrace; - @Schema(title = "异常发生的类全名", required = true) + @Schema(description = "异常发生的类全名", required = true) @NotNull(message = "异常发生的类全名不能为空") private String exceptionClassName; - @Schema(title = "异常发生的类文件", required = true) + @Schema(description = "异常发生的类文件", required = true) @NotNull(message = "异常发生的类文件不能为空") private String exceptionFileName; - @Schema(title = "异常发生的方法名", required = true) + @Schema(description = "异常发生的方法名", required = true) @NotNull(message = "异常发生的方法名不能为空") private String exceptionMethodName; - @Schema(title = "异常发生的方法所在行", required = true) + @Schema(description = "异常发生的方法所在行", required = true) @NotNull(message = "异常发生的方法所在行不能为空") private Integer exceptionLineNumber; - @Schema(title = "处理状态", required = true, example = "0") + @Schema(description = "处理状态", required = true, example = "0") @NotNull(message = "处理状态不能为空") private Integer processStatus; 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 a5b1698ce..dbc386729 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 @@ -8,27 +8,27 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - API 错误日志 Excel 导出 Request VO", description = "参数和 ApiErrorLogPageReqVO 是一致的") +@Schema(description = "管理后台 - API 错误日志 Excel 导出 Request VO,参数和 ApiErrorLogPageReqVO 是一致的") @Data public class ApiErrorLogExportReqVO { - @Schema(title = "用户编号", example = "666") + @Schema(description = "用户编号", example = "666") private Long userId; - @Schema(title = "用户类型", example = "1") + @Schema(description = "用户类型", example = "1") private Integer userType; - @Schema(title = "应用名", example = "dashboard") + @Schema(description = "应用名", example = "dashboard") private String applicationName; - @Schema(title = "请求地址", example = "/xx/yy") + @Schema(description = "请求地址", example = "/xx/yy") private String requestUrl; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "异常发生时间") + @Schema(description = "异常发生时间") private LocalDateTime[] exceptionTime; - @Schema(title = "处理状态", example = "0") + @Schema(description = "处理状态", example = "0") private Integer processStatus; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogPageReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogPageReqVO.java index eb759c680..2ceb0d033 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogPageReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogPageReqVO.java @@ -11,29 +11,29 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - API 错误日志分页 Request VO") +@Schema(description = "管理后台 - API 错误日志分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ApiErrorLogPageReqVO extends PageParam { - @Schema(title = "用户编号", example = "666") + @Schema(description = "用户编号", example = "666") private Long userId; - @Schema(title = "用户类型", example = "1") + @Schema(description = "用户类型", example = "1") private Integer userType; - @Schema(title = "应用名", example = "dashboard") + @Schema(description = "应用名", example = "dashboard") private String applicationName; - @Schema(title = "请求地址", example = "/xx/yy") + @Schema(description = "请求地址", example = "/xx/yy") private String requestUrl; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "异常发生时间") + @Schema(description = "异常发生时间") private LocalDateTime[] exceptionTime; - @Schema(title = "处理状态", example = "0") + @Schema(description = "处理状态", example = "0") private Integer processStatus; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogRespVO.java index d0a93f2a9..c4ce8faf6 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/logger/vo/apierrorlog/ApiErrorLogRespVO.java @@ -7,22 +7,22 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - API 错误日志 Response VO") +@Schema(description = "管理后台 - API 错误日志 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ApiErrorLogRespVO extends ApiErrorLogBaseVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") private Integer id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; - @Schema(title = "处理时间", required = true) + @Schema(description = "处理时间", required = true) private LocalDateTime processTime; - @Schema(title = "处理用户编号", example = "233") + @Schema(description = "处理用户编号", example = "233") private Integer processUserId; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/redis/vo/RedisKeyDefineRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/redis/vo/RedisKeyDefineRespVO.java index c2b7836a8..f30ebb623 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/redis/vo/RedisKeyDefineRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/redis/vo/RedisKeyDefineRespVO.java @@ -8,28 +8,28 @@ import lombok.Data; import java.time.Duration; -@Schema(title = "管理后台 - Redis Key 信息 Response VO") +@Schema(description = "管理后台 - Redis Key 信息 Response VO") @Data @Builder @AllArgsConstructor public class RedisKeyDefineRespVO { - @Schema(title = "Key 模板", required = true, example = "login_user:%s") + @Schema(description = "Key 模板", required = true, example = "login_user:%s") private String keyTemplate; - @Schema(title = "Key 类型的枚举", required = true, example = "String") + @Schema(description = "Key 类型的枚举", required = true, example = "String") private RedisKeyDefine.KeyTypeEnum keyType; - @Schema(title = "Value 类型", required = true, example = "java.lang.String") + @Schema(description = "Value 类型", required = true, example = "java.lang.String") private Class valueType; - @Schema(title = "超时类型", required = true, example = "1") + @Schema(description = "超时类型", required = true, example = "1") private RedisKeyDefine.TimeoutTypeEnum timeoutType; - @Schema(title = "过期时间，单位：毫秒", required = true, example = "1024") + @Schema(description = "过期时间，单位：毫秒", required = true, example = "1024") private Duration timeout; - @Schema(title = "备注", required = true, example = "啦啦啦啦~") + @Schema(description = "备注", required = true, example = "啦啦啦啦~") private String memo; } 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 71d4c1ec2..9dc893da0 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 @@ -4,12 +4,12 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.AllArgsConstructor; import lombok.Data; -@Schema(title = "管理后台 - 单个 Redis Key Value Response VO") +@Schema(description = "管理后台 - 单个 Redis Key Value Response VO") @Data @AllArgsConstructor public class RedisKeyValueRespVO { - @Schema(title = "c5f6990767804a928f4bb96ca249febf", required = true, example = "String") + @Schema(description = "c5f6990767804a928f4bb96ca249febf", required = true, example = "String") private String key; @Schema(required = true, example = "String") 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 42b8419ea..15d054282 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 @@ -8,34 +8,34 @@ import lombok.Data; import java.util.List; import java.util.Properties; -@Schema(title = "管理后台 - Redis 监控信息 Response VO") +@Schema(description = "管理后台 - Redis 监控信息 Response VO") @Data @Builder @AllArgsConstructor public class RedisMonitorRespVO { - @Schema(title = "Redis info 指令结果", required = true, description = "具体字段，查看 Redis 文档") + @Schema(description = "Redis info 指令结果,具体字段，查看 Redis 文档", required = true) private Properties info; - @Schema(title = "Redis key 数量", required = true, example = "1024") + @Schema(description = "Redis key 数量", required = true, example = "1024") private Long dbSize; - @Schema(title = "CommandStat 数组", required = true) + @Schema(description = "CommandStat 数组", required = true) private List commandStats; - @Schema(title = "Redis 命令统计结果") + @Schema(description = "Redis 命令统计结果") @Data @Builder @AllArgsConstructor public static class CommandStat { - @Schema(title = "Redis 命令", required = true, example = "get") + @Schema(description = "Redis 命令", required = true, example = "get") private String command; - @Schema(title = "调用次数", required = true, example = "1024") + @Schema(description = "调用次数", required = true, example = "1024") private Long calls; - @Schema(title = "消耗 CPU 秒数", required = true, example = "666") + @Schema(description = "消耗 CPU 秒数", required = true, example = "666") private Long usec; } 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 5f78f48f7..a0216683d 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 @@ -10,23 +10,23 @@ import javax.validation.constraints.*; @Data public class TestDemoBaseVO { - @Schema(title = "名字", required = true) + @Schema(description = "名字", required = true) @NotNull(message = "名字不能为空") private String name; - @Schema(title = "状态", required = true) + @Schema(description = "状态", required = true) @NotNull(message = "状态不能为空") private Integer status; - @Schema(title = "类型", required = true) + @Schema(description = "类型", required = true) @NotNull(message = "类型不能为空") private Integer type; - @Schema(title = "分类", required = true) + @Schema(description = "分类", required = true) @NotNull(message = "分类不能为空") private Integer category; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; } 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 f2b2786e5..3b46fd1cd 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 @@ -2,7 +2,7 @@ package cn.iocoder.yudao.module.infra.controller.admin.test.vo; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@Schema(title = "管理后台 - 字典类型创建 Request VO") +@Schema(description = "管理后台 - 字典类型创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) 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 e12d753d4..8e10484e3 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 @@ -7,27 +7,27 @@ import org.springframework.format.annotation.DateTimeFormat; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 字典类型 Excel 导出 Request VO", description = "参数和 TestDemoPageReqVO 是一致的") +@Schema(description = "管理后台 - 字典类型 Excel 导出 Request VO,参数和 TestDemoPageReqVO 是一致的") @Data public class TestDemoExportReqVO { - @Schema(title = "名字") + @Schema(description = "名字") private String name; - @Schema(title = "状态") + @Schema(description = "状态") private Integer status; - @Schema(title = "类型") + @Schema(description = "类型") private Integer type; - @Schema(title = "分类") + @Schema(description = "分类") private Integer category; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoPageReqVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoPageReqVO.java index 6881e17e2..abb5843db 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoPageReqVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoPageReqVO.java @@ -8,29 +8,29 @@ import org.springframework.format.annotation.DateTimeFormat; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 字典类型分页 Request VO") +@Schema(description = "管理后台 - 字典类型分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class TestDemoPageReqVO extends PageParam { - @Schema(title = "名字") + @Schema(description = "名字") private String name; - @Schema(title = "状态") + @Schema(description = "状态") private Integer status; - @Schema(title = "类型") + @Schema(description = "类型") private Integer type; - @Schema(title = "分类") + @Schema(description = "分类") private Integer category; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoRespVO.java b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoRespVO.java index 95af5b4b4..312a5eb98 100755 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoRespVO.java +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/java/cn/iocoder/yudao/module/infra/controller/admin/test/vo/TestDemoRespVO.java @@ -4,16 +4,16 @@ import lombok.*; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 字典类型 Response VO") +@Schema(description = "管理后台 - 字典类型 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class TestDemoRespVO extends TestDemoBaseVO { - @Schema(title = "编号", required = true) + @Schema(description = "编号", required = true) private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } 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 7c8315381..6df36addb 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 @@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 字典类型更新 Request VO") +@Schema(description = "管理后台 - 字典类型更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class TestDemoUpdateReqVO extends TestDemoBaseVO { - @Schema(title = "编号", required = true) + @Schema(description = "编号", required = true) @NotNull(message = "编号不能为空") private Long id; diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/_column.vm b/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/_column.vm index 71c4eebf8..89a8e348f 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/_column.vm +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/_column.vm @@ -1,5 +1,5 @@ ## 提供给 baseVO、createVO、updateVO 生成字段 - @Schema(title = "${column.columnComment}"#if (!${column.nullable}), required = true#end#if ("$!column.example" != ""), example = "${column.example}"#end) + @Schema(description = "${column.columnComment}"#if (!${column.nullable}), required = true#end#if ("$!column.example" != ""), example = "${column.example}"#end) #if (!${column.nullable})## 判断 @NotEmpty 和 @NotNull 注解 #if (${field.fieldType} == 'String') @NotEmpty(message = "${column.columnComment}不能为空") diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/createReqVO.vm b/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/createReqVO.vm index 315faf7fc..32ab0f2ba 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/createReqVO.vm +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/createReqVO.vm @@ -15,7 +15,7 @@ import static ${DateUtilsClassName}.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; #end #end -@Schema(title = "${sceneEnum.name} - ${table.classComment}创建 Request VO") +@Schema(description = "${sceneEnum.name} - ${table.classComment}创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/exportReqVO.vm b/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/exportReqVO.vm index 749a43e25..9d3be20cd 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/exportReqVO.vm +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/exportReqVO.vm @@ -16,18 +16,18 @@ import static ${DateUtilsClassName}.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; #end ## 字段模板 #macro(columnTpl $prefix $prefixStr) - @Schema(title = "${prefixStr}${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end) + @Schema(description = "${prefixStr}${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end) private ${column.javaType}#if ("$!prefix" != "") ${prefix}${JavaField}#else ${column.javaField}#end; #end -@Schema(title = "${sceneEnum.name} - ${table.classComment} Excel 导出 Request VO", description = "参数和 ${table.className}PageReqVO 是一致的") +@Schema(description = "${sceneEnum.name} - ${table.classComment} Excel 导出 Request VO，参数和 ${table.className}PageReqVO 是一致的") @Data public class ${sceneEnum.prefixClass}${table.className}ExportReqVO { #foreach ($column in $columns) #if (${column.listOperation})##查询操作 #if (${column.listOperationCondition} == "BETWEEN")## 情况一，Between 的时候 - @Schema(title = "${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end) + @Schema(description = "${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end) @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private ${column.javaType}[] ${column.javaField}; #else##情况二，非 Between 的时间 diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/pageReqVO.vm b/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/pageReqVO.vm index 44a5307ea..3105132b9 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/pageReqVO.vm +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/pageReqVO.vm @@ -16,11 +16,11 @@ import static ${DateUtilsClassName}.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; #end ## 字段模板 #macro(columnTpl $prefix $prefixStr) - @Schema(title = "${prefixStr}${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end) + @Schema(description = "${prefixStr}${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end) private ${column.javaType}#if ("$!prefix" != "") ${prefix}${JavaField}#else ${column.javaField}#end; #end -@Schema(title = "${sceneEnum.name} - ${table.classComment}分页 Request VO") +@Schema(description = "${sceneEnum.name} - ${table.classComment}分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) @@ -29,7 +29,7 @@ public class ${sceneEnum.prefixClass}${table.className}PageReqVO extends PagePar #foreach ($column in $columns) #if (${column.listOperation})##查询操作 #if (${column.listOperationCondition} == "BETWEEN")## 情况一，Between 的时候 - @Schema(title = "${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end) + @Schema(description = "${column.columnComment}"#if ("$!column.example" != ""), example = "${column.example}"#end) @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private ${column.javaType}[] ${column.javaField}; #else##情况二，非 Between 的时间 diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/respVO.vm b/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/respVO.vm index f57b2fc12..ba49133af 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/respVO.vm +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/respVO.vm @@ -9,7 +9,7 @@ import java.time.LocalDateTime; #end import io.swagger.annotations.*; -@Schema(title = "${sceneEnum.name} - ${table.classComment} Response VO") +@Schema(description = "${sceneEnum.name} - ${table.classComment} Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) @@ -17,7 +17,7 @@ public class ${sceneEnum.prefixClass}${table.className}RespVO extends ${sceneEnu #foreach ($column in $columns) #if (${column.listOperationResult} && (!${column.createOperation} || !${column.updateOperation}))##不是通用字段 - @Schema(title = "${column.columnComment}"#if (!${column.nullable}), required = true#end#if ("$!column.example" != ""), example = "${column.example}"#end) + @Schema(description = "${column.columnComment}"#if (!${column.nullable}), required = true#end#if ("$!column.example" != ""), example = "${column.example}"#end) private ${column.javaType} ${column.javaField}; #end diff --git a/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/updateReqVO.vm b/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/updateReqVO.vm index fb9b42f00..1bdadf2ed 100644 --- a/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/updateReqVO.vm +++ b/yudao-module-infra/yudao-module-infra-biz/src/main/resources/codegen/java/controller/vo/updateReqVO.vm @@ -15,7 +15,7 @@ import static ${DateUtilsClassName}.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; #end #end -@Schema(title = "${sceneEnum.name} - ${table.classComment}更新 Request VO") +@Schema(description = "${sceneEnum.name} - ${table.classComment}更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandBaseVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandBaseVO.java index f586e7415..033199d9f 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandBaseVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandBaseVO.java @@ -11,22 +11,22 @@ import javax.validation.constraints.NotNull; @Data public class ProductBrandBaseVO { - @Schema(title = "品牌名称", required = true, example = "芋道") + @Schema(description = "品牌名称", required = true, example = "芋道") @NotNull(message = "品牌名称不能为空") private String name; - @Schema(title = "品牌图片", required = true) + @Schema(description = "品牌图片", required = true) @NotNull(message = "品牌图片不能为空") private String picUrl; - @Schema(title = "品牌排序", required = true, example = "1") + @Schema(description = "品牌排序", required = true, example = "1") @NotNull(message = "品牌排序不能为空") private Integer sort; - @Schema(title = "品牌描述", example = "描述") + @Schema(description = "品牌描述", example = "描述") private String description; - @Schema(title = "状态", required = true, example = "0") + @Schema(description = "状态", required = true, example = "0") @NotNull(message = "状态不能为空") private Integer status; diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandCreateReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandCreateReqVO.java index 1ea83e259..2ab9c354a 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandCreateReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandCreateReqVO.java @@ -2,7 +2,7 @@ package cn.iocoder.yudao.module.product.controller.admin.brand.vo; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@Schema(title = "管理后台 - 商品品牌创建 Request VO") +@Schema(description = "管理后台 - 商品品牌创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandListReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandListReqVO.java index a1ea87ad8..63305810c 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandListReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandListReqVO.java @@ -3,11 +3,11 @@ package cn.iocoder.yudao.module.product.controller.admin.brand.vo; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(title = "管理后台 - 商品品牌分页 Request VO") +@Schema(description = "管理后台 - 商品品牌分页 Request VO") @Data public class ProductBrandListReqVO { - @Schema(title = "品牌名称", example = "芋道") + @Schema(description = "品牌名称", example = "芋道") private String name; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandPageReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandPageReqVO.java index b19a9a711..e90744a10 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandPageReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandPageReqVO.java @@ -11,20 +11,20 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 商品品牌分页 Request VO") +@Schema(description = "管理后台 - 商品品牌分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductBrandPageReqVO extends PageParam { - @Schema(title = "品牌名称", example = "芋道") + @Schema(description = "品牌名称", example = "芋道") private String name; - @Schema(title = "状态", example = "0", description = "参考 CommonStatusEnum 枚举") + @Schema(description = "状态-参考 CommonStatusEnum 枚举", example = "0") private Integer status; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandRespVO.java index a61cf5235..b68fbc5be 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 品牌 Response VO") +@Schema(description = "管理后台 - 品牌 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductBrandRespVO extends ProductBrandBaseVO { - @Schema(title = "品牌编号", required = true, example = "1") + @Schema(description = "品牌编号", required = true, example = "1") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandUpdateReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandUpdateReqVO.java index e86112c92..15648164f 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandUpdateReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/brand/vo/ProductBrandUpdateReqVO.java @@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 商品品牌更新 Request VO") +@Schema(description = "管理后台 - 商品品牌更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductBrandUpdateReqVO extends ProductBrandBaseVO { - @Schema(title = "品牌编号", required = true, example = "1") + @Schema(description = "品牌编号", required = true, example = "1") @NotNull(message = "品牌编号不能为空") private Long id; diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryBaseVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryBaseVO.java index 922ab321b..c2276e9ac 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryBaseVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryBaseVO.java @@ -12,25 +12,25 @@ import javax.validation.constraints.NotNull; @Data public class ProductCategoryBaseVO { - @Schema(title = "父分类编号", required = true, example = "1") + @Schema(description = "父分类编号", required = true, example = "1") @NotNull(message = "父分类编号不能为空") private Long parentId; - @Schema(title = "分类名称", required = true, example = "办公文具") + @Schema(description = "分类名称", required = true, example = "办公文具") @NotBlank(message = "分类名称不能为空") private String name; - @Schema(title = "分类图片", required = true) + @Schema(description = "分类图片", required = true) @NotBlank(message = "分类图片不能为空") private String picUrl; - @Schema(title = "分类排序", required = true, example = "1") + @Schema(description = "分类排序", required = true, example = "1") private Integer sort; - @Schema(title = "分类描述", required = true, example = "描述") + @Schema(description = "分类描述", required = true, example = "描述") private String description; - @Schema(title = "开启状态", required = true, example = "0") + @Schema(description = "开启状态", required = true, example = "0") @NotNull(message = "开启状态不能为空") private Integer status; diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryCreateReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryCreateReqVO.java index 32e5e6719..577b9e774 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryCreateReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryCreateReqVO.java @@ -2,7 +2,7 @@ package cn.iocoder.yudao.module.product.controller.admin.category.vo; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@Schema(title = "管理后台 - 商品分类创建 Request VO") +@Schema(description = "管理后台 - 商品分类创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryListReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryListReqVO.java index 3a8e83106..9c9439d3e 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryListReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryListReqVO.java @@ -3,11 +3,11 @@ package cn.iocoder.yudao.module.product.controller.admin.category.vo; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(title = "管理后台 - 商品分类列表查询 Request VO") +@Schema(description = "管理后台 - 商品分类列表查询 Request VO") @Data public class ProductCategoryListReqVO { - @Schema(title = "分类名称", example = "办公文具") + @Schema(description = "分类名称", example = "办公文具") private String name; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryRespVO.java index 32298487b..4e2b64188 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryRespVO.java @@ -4,16 +4,16 @@ import lombok.*; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 商品分类 Response VO") +@Schema(description = "管理后台 - 商品分类 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductCategoryRespVO extends ProductCategoryBaseVO { - @Schema(title = "分类编号", required = true, example = "2") + @Schema(description = "分类编号", required = true, example = "2") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryUpdateReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryUpdateReqVO.java index 1b8357f96..01deb165c 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryUpdateReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/category/vo/ProductCategoryUpdateReqVO.java @@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 商品分类更新 Request VO") +@Schema(description = "管理后台 - 商品分类更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductCategoryUpdateReqVO extends ProductCategoryBaseVO { - @Schema(title = "分类编号", required = true, example = "2") + @Schema(description = "分类编号", required = true, example = "2") @NotNull(message = "分类编号不能为空") private Long id; diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/ProductPropertyViewRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/ProductPropertyViewRespVO.java index 7ef873264..d72a3036f 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/ProductPropertyViewRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/ProductPropertyViewRespVO.java @@ -12,22 +12,22 @@ import java.util.List; * @CreateDate: 2022/7/5 21:29 * @Version: 1.0.0 */ -@Schema(title = "管理后台 - 规格名称详情展示 Request VO") +@Schema(description = "管理后台 - 规格名称详情展示 Request VO") @Data @ToString(callSuper = true) public class ProductPropertyViewRespVO { - @Schema(title = "规格名称id", example = "1") + @Schema(description = "规格名称id", example = "1") public Long propertyId; - @Schema(title = "规格名称", example = "内存") + @Schema(description = "规格名称", example = "内存") public String name; - @Schema(title = "规格属性值集合", example = "[{\"v1\":11,\"v2\":\"64G\"},{\"v1\":10,\"v2\":\"32G\"}]") + @Schema(description = "规格属性值集合", example = "[{\"v1\":11,\"v2\":\"64G\"},{\"v1\":10,\"v2\":\"32G\"}]") public List propertyValues; @Data - @Schema(title = "规格属性值元组") + @Schema(description = "规格属性值元组") public static class Tuple2 { private final long id; private final String name; diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyAndValueRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyAndValueRespVO.java index 7c75830bb..300255724 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyAndValueRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyAndValueRespVO.java @@ -9,16 +9,16 @@ import lombok.ToString; import java.time.LocalDateTime; import java.util.List; -@Schema(title = "管理后台 - 规格 + 规格值 Response VO") +@Schema(description = "管理后台 - 规格 + 规格值 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductPropertyAndValueRespVO extends ProductPropertyBaseVO { - @Schema(title = "规格的编号", required = true, example = "1024") + @Schema(description = "规格的编号", required = true, example = "1024") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; /** diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyBaseVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyBaseVO.java index 22f92ebb8..3bb4ec530 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyBaseVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyBaseVO.java @@ -12,14 +12,14 @@ import javax.validation.constraints.NotNull; @Data public class ProductPropertyBaseVO { - @Schema(title = "规格名称", required = true, example = "颜色") + @Schema(description = "规格名称", required = true, example = "颜色") @NotBlank(message = "规格名称不能为空") private String name; - @Schema(title = "备注", example = "颜色") + @Schema(description = "备注", example = "颜色") private String remark; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态-参见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyCreateReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyCreateReqVO.java index 28b93d516..5cc8c099f 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyCreateReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyCreateReqVO.java @@ -4,7 +4,7 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 规格名称创建 Request VO") +@Schema(description = "管理后台 - 规格名称创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyListReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyListReqVO.java index 49b2e7a2f..00d3372fe 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyListReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyListReqVO.java @@ -4,15 +4,15 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.ToString; -@Schema(title = "管理后台 - 规格名称 List Request VO") +@Schema(description = "管理后台 - 规格名称 List Request VO") @Data @ToString(callSuper = true) public class ProductPropertyListReqVO { - @Schema(title = "规格名称", example = "颜色") + @Schema(description = "规格名称", example = "颜色") private String name; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态,参见 CommonStatusEnum 枚举", required = true, example = "1") private Integer status; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyPageReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyPageReqVO.java index 96551fd84..c997f9bcb 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyPageReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyPageReqVO.java @@ -11,20 +11,20 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 规格名称分页 Request VO") +@Schema(description = "管理后台 - 规格名称分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductPropertyPageReqVO extends PageParam { - @Schema(title = "规格名称", example = "颜色") + @Schema(description = "规格名称", example = "颜色") private String name; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态,参见 CommonStatusEnum 枚举", required = true, example = "1") private Integer status; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyRespVO.java index fc7e03911..1fb81461f 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 规格 + 规格值 Response VO") +@Schema(description = "管理后台 - 规格 + 规格值 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductPropertyRespVO extends ProductPropertyBaseVO { - @Schema(title = "规格的编号", required = true, example = "1024") + @Schema(description = "规格的编号", required = true, example = "1024") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyUpdateReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyUpdateReqVO.java index bde40c9c0..87d7accd8 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyUpdateReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/property/ProductPropertyUpdateReqVO.java @@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 规格名称更新 Request VO") +@Schema(description = "管理后台 - 规格名称更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductPropertyUpdateReqVO extends ProductPropertyBaseVO { - @Schema(title = "主键", required = true, example = "1") + @Schema(description = "主键", required = true, example = "1") @NotNull(message = "主键不能为空") private Long id; diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueBaseVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueBaseVO.java index b4a526c47..966027c59 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueBaseVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueBaseVO.java @@ -12,19 +12,19 @@ import javax.validation.constraints.NotNull; @Data public class ProductPropertyValueBaseVO { - @Schema(title = "规格编号", required = true, example = "1024") + @Schema(description = "规格编号", required = true, example = "1024") @NotNull(message = "规格编号不能为空") private Long propertyId; - @Schema(title = "规格值名字", required = true, example = "红色") + @Schema(description = "规格值名字", required = true, example = "红色") @NotEmpty(message = "规格值名字不能为空") private String name; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态,参见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; - @Schema(title = "备注", example = "颜色") + @Schema(description = "备注", example = "颜色") private String remark; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueCreateReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueCreateReqVO.java index 6477b7091..23a23b0fe 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueCreateReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueCreateReqVO.java @@ -2,7 +2,7 @@ package cn.iocoder.yudao.module.product.controller.admin.property.vo.value; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@Schema(title = "管理后台 - 规格值创建 Request VO") +@Schema(description = "管理后台 - 规格值创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValuePageReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValuePageReqVO.java index bcada5154..bafa24ebd 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValuePageReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValuePageReqVO.java @@ -12,19 +12,19 @@ import java.util.Date; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 规格名称值分页 Request VO") +@Schema(description = "管理后台 - 规格名称值分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductPropertyValuePageReqVO extends PageParam { - @Schema(title = "规格id", example = "1024") + @Schema(description = "规格id", example = "1024") private String propertyId; - @Schema(title = "规格值", example = "红色") + @Schema(description = "规格值", example = "红色") private String name; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态,参见 CommonStatusEnum 枚举", required = true, example = "1") private Integer status; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueRespVO.java index 2a40e0056..d914d88a1 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 规格值 Response VO") +@Schema(description = "管理后台 - 规格值 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductPropertyValueRespVO extends ProductPropertyValueBaseVO { - @Schema(title = "主键", required = true, example = "10") + @Schema(description = "主键", required = true, example = "10") private Long id; - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime createTime; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueUpdateReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueUpdateReqVO.java index cb346c27c..b3a34aeb7 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueUpdateReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/property/vo/value/ProductPropertyValueUpdateReqVO.java @@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 规格值更新 Request VO") +@Schema(description = "管理后台 - 规格值更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductPropertyValueUpdateReqVO extends ProductPropertyValueBaseVO { - @Schema(title = "主键", required = true, example = "1024") + @Schema(description = "主键", required = true, example = "1024") @NotNull(message = "主键不能为空") private Long id; diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuBaseVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuBaseVO.java index 8ae8c8a5a..313cedefa 100755 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuBaseVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuBaseVO.java @@ -15,54 +15,54 @@ import javax.validation.constraints.NotNull; @Data public class ProductSkuBaseVO { - @Schema(title = "商品 SKU 名字", required = true, example = "芋道") + @Schema(description = "商品 SKU 名字", required = true, example = "芋道") @NotEmpty(message = "商品 SKU 名字不能为空") private String name; - @Schema(title = "销售价格，单位：分", required = true, example = "1024", description = "单位：分") + @Schema(description = "销售价格，单位：分", required = true, example = "1024") @NotNull(message = "销售价格，单位：分不能为空") private Integer price; - @Schema(title = "市场价", example = "1024", description = "单位：分") + @Schema(description = "市场价,单位：分", example = "1024") private Integer marketPrice; - @Schema(title = "成本价", example = "1024", description = "单位：分") + @Schema(description = "成本价,单位：分", example = "1024") private Integer costPrice; - @Schema(title = "条形码", example = "haha") + @Schema(description = "条形码", example = "haha") private String barCode; - @Schema(title = "图片地址", required = true, example = "https://www.iocoder.cn/xx.png") + @Schema(description = "图片地址", required = true, example = "https://www.iocoder.cn/xx.png") @NotNull(message = "图片地址不能为空") private String picUrl; - @Schema(title = "SKU 状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举") + @Schema(description = "SKU 状态,参见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "SKU 状态不能为空") @InEnum(CommonStatusEnum.class) private Integer status; - @Schema(title = "库存", required = true, example = "1") + @Schema(description = "库存", required = true, example = "1") @NotNull(message = "库存不能为空") private Integer stock; - @Schema(title = "预警预存", example = "1") + @Schema(description = "预警预存", example = "1") private Integer warnStock; - @Schema(title = "商品重量", example = "1", description = "单位：kg 千克") + @Schema(description = "商品重量,单位：kg 千克", example = "1") private Double weight; - @Schema(title = "商品体积", example = "1024", description = "单位：m^3 平米") + @Schema(description = "商品体积,单位：m^3 平米", example = "1024") private Double volume; - @Schema(title = "规格值") + @Schema(description = "规格值") @Data public static class Property { - @Schema(title = "属性编号", required = true, example = "1") + @Schema(description = "属性编号", required = true, example = "1") @NotNull(message = "属性编号不能为空") private Long propertyId; - @Schema(title = "属性值编号", required = true, example = "1024") + @Schema(description = "属性值编号", required = true, example = "1024") @NotNull(message = "属性值编号不能为空") private Long valueId; diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuCreateOrUpdateReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuCreateOrUpdateReqVO.java index 3648f3159..7383e2416 100755 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuCreateOrUpdateReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuCreateOrUpdateReqVO.java @@ -7,13 +7,13 @@ import lombok.ToString; import java.util.List; -@Schema(title = "管理后台 - 商品 SKU 创建/更新 Request VO") +@Schema(description = "管理后台 - 商品 SKU 创建/更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductSkuCreateOrUpdateReqVO extends ProductSkuBaseVO { - @Schema(title = "商品 SKU 编号", example = "1") + @Schema(description = "商品 SKU 编号", example = "1") private Long id; /** diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuOptionRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuOptionRespVO.java index dd71d6954..1522ca59e 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuOptionRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuOptionRespVO.java @@ -3,28 +3,28 @@ package cn.iocoder.yudao.module.product.controller.admin.sku.vo; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(title = "管理后台 - 商品 SKU 选项 Response VO", description = "用于前端 SELECT 选项") +@Schema(description = "管理后台 - 商品 SKU 选项 Response VO,用于前端 SELECT 选项") @Data public class ProductSkuOptionRespVO { - @Schema(title = "主键", required = true, example = "1024") + @Schema(description = "主键", required = true, example = "1024") private Long id; - @Schema(title = "商品 SKU 名字", example = "红色") + @Schema(description = "商品 SKU 名字", example = "红色") private String name; - @Schema(title = "销售价格", required = true, example = "100", description = "单位：分") + @Schema(description = "销售价格,单位：分", required = true, example = "100") private String price; - @Schema(title = "库存", required = true, example = "100") + @Schema(description = "库存", required = true, example = "100") private Integer stock; // ========== 商品 SPU 信息 ========== - @Schema(title = "商品 SPU 编号", required = true, example = "1") + @Schema(description = "商品 SPU 编号", required = true, example = "1") private Long spuId; - @Schema(title = "商品 SPU 名字", required = true, example = "iPhone 11") + @Schema(description = "商品 SPU 名字", required = true, example = "iPhone 11") private String spuName; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuRespVO.java index 62e4ec9cc..0b0ec665a 100755 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/sku/vo/ProductSkuRespVO.java @@ -8,16 +8,16 @@ import lombok.ToString; import java.time.LocalDateTime; import java.util.List; -@Schema(title = "管理后台 - 商品 SKU Response VO") +@Schema(description = "管理后台 - 商品 SKU Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductSkuRespVO extends ProductSkuBaseVO { - @Schema(title = "主键", required = true, example = "1024") + @Schema(description = "主键", required = true, example = "1024") private Long id; - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime createTime; /** diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuBaseVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuBaseVO.java index fa7e2717d..1c3c22485 100755 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuBaseVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuBaseVO.java @@ -17,75 +17,75 @@ import java.util.List; @Data public class ProductSpuBaseVO { - @Schema(title = "商品名称", required = true, example = "芋道") + @Schema(description = "商品名称", required = true, example = "芋道") @NotEmpty(message = "商品名称不能为空") private String name; - @Schema(title = "商品编码", example = "yudaoyuanma") + @Schema(description = "商品编码", example = "yudaoyuanma") private String code; - @Schema(title = "促销语", example = "好吃！") + @Schema(description = "促销语", example = "好吃！") private String sellPoint; - @Schema(title = "商品详情", required = true, example = "我是商品描述") + @Schema(description = "商品详情", required = true, example = "我是商品描述") @NotNull(message = "商品详情不能为空") private String description; - @Schema(title = "商品分类编号", required = true, example = "1") + @Schema(description = "商品分类编号", required = true, example = "1") @NotNull(message = "商品分类编号不能为空") private Long categoryId; - @Schema(title = "商品品牌编号", example = "1") + @Schema(description = "商品品牌编号", example = "1") private Long brandId; - @Schema(title = "商品图片的数组", required = true) + @Schema(description = "商品图片的数组", required = true) @NotNull(message = "商品图片的数组不能为空") private List picUrls; - @Schema(title = "商品视频", required = true) + @Schema(description = "商品视频", required = true) private String videoUrl; - @Schema(title = "排序字段", required = true, example = "1") + @Schema(description = "排序字段", required = true, example = "1") private Integer sort; - @Schema(title = "商品状态", required = true, example = "1", description = "参见 ProductSpuStatusEnum 枚举类") + @Schema(description = "商品状态,参见 ProductSpuStatusEnum 枚举类", required = true, example = "1") @NotNull(message = "商品状态不能为空") @InEnum(ProductSpuStatusEnum.class) private Integer status; // ========== SKU 相关字段 ========= - @Schema(title = "规格类型", required = true, example = "1", description = "参见 ProductSpuSpecTypeEnum 枚举类") + @Schema(description = "规格类型,参见 ProductSpuSpecTypeEnum 枚举类", required = true, example = "1") @NotNull(message = "规格类型不能为空") @InEnum(ProductSpuSpecTypeEnum.class) private Integer specType; - @Schema(title = "是否展示库存", required = true, example = "true") + @Schema(description = "是否展示库存", required = true, example = "true") @NotNull(message = "是否展示库存不能为空") private Boolean showStock; - @Schema(title = "库存", required = true, example = "true") + @Schema(description = "库存", required = true, example = "true") private Integer totalStock; - @Schema(title = "市场价", example = "1024") + @Schema(description = "市场价", example = "1024") private Integer marketPrice; - @Schema(title = " 最小价格，单位使用：分", required = true, example = "1024") + @Schema(description = " 最小价格，单位使用：分", required = true, example = "1024") private Integer minPrice; - @Schema(title = "最大价格，单位使用：分", required = true, example = "1024") + @Schema(description = "最大价格，单位使用：分", required = true, example = "1024") private Integer maxPrice; // ========== 统计相关字段 ========= - @Schema(title = "商品销量", example = "1024") + @Schema(description = "商品销量", example = "1024") private Integer salesCount; - @Schema(title = "虚拟销量", required = true, example = "1024") + @Schema(description = "虚拟销量", required = true, example = "1024") @NotNull(message = "虚拟销量不能为空") private Integer virtualSalesCount; - @Schema(title = "点击量", example = "1024") + @Schema(description = "点击量", example = "1024") private Integer clickCount; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuCreateReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuCreateReqVO.java index 50aef8570..c75ed4d2e 100755 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuCreateReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuCreateReqVO.java @@ -9,7 +9,7 @@ import lombok.ToString; import javax.validation.Valid; import java.util.List; -@Schema(title = "管理后台 - 商品 SPU 创建 Request VO") +@Schema(description = "管理后台 - 商品 SPU 创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuDetailRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuDetailRespVO.java index 622d9eecd..e60d2fff5 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuDetailRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuDetailRespVO.java @@ -10,16 +10,16 @@ import lombok.ToString; import java.time.LocalDateTime; import java.util.List; -@Schema(title = "管理后台 - 商品 SPU 详细 Response VO", description = "包括关联的 SKU 等信息") +@Schema(description = "管理后台 - 商品 SPU 详细 Response VO,包括关联的 SKU 等信息") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductSpuDetailRespVO extends ProductSpuBaseVO { - @Schema(title = "主键", required = true, example = "1") + @Schema(description = "主键", required = true, example = "1") private Long id; - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime createTime; /** @@ -27,7 +27,7 @@ public class ProductSpuDetailRespVO extends ProductSpuBaseVO { */ private List skus; - @Schema(title = "管理后台 - 商品 SKU 详细 Response VO") + @Schema(description = "管理后台 - 商品 SKU 详细 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) @@ -40,25 +40,25 @@ public class ProductSpuDetailRespVO extends ProductSpuBaseVO { } - @Schema(title = "管理后台 - 商品规格的详细 Response VO") + @Schema(description = "管理后台 - 商品规格的详细 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public static class Property extends ProductSkuBaseVO.Property { - @Schema(title = "规格的名字", required = true, example = "颜色") + @Schema(description = "规格的名字", required = true, example = "颜色") private String propertyName; - @Schema(title = "规格值的名字", required = true, example = "蓝色") + @Schema(description = "规格值的名字", required = true, example = "蓝色") private String valueName; } - @Schema(title = "分类 id 数组，一直递归到一级父节点", example = "4") + @Schema(description = "分类 id 数组，一直递归到一级父节点", example = "4") private Long categoryId; // TODO @芋艿：在瞅瞅~ - @Schema(title = "规格属性修改和详情展示组合", example = "[{\"propertyId\":2,\"name\":\"内存\",\"propertyValues\":[{\"v1\":11,\"v2\":\"64G\"},{\"v1\":10,\"v2\":\"32G\"}]},{\"propertyId\":3,\"name\":\"尺寸\",\"propertyValues\":[{\"v1\":16,\"v2\":\"6.1\"},{\"v1\":15,\"v2\":\"5.7\"}]}]") + @Schema(description = "规格属性修改和详情展示组合", example = "[{\"propertyId\":2,\"name\":\"内存\",\"propertyValues\":[{\"v1\":11,\"v2\":\"64G\"},{\"v1\":10,\"v2\":\"32G\"}]},{\"propertyId\":3,\"name\":\"尺寸\",\"propertyValues\":[{\"v1\":16,\"v2\":\"6.1\"},{\"v1\":15,\"v2\":\"5.7\"}]}]") private List productPropertyViews; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuPageReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuPageReqVO.java index 47ba5f213..3d30ad013 100755 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuPageReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuPageReqVO.java @@ -6,40 +6,40 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 商品 SPU 分页 Request VO") +@Schema(description = "管理后台 - 商品 SPU 分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductSpuPageReqVO extends PageParam { - @Schema(title = "商品名称", example = "yutou") + @Schema(description = "商品名称", example = "yutou") private String name; - @Schema(title = "商品编码", example = "yudaoyuanma") + @Schema(description = "商品编码", example = "yudaoyuanma") private String code; - @Schema(title = "分类id", example = "1") + @Schema(description = "分类id", example = "1") private Long categoryId; - @Schema(title = "商品品牌编号", example = "1") + @Schema(description = "商品品牌编号", example = "1") private Long brandId; - @Schema(title = "上下架状态", example = "1", description = "参见 ProductSpuStatusEnum 枚举值") + @Schema(description = "上下架状态,参见 ProductSpuStatusEnum 枚举值", example = "1") private Integer status; - @Schema(title = "销量最小值", example = "1") + @Schema(description = "销量最小值", example = "1") private Integer salesCountMin; - @Schema(title = "销量最大值", example = "1024") + @Schema(description = "销量最大值", example = "1024") private Integer salesCountMax; - @Schema(title = "市场价最小值", example = "1") + @Schema(description = "市场价最小值", example = "1") private Integer marketPriceMin; - @Schema(title = "市场价最大值", example = "1024") + @Schema(description = "市场价最大值", example = "1024") private Integer marketPriceMax; - @Schema(title = "是否库存告警", example = "true") + @Schema(description = "是否库存告警", example = "true") private Boolean alarmStock; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuRespVO.java index 46a1639ad..a08c4900e 100755 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuRespVO.java @@ -8,16 +8,16 @@ import lombok.ToString; import java.time.LocalDateTime; import java.util.List; -@Schema(title = "管理后台 - 商品 SPU Response VO") +@Schema(description = "管理后台 - 商品 SPU Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductSpuRespVO extends ProductSpuBaseVO { - @Schema(title = "主键", required = true, example = "1") + @Schema(description = "主键", required = true, example = "1") private Long id; - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime createTime; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuSimpleRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuSimpleRespVO.java index fe8e9a1c0..9cc7bf169 100755 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuSimpleRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuSimpleRespVO.java @@ -5,22 +5,22 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 商品 SPU 精简 Response VO") +@Schema(description = "管理后台 - 商品 SPU 精简 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductSpuSimpleRespVO extends ProductSpuBaseVO { - @Schema(title = "主键", required = true, example = "1") + @Schema(description = "主键", required = true, example = "1") private Long id; - @Schema(title = "商品名称", required = true, example = "芋道") + @Schema(description = "商品名称", required = true, example = "芋道") private String name; - @Schema(title = " 最小价格，单位使用：分", required = true, example = "1024") + @Schema(description = " 最小价格，单位使用：分", required = true, example = "1024") private Integer minPrice; - @Schema(title = "最大价格，单位使用：分", required = true, example = "1024") + @Schema(description = "最大价格，单位使用：分", required = true, example = "1024") private Integer maxPrice; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuUpdateReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuUpdateReqVO.java index 5c988a3a2..6ea84fb9e 100755 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuUpdateReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/admin/spu/vo/ProductSpuUpdateReqVO.java @@ -10,13 +10,13 @@ import javax.validation.Valid; import javax.validation.constraints.NotNull; import java.util.List; -@Schema(title = "管理后台 - 商品 SPU 更新 Request VO") +@Schema(description = "管理后台 - 商品 SPU 更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ProductSpuUpdateReqVO extends ProductSpuBaseVO { - @Schema(title = "商品编号", required = true, example = "1") + @Schema(description = "商品编号", required = true, example = "1") @NotNull(message = "商品编号不能为空") private Long id; diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/category/vo/AppCategoryRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/category/vo/AppCategoryRespVO.java index 555677b9a..1dca05a3a 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/category/vo/AppCategoryRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/category/vo/AppCategoryRespVO.java @@ -7,21 +7,21 @@ import javax.validation.constraints.NotBlank; import javax.validation.constraints.NotNull; @Data -@Schema(title = "用户 APP - 商品分类 Response VO") +@Schema(description = "用户 APP - 商品分类 Response VO") public class AppCategoryRespVO { - @Schema(title = "分类编号", required = true, example = "2") + @Schema(description = "分类编号", required = true, example = "2") private Long id; - @Schema(title = "父分类编号", required = true, example = "1") + @Schema(description = "父分类编号", required = true, example = "1") @NotNull(message = "父分类编号不能为空") private Long parentId; - @Schema(title = "分类名称", required = true, example = "办公文具") + @Schema(description = "分类名称", required = true, example = "办公文具") @NotBlank(message = "分类名称不能为空") private String name; - @Schema(title = "分类图片", required = true) + @Schema(description = "分类图片", required = true) @NotBlank(message = "分类图片不能为空") private String picUrl; diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/spu/vo/AppSpuPageReqVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/spu/vo/AppSpuPageReqVO.java index facabfa88..fb67a1708 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/spu/vo/AppSpuPageReqVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/spu/vo/AppSpuPageReqVO.java @@ -6,12 +6,12 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "App - 商品spu分页 Request VO") +@Schema(description = "App - 商品spu分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class AppSpuPageReqVO extends PageParam { - @Schema(title = "分类id") + @Schema(description = "分类id") private Long categoryId; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/spu/vo/AppSpuPageRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/spu/vo/AppSpuPageRespVO.java index 074058cb4..20c82afbc 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/spu/vo/AppSpuPageRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/spu/vo/AppSpuPageRespVO.java @@ -6,46 +6,46 @@ import lombok.Data; import javax.validation.constraints.NotNull; import java.util.List; -@Schema(title = "App - 商品spu分页 Request VO") +@Schema(description = "App - 商品spu分页 Request VO") @Data public class AppSpuPageRespVO { - @Schema(title = "主键", required = true, example = "1") + @Schema(description = "主键", required = true, example = "1") private Long id; - @Schema(title = "商品名称") + @Schema(description = "商品名称") private String name; - @Schema(title = "卖点", required = true) + @Schema(description = "卖点", required = true) @NotNull(message = "卖点不能为空") private String sellPoint; - @Schema(title = "描述", required = true) + @Schema(description = "描述", required = true) @NotNull(message = "描述不能为空") private String description; - @Schema(title = "分类id", required = true) + @Schema(description = "分类id", required = true) @NotNull(message = "分类id不能为空") private Long categoryId; - @Schema(title = "商品主图地址,* 数组，以逗号分隔,最多上传15张", required = true) + @Schema(description = "商品主图地址,* 数组，以逗号分隔,最多上传15张", required = true) @NotNull(message = "商品主图地址,* 数组，以逗号分隔,最多上传15张不能为空") private List picUrls; - @Schema(title = "排序字段", required = true) + @Schema(description = "排序字段", required = true) @NotNull(message = "排序字段不能为空") private Integer sort; - @Schema(title = "点赞初始人数") + @Schema(description = "点赞初始人数") private Integer likeCount; - @Schema(title = "价格 单位使用：分") + @Schema(description = "价格 单位使用：分") private Integer price; - @Schema(title = "库存数量") + @Schema(description = "库存数量") private Integer quantity; - @Schema(title = "上下架状态： 0 上架（开启） 1 下架（禁用）") + @Schema(description = "上下架状态： 0 上架（开启） 1 下架（禁用）") private Integer status; } diff --git a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/spu/vo/AppSpuRespVO.java b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/spu/vo/AppSpuRespVO.java index b63a78a52..79072074b 100644 --- a/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/spu/vo/AppSpuRespVO.java +++ b/yudao-module-mall/yudao-module-product-biz/src/main/java/cn/iocoder/yudao/module/product/controller/app/spu/vo/AppSpuRespVO.java @@ -12,7 +12,7 @@ import lombok.EqualsAndHashCode; * * @author LuoWenFeng */ -@Schema(title = "App - 商品spu Response VO") +@Schema(description = "App - 商品spu Response VO") @Data @EqualsAndHashCode(callSuper = true) public class AppSpuRespVO extends ProductSpuRespVO { diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerBaseVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerBaseVO.java index 75109ff12..6c72155f4 100644 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerBaseVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerBaseVO.java @@ -15,28 +15,28 @@ import javax.validation.constraints.NotNull; @Data public class BannerBaseVO { - @Schema(title = "标题", required = true) + @Schema(description = "标题", required = true) @NotNull(message = "标题不能为空") private String title; - @Schema(title = "跳转链接", required = true) + @Schema(description = "跳转链接", required = true) @NotNull(message = "跳转链接不能为空") private String url; - @Schema(title = "图片地址", required = true) + @Schema(description = "图片地址", required = true) @NotNull(message = "图片地址不能为空") private String picUrl; - @Schema(title = "排序", required = true) + @Schema(description = "排序", required = true) @NotNull(message = "排序不能为空") private Integer sort; - @Schema(title = "状态", required = true) + @Schema(description = "状态", required = true) @NotNull(message = "状态不能为空") @InEnum(CommonStatusEnum.class) private Integer status; - @Schema(title = "备注") + @Schema(description = "备注") private String memo; } diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerCreateReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerCreateReqVO.java index 488dc9aa3..eefdd175a 100644 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerCreateReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerCreateReqVO.java @@ -7,7 +7,7 @@ import lombok.ToString; /** * @author xia */ -@Schema(title = "管理后台 - Banner 创建 Request VO") +@Schema(description = "管理后台 - Banner 创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerPageReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerPageReqVO.java index 99729038e..b97008ccd 100644 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerPageReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerPageReqVO.java @@ -16,22 +16,22 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ /** * @author xia */ -@Schema(title = "管理后台 - Banner 分页 Request VO") +@Schema(description = "管理后台 - Banner 分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BannerPageReqVO extends PageParam { - @Schema(title = "标题") + @Schema(description = "标题") private String title; - @Schema(title = "状态") + @Schema(description = "状态") @InEnum(CommonStatusEnum.class) private Integer status; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerRespVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerRespVO.java index 792585c7d..fb0010669 100644 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerRespVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerRespVO.java @@ -10,16 +10,16 @@ import java.time.LocalDateTime; /** * @author xia */ -@Schema(title = "管理后台 - Banner Response VO") +@Schema(description = "管理后台 - Banner Response VO") @Data @ToString(callSuper = true) public class BannerRespVO extends BannerBaseVO { - @Schema(title = "banner编号", required = true) + @Schema(description = "banner编号", required = true) @NotNull(message = "banner编号不能为空") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerUpdateReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerUpdateReqVO.java index db4b28709..033b6054d 100644 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerUpdateReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/banner/vo/BannerUpdateReqVO.java @@ -10,13 +10,13 @@ import javax.validation.constraints.NotNull; /** * @author xia */ -@Schema(title = "管理后台 - Banner更新 Request VO") +@Schema(description = "管理后台 - Banner更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class BannerUpdateReqVO extends BannerBaseVO { - @Schema(title = "banner 编号", required = true) + @Schema(description = "banner 编号", required = true) @NotNull(message = "banner 编号不能为空") private Long id; diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponBaseVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponBaseVO.java index 90f4c7278..43611a903 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponBaseVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponBaseVO.java @@ -24,76 +24,76 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.TIME_ZONE_DE public class CouponBaseVO { // ========== 基本信息 BEGIN ========== - @Schema(title = "优惠劵模板编号", required = true, example = "1024") + @Schema(description = "优惠劵模板编号", required = true, example = "1024") @NotNull(message = "优惠劵模板编号不能为空") private Integer templateId; - @Schema(title = "优惠劵名", required = true, example = "春节送送送") + @Schema(description = "优惠劵名", required = true, example = "春节送送送") @NotNull(message = "优惠劵名不能为空") private String name; - @Schema(title = "优惠码状态", required = true, example = "1", description = "参见 CouponStatusEnum 枚举") + @Schema(description = "优惠码状态,参见 CouponStatusEnum 枚举", required = true, example = "1") private Integer status; // ========== 基本信息 END ========== // ========== 领取情况 BEGIN ========== - @Schema(title = "用户编号", required = true, example = "1") + @Schema(description = "用户编号", required = true, example = "1") @NotNull(message = "用户编号不能为空") private Long userId; - @Schema(title = "领取方式", required = true, example = "1", description = "参见 CouponTakeTypeEnum 枚举类") + @Schema(description = "领取方式,参见 CouponTakeTypeEnum 枚举类", required = true, example = "1") @NotNull(message = "领取方式不能为空") private Integer takeType; // ========== 领取情况 END ========== // ========== 使用规则 BEGIN ========== - @Schema(title = "是否设置满多少金额可用", required = true, example = "100", description = "单位：分；0 - 不限制") + @Schema(description = "是否设置满多少金额可用,单位：分；0 - 不限制", required = true, example = "100") @NotNull(message = "是否设置满多少金额可用不能为空") private Integer usePrice; - @Schema(title = "固定日期 - 生效开始时间") + @Schema(description = "固定日期 - 生效开始时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) @JsonFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND, timezone = TIME_ZONE_DEFAULT) private LocalDateTime validStartTime; - @Schema(title = "固定日期 - 生效结束时间") + @Schema(description = "固定日期 - 生效结束时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) @JsonFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND, timezone = TIME_ZONE_DEFAULT) private LocalDateTime validEndTime; - @Schema(title = "商品范围", required = true, example = "1", description = "参见 PromotionProductScopeEnum 枚举类") + @Schema(description = "商品范围,参见 PromotionProductScopeEnum 枚举类", required = true, example = "1") @NotNull(message = "商品范围不能为空") @InEnum(PromotionProductScopeEnum.class) private Integer productScope; - @Schema(title = "商品 SPU 编号的数组", example = "1,3") + @Schema(description = "商品 SPU 编号的数组", example = "1,3") private List productSpuIds; // ========== 使用规则 END ========== // ========== 使用效果 BEGIN ========== - @Schema(title = "优惠类型", required = true, example = "1", description = "参见 PromotionDiscountTypeEnum 枚举") + @Schema(description = "优惠类型,参见 PromotionDiscountTypeEnum 枚举", required = true, example = "1") @NotNull(message = "优惠类型不能为空") @InEnum(PromotionDiscountTypeEnum.class) private Integer discountType; - @Schema(title = "折扣百分比", example = "80", description = "例如说，80% 为 80") + @Schema(description = "折扣百分比,例如说，80% 为 80", example = "80") private Integer discountPercent; - @Schema(title = "优惠金额", example = "10", description = "单位：分") + @Schema(description = "优惠金额,单位：分", example = "10") @Min(value = 0, message = "优惠金额需要大于等于 0") private Integer discountPrice; - @Schema(title = "折扣上限", example = "100", description = "单位：分，仅在 discountType 为 PERCENT 使用") + @Schema(description = "折扣上限,单位：分，仅在 discountType 为 PERCENT 使用", example = "100") private Integer discountLimitPrice; // ========== 使用效果 END ========== // ========== 使用情况 BEGIN ========== - @Schema(title = "使用订单号", example = "4096") + @Schema(description = "使用订单号", example = "4096") private Long useOrderId; - @Schema(title = "使用时间") + @Schema(description = "使用时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) @JsonFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND, timezone = TIME_ZONE_DEFAULT) private LocalDateTime useTime; diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponPageItemRespVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponPageItemRespVO.java index 7529ee62b..118736ef6 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponPageItemRespVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponPageItemRespVO.java @@ -5,13 +5,13 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 优惠劵分页的每一项 Response VO") +@Schema(description = "管理后台 - 优惠劵分页的每一项 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class CouponPageItemRespVO extends CouponRespVO { - @Schema(title = "用户昵称", example = "老芋艿") + @Schema(description = "用户昵称", example = "老芋艿") private String nickname; } diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponPageReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponPageReqVO.java index ba81ca1d4..e74f6327d 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponPageReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponPageReqVO.java @@ -11,23 +11,23 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 优惠劵分页 Request VO") +@Schema(description = "管理后台 - 优惠劵分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class CouponPageReqVO extends PageParam { - @Schema(title = "优惠劵模板编号", example = "2048") + @Schema(description = "优惠劵模板编号", example = "2048") private Long templateId; - @Schema(title = "优惠码状态", example = "1", description = "参见 CouponStatusEnum 枚举") + @Schema(description = "优惠码状态,参见 CouponStatusEnum 枚举", example = "1") private Integer status; - @Schema(title = "创建时间") + @Schema(description = "创建时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime[] createTime; - @Schema(title = "用户昵称", example = "芋艿", description = "模糊匹配") + @Schema(description = "用户昵称,模糊匹配", example = "芋艿") private String nickname; } diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponRespVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponRespVO.java index 8a07e28dc..68f0bc44e 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponRespVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/coupon/CouponRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 优惠劵 Response VO") +@Schema(description = "管理后台 - 优惠劵 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class CouponRespVO extends CouponBaseVO { - @Schema(title = "优惠劵编号", required = true, example = "1024") + @Schema(description = "优惠劵编号", required = true, example = "1024") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateBaseVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateBaseVO.java index 4c69a443e..0100c91c6 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateBaseVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateBaseVO.java @@ -29,70 +29,70 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.TIME_ZONE_DE @Data public class CouponTemplateBaseVO { - @Schema(title = "优惠劵名", required = true, example = "春节送送送") + @Schema(description = "优惠劵名", required = true, example = "春节送送送") @NotNull(message = "优惠劵名不能为空") private String name; - @Schema(title = "发行总量", required = true, example = "1024", description = "-1 - 则表示不限制发放数量") + @Schema(description = "发行总量,-1 - 则表示不限制发放数量", required = true, example = "1024") @NotNull(message = "发行总量不能为空") private Integer totalCount; - @Schema(title = "每人限领个数", required = true, example = "66", description = "-1 - 则表示不限制") + @Schema(description = "每人限领个数,-1 - 则表示不限制", required = true, example = "66") @NotNull(message = "每人限领个数不能为空") private Integer takeLimitCount; - @Schema(title = "领取方式", required = true, example = "1", description = "参见 CouponTakeTypeEnum 枚举类") + @Schema(description = "领取方式,参见 CouponTakeTypeEnum 枚举类", required = true, example = "1") @NotNull(message = "领取方式不能为空") private Integer takeType; - @Schema(title = "是否设置满多少金额可用", required = true, example = "100", description = "单位：分；0 - 不限制") + @Schema(description = "是否设置满多少金额可用,单位：分；0 - 不限制", required = true, example = "100") @NotNull(message = "是否设置满多少金额可用不能为空") private Integer usePrice; - @Schema(title = "商品范围", required = true, example = "1", description = "参见 PromotionProductScopeEnum 枚举类") + @Schema(description = "商品范围,参见 PromotionProductScopeEnum 枚举类", required = true, example = "1") @NotNull(message = "商品范围不能为空") @InEnum(PromotionProductScopeEnum.class) private Integer productScope; - @Schema(title = "商品 SPU 编号的数组", example = "1,3") + @Schema(description = "商品 SPU 编号的数组", example = "1,3") private List productSpuIds; - @Schema(title = "生效日期类型", required = true, example = "1") + @Schema(description = "生效日期类型", required = true, example = "1") @NotNull(message = "生效日期类型不能为空") @InEnum(CouponTemplateValidityTypeEnum.class) private Integer validityType; - @Schema(title = "固定日期 - 生效开始时间") + @Schema(description = "固定日期 - 生效开始时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) @JsonFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND, timezone = TIME_ZONE_DEFAULT) private LocalDateTime validStartTime; - @Schema(title = "固定日期 - 生效结束时间") + @Schema(description = "固定日期 - 生效结束时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) @JsonFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND, timezone = TIME_ZONE_DEFAULT) private LocalDateTime validEndTime; - @Schema(title = "领取日期 - 开始天数") + @Schema(description = "领取日期 - 开始天数") @Min(value = 0L, message = "开始天数必须大于 0") private Integer fixedStartTerm; - @Schema(title = "领取日期 - 结束天数") + @Schema(description = "领取日期 - 结束天数") @Min(value = 1L, message = "开始天数必须大于 1") private Integer fixedEndTerm; - @Schema(title = "优惠类型", required = true, example = "1", description = "参见 PromotionDiscountTypeEnum 枚举") + @Schema(description = "优惠类型,参见 PromotionDiscountTypeEnum 枚举", required = true, example = "1") @NotNull(message = "优惠类型不能为空") @InEnum(PromotionDiscountTypeEnum.class) private Integer discountType; - @Schema(title = "折扣百分比", example = "80", description = "例如说，80% 为 80") + @Schema(description = "折扣百分比,例如说，80% 为 80", example = "80") private Integer discountPercent; - @Schema(title = "优惠金额", example = "10", description = "单位：分") + @Schema(description = "优惠金额,单位：分", example = "10") @Min(value = 0, message = "优惠金额需要大于等于 0") private Integer discountPrice; - @Schema(title = "折扣上限", example = "100", description = "单位：分，仅在 discountType 为 PERCENT 使用") + @Schema(description = "折扣上限,单位：分，仅在 discountType 为 PERCENT 使用", example = "100") private Integer discountLimitPrice; @AssertTrue(message = "商品 SPU 编号的数组不能为空") diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateCreateReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateCreateReqVO.java index 60c37ee0d..7b24dbbdb 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateCreateReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateCreateReqVO.java @@ -4,7 +4,7 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 优惠劵模板创建 Request VO") +@Schema(description = "管理后台 - 优惠劵模板创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplatePageReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplatePageReqVO.java index 6efb227cc..bcbafcd06 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplatePageReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplatePageReqVO.java @@ -11,22 +11,22 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 优惠劵模板分页 Request VO") +@Schema(description = "管理后台 - 优惠劵模板分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class CouponTemplatePageReqVO extends PageParam { - @Schema(title = "优惠劵名", example = "你好") + @Schema(description = "优惠劵名", example = "你好") private String name; - @Schema(title = "状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; - @Schema(title = "优惠类型", example = "1", description = "参见 PromotionDiscountTypeEnum 枚举") + @Schema(description = "优惠类型,参见 PromotionDiscountTypeEnum 枚举", example = "1") private Integer discountType; - @Schema(title = "创建时间") + @Schema(description = "创建时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime[] createTime; diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateRespVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateRespVO.java index d3d71696b..b90407b43 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateRespVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateRespVO.java @@ -9,26 +9,26 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 优惠劵模板 Response VO") +@Schema(description = "管理后台 - 优惠劵模板 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class CouponTemplateRespVO extends CouponTemplateBaseVO { - @Schema(title = "模板编号", required = true, example = "1024") + @Schema(description = "模板编号", required = true, example = "1024") private Long id; - @Schema(title = "状态", required = true, example = "1") + @Schema(description = "状态", required = true, example = "1") @InEnum(CommonStatusEnum.class) private Integer status; - @Schema(title = "领取优惠券的数量", required = true, example = "1024") + @Schema(description = "领取优惠券的数量", required = true, example = "1024") private Integer takeCount; - @Schema(title = "使用优惠券的次数", required = true, example = "2048") + @Schema(description = "使用优惠券的次数", required = true, example = "2048") private Integer useCount; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateUpdateReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateUpdateReqVO.java index 054ddbf6a..922e4f057 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateUpdateReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateUpdateReqVO.java @@ -7,13 +7,13 @@ import lombok.ToString; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 优惠劵模板更新 Request VO") +@Schema(description = "管理后台 - 优惠劵模板更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class CouponTemplateUpdateReqVO extends CouponTemplateBaseVO { - @Schema(title = "模板编号", required = true, example = "1024") + @Schema(description = "模板编号", required = true, example = "1024") @NotNull(message = "模板编号不能为空") private Long id; diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateUpdateStatusReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateUpdateStatusReqVO.java index 9d6c48c41..f12f6b756 100644 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateUpdateStatusReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/coupon/vo/template/CouponTemplateUpdateStatusReqVO.java @@ -7,15 +7,15 @@ import lombok.Data; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 优惠劵模板更新状态 Request VO") +@Schema(description = "管理后台 - 优惠劵模板更新状态 Request VO") @Data public class CouponTemplateUpdateStatusReqVO { - @Schema(title = "优惠劵模板编号", required = true, example = "1024") + @Schema(description = "优惠劵模板编号", required = true, example = "1024") @NotNull(message = "优惠劵模板编号不能为空") private Long id; - @Schema(title = "状态", required = true, example = "1", description = "见 CommonStatusEnum 枚举") + @Schema(description = "状态,见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") @InEnum(value = CommonStatusEnum.class, message = "修改状态必须是 {value}") private Integer status; diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityBaseVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityBaseVO.java index 35f3da2ad..d30df6c1c 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityBaseVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityBaseVO.java @@ -22,44 +22,44 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @Data public class DiscountActivityBaseVO { - @Schema(title = "活动标题", required = true, example = "一个标题") + @Schema(description = "活动标题", required = true, example = "一个标题") @NotNull(message = "活动标题不能为空") private String name; - @Schema(title = "开始时间", required = true) + @Schema(description = "开始时间", required = true) @NotNull(message = "开始时间不能为空") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime startTime; - @Schema(title = "结束时间", required = true) + @Schema(description = "结束时间", required = true) @NotNull(message = "结束时间不能为空") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime endTime; - @Schema(title = "备注", example = "我是备注") + @Schema(description = "备注", example = "我是备注") private String remark; - @Schema(title = "商品") + @Schema(description = "商品") @Data public static class Product { - @Schema(title = "商品 SPU 编号", required = true, example = "1") + @Schema(description = "商品 SPU 编号", required = true, example = "1") @NotNull(message = "商品 SPU 编号不能为空") private Long spuId; - @Schema(title = "商品 SKU 编号", required = true, example = "1") + @Schema(description = "商品 SKU 编号", required = true, example = "1") @NotNull(message = "商品 SKU 编号不能为空") private Long skuId; - @Schema(title = "优惠类型", required = true, example = "1", description = "参见 PromotionDiscountTypeEnum 枚举") + @Schema(description = "优惠类型,参见 PromotionDiscountTypeEnum 枚举", required = true, example = "1") @NotNull(message = "优惠类型不能为空") @InEnum(PromotionDiscountTypeEnum.class) private Integer discountType; - @Schema(title = "折扣百分比", example = "80", description = "例如说，80% 为 80") + @Schema(description = "折扣百分比,例如说，80% 为 80", example = "80") private Integer discountPercent; - @Schema(title = "优惠金额", example = "10", description = "单位：分") + @Schema(description = "优惠金额,单位：分", example = "10") @Min(value = 0, message = "优惠金额需要大于等于 0") private Integer discountPrice; diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityCreateReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityCreateReqVO.java index 86eedc799..5b22cbd35 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityCreateReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityCreateReqVO.java @@ -8,7 +8,7 @@ import javax.validation.Valid; import javax.validation.constraints.NotEmpty; import java.util.List; -@Schema(title = "管理后台 - 限时折扣活动创建 Request VO") +@Schema(description = "管理后台 - 限时折扣活动创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityDetailRespVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityDetailRespVO.java index 44cc1965c..caa0a648c 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityDetailRespVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityDetailRespVO.java @@ -6,7 +6,7 @@ import lombok.ToString; import java.util.List; -@Schema(title = "管理后台 - 限时折扣活动的详细 Response VO") +@Schema(description = "管理后台 - 限时折扣活动的详细 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityPageReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityPageReqVO.java index 2c8679566..4463555ea 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityPageReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityPageReqVO.java @@ -11,19 +11,19 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 限时折扣活动分页 Request VO") +@Schema(description = "管理后台 - 限时折扣活动分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class DiscountActivityPageReqVO extends PageParam { - @Schema(title = "活动标题", example = "一个标题") + @Schema(description = "活动标题", example = "一个标题") private String name; - @Schema(title = "活动状态", example = "1") + @Schema(description = "活动状态", example = "1") private Integer status; - @Schema(title = "创建时间") + @Schema(description = "创建时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime[] createTime; diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityRespVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityRespVO.java index d46918edf..b552c56ed 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityRespVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityRespVO.java @@ -8,20 +8,20 @@ import lombok.ToString; import javax.validation.constraints.NotNull; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 限时折扣活动 Response VO") +@Schema(description = "管理后台 - 限时折扣活动 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class DiscountActivityRespVO extends DiscountActivityBaseVO { - @Schema(title = "活动编号", required = true, example = "1024") + @Schema(description = "活动编号", required = true, example = "1024") private Long id; - @Schema(title = "活动状态", required = true, example = "1") + @Schema(description = "活动状态", required = true, example = "1") @NotNull(message = "活动状态不能为空") private Integer status; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityUpdateReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityUpdateReqVO.java index ff9aa27b3..f9bf48c06 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityUpdateReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/discount/vo/DiscountActivityUpdateReqVO.java @@ -10,13 +10,13 @@ import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; import java.util.List; -@Schema(title = "管理后台 - 限时折扣活动更新 Request VO") +@Schema(description = "管理后台 - 限时折扣活动更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class DiscountActivityUpdateReqVO extends DiscountActivityBaseVO { - @Schema(title = "活动编号", required = true, example = "1024") + @Schema(description = "活动编号", required = true, example = "1024") @NotNull(message = "活动编号不能为空") private Long id; diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityBaseVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityBaseVO.java index 75ab536de..6896e93c9 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityBaseVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityBaseVO.java @@ -25,35 +25,35 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @Data public class RewardActivityBaseVO { - @Schema(title = "活动标题", required = true, example = "满啦满啦") + @Schema(description = "活动标题", required = true, example = "满啦满啦") @NotNull(message = "活动标题不能为空") private String name; - @Schema(title = "开始时间", required = true) + @Schema(description = "开始时间", required = true) @NotNull(message = "开始时间不能为空") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime startTime; - @Schema(title = "结束时间", required = true) + @Schema(description = "结束时间", required = true) @NotNull(message = "结束时间不能为空") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) @Future(message = "结束时间必须大于当前时间") private LocalDateTime endTime; - @Schema(title = "备注", example = "biubiubiu") + @Schema(description = "备注", example = "biubiubiu") private String remark; - @Schema(title = "条件类型", required = true, example = "1") + @Schema(description = "条件类型", required = true, example = "1") @NotNull(message = "条件类型不能为空") @InEnum(value = PromotionConditionTypeEnum.class, message = "条件类型必须是 {value}") private Integer conditionType; - @Schema(title = "商品范围", required = true, example = "1") + @Schema(description = "商品范围", required = true, example = "1") @NotNull(message = "商品范围不能为空") @InEnum(value = PromotionConditionTypeEnum.class, message = "商品范围必须是 {value}") private Integer productScope; - @Schema(title = "商品 SPU 编号的数组", example = "1,2,3") + @Schema(description = "商品 SPU 编号的数组", example = "1,2,3") private List productSpuIds; /** @@ -62,29 +62,29 @@ public class RewardActivityBaseVO { @Valid // 校验下子对象 private List rules; - @Schema(title = "优惠规则") + @Schema(description = "优惠规则") @Data public static class Rule { - @Schema(title = "优惠门槛", required = true, example = "100", description = "1. 满 N 元，单位：分; 2. 满 N 件") + @Schema(description = "优惠门槛,1. 满 N 元，单位：分; 2. 满 N 件", required = true, example = "100") @Min(value = 1L, message = "优惠门槛必须大于等于 1") private Integer limit; - @Schema(title = "优惠价格", required = true, example = "100", description = "单位：分") + @Schema(description = "优惠价格,单位：分", required = true, example = "100") @Min(value = 1L, message = "优惠价格必须大于等于 1") private Integer discountPrice; - @Schema(title = "是否包邮", required = true, example = "true") + @Schema(description = "是否包邮", required = true, example = "true") private Boolean freeDelivery; - @Schema(title = "赠送的积分", required = true, example = "100") + @Schema(description = "赠送的积分", required = true, example = "100") @Min(value = 1L, message = "赠送的积分必须大于等于 1") private Integer point; - @Schema(title = "赠送的优惠劵编号的数组", example = "1,2,3") + @Schema(description = "赠送的优惠劵编号的数组", example = "1,2,3") private List couponIds; - @Schema(title = "赠送的优惠卷数量的数组", example = "1,2,3") + @Schema(description = "赠送的优惠卷数量的数组", example = "1,2,3") private List couponCounts; @AssertTrue(message = "优惠劵和数量必须一一对应") diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityCreateReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityCreateReqVO.java index 222a704c6..a5f35e030 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityCreateReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityCreateReqVO.java @@ -2,7 +2,7 @@ package cn.iocoder.yudao.module.promotion.controller.admin.reward.vo; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@Schema(title = "管理后台 - 满减送活动创建 Request VO") +@Schema(description = "管理后台 - 满减送活动创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityPageReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityPageReqVO.java index 980f92bfc..dc99e79fa 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityPageReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityPageReqVO.java @@ -3,16 +3,16 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import cn.iocoder.yudao.framework.common.pojo.PageParam; -@Schema(title = "管理后台 - 满减送活动分页 Request VO") +@Schema(description = "管理后台 - 满减送活动分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class RewardActivityPageReqVO extends PageParam { - @Schema(title = "活动标题", example = "满啦满啦") + @Schema(description = "活动标题", example = "满啦满啦") private String name; - @Schema(title = "活动状态", example = "1") + @Schema(description = "活动状态", example = "1") private Integer status; } diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityRespVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityRespVO.java index 2eede11e2..8ad93cb59 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityRespVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityRespVO.java @@ -7,19 +7,19 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 满减送活动 Response VO") +@Schema(description = "管理后台 - 满减送活动 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class RewardActivityRespVO extends RewardActivityBaseVO { - @Schema(title = "活动编号", required = true, example = "1024") + @Schema(description = "活动编号", required = true, example = "1024") private Integer id; - @Schema(title = "活动状态", required = true, example = "1") + @Schema(description = "活动状态", required = true, example = "1") private Integer status; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityUpdateReqVO.java b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityUpdateReqVO.java index 9580868c6..5c1106d1e 100755 --- a/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityUpdateReqVO.java +++ b/yudao-module-mall/yudao-module-promotion-biz/src/main/java/cn/iocoder/yudao/module/promotion/controller/admin/reward/vo/RewardActivityUpdateReqVO.java @@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 满减送活动更新 Request VO") +@Schema(description = "管理后台 - 满减送活动更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class RewardActivityUpdateReqVO extends RewardActivityBaseVO { - @Schema(title = "活动编号", required = true, example = "1024") + @Schema(description = "活动编号", required = true, example = "1024") @NotNull(message = "活动编号不能为空") private Long id; diff --git a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/base/property/AppProductPropertyValueDetailRespVO.java b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/base/property/AppProductPropertyValueDetailRespVO.java index c4ec055c8..42b58e8e0 100644 --- a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/base/property/AppProductPropertyValueDetailRespVO.java +++ b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/base/property/AppProductPropertyValueDetailRespVO.java @@ -3,20 +3,20 @@ package cn.iocoder.yudao.module.trade.controller.app.base.property; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(title = "用户 App - 规格 + 规格值 Response VO") +@Schema(description = "用户 App - 规格 + 规格值 Response VO") @Data public class AppProductPropertyValueDetailRespVO { - @Schema(title = "属性的编号", required = true, example = "1") + @Schema(description = "属性的编号", required = true, example = "1") private Long propertyId; - @Schema(title = "属性的名称", required = true, example = "颜色") + @Schema(description = "属性的名称", required = true, example = "颜色") private String propertyName; - @Schema(title = "属性值的编号", required = true, example = "1024") + @Schema(description = "属性值的编号", required = true, example = "1024") private Long valueId; - @Schema(title = "属性值的名称", required = true, example = "红色") + @Schema(description = "属性值的名称", required = true, example = "红色") private String valueName; } diff --git a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/base/sku/AppProductSkuBaseRespVO.java b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/base/sku/AppProductSkuBaseRespVO.java index 5d6499517..446f7f354 100644 --- a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/base/sku/AppProductSkuBaseRespVO.java +++ b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/base/sku/AppProductSkuBaseRespVO.java @@ -14,16 +14,16 @@ import java.util.List; @Data public class AppProductSkuBaseRespVO { - @Schema(title = "主键", required = true, example = "1024") + @Schema(description = "主键", required = true, example = "1024") private Long id; - @Schema(title = "商品 SKU 名字", required = true, example = "芋道") + @Schema(description = "商品 SKU 名字", required = true, example = "芋道") private String name; - @Schema(title = "图片地址", example = "https://www.iocoder.cn/xx.png") + @Schema(description = "图片地址", example = "https://www.iocoder.cn/xx.png") private String picUrl; - @Schema(title = "库存", required = true, example = "1") + @Schema(description = "库存", required = true, example = "1") private Integer stock; /** diff --git a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/base/spu/AppProductSpuBaseRespVO.java b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/base/spu/AppProductSpuBaseRespVO.java index a3ebf3fe8..61ecf59d2 100644 --- a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/base/spu/AppProductSpuBaseRespVO.java +++ b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/base/spu/AppProductSpuBaseRespVO.java @@ -12,13 +12,13 @@ import java.util.List; @Data public class AppProductSpuBaseRespVO { - @Schema(title = "主键", required = true, example = "1024") + @Schema(description = "主键", required = true, example = "1024") private Long id; - @Schema(title = "商品 SPU 名字", required = true, example = "芋道") + @Schema(description = "商品 SPU 名字", required = true, example = "芋道") private String name; - @Schema(title = "商品主图地址", example = "https://www.iocoder.cn/xx.png") + @Schema(description = "商品主图地址", example = "https://www.iocoder.cn/xx.png") private List picUrls; } diff --git a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartDetailRespVO.java b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartDetailRespVO.java index 359917887..f58421b68 100644 --- a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartDetailRespVO.java +++ b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartDetailRespVO.java @@ -6,7 +6,7 @@ import lombok.Data; import java.util.List; -@Schema(title = "用户 App - 用户的购物车明细 Response VO") +@Schema(description = "用户 App - 用户的购物车明细 Response VO") @Data public class AppTradeCartDetailRespVO { @@ -20,7 +20,7 @@ public class AppTradeCartDetailRespVO { */ private Order order; - @Schema(title = "商品分组", description = "多个商品，参加同一个活动，从而形成分组") + @Schema(description = "商品分组,多个商品，参加同一个活动，从而形成分组") @Data public static class ItemGroup { @@ -35,7 +35,7 @@ public class AppTradeCartDetailRespVO { } - @Schema(title = "商品 SKU") + @Schema(description = "商品 SKU") @Data public static class Sku extends AppProductSkuBaseRespVO { @@ -46,26 +46,26 @@ public class AppTradeCartDetailRespVO { // ========== 购物车相关的字段 ========== - @Schema(title = "商品数量", required = true, example = "1") + @Schema(description = "商品数量", required = true, example = "1") private Integer count; - @Schema(title = "是否选中", required = true, example = "true") + @Schema(description = "是否选中", required = true, example = "true") private Boolean selected; // ========== 价格相关的字段，对应 PriceCalculateRespDTO.OrderItem 的属性 ========== // TODO 芋艿：后续可以去除一些无用的字段 - @Schema(title = "商品原价（单）", required = true, example = "100") + @Schema(description = "商品原价（单）", required = true, example = "100") private Integer originalPrice; - @Schema(title = "商品原价（总）", required = true, example = "200") + @Schema(description = "商品原价（总）", required = true, example = "200") private Integer totalOriginalPrice; - @Schema(title = "商品级优惠（总）", required = true, example = "300") + @Schema(description = "商品级优惠（总）", required = true, example = "300") private Integer totalPromotionPrice; - @Schema(title = "最终购买金额（总）", required = true, example = "400") + @Schema(description = "最终购买金额（总）", required = true, example = "400") private Integer totalPresentPrice; - @Schema(title = "最终购买金额（单）", required = true, example = "500") + @Schema(description = "最终购买金额（单）", required = true, example = "500") private Integer presentPrice; - @Schema(title = "应付金额（总）", required = true, example = "600") + @Schema(description = "应付金额（总）", required = true, example = "600") private Integer totalPayPrice; // ========== 营销相关的字段 ========== @@ -76,40 +76,40 @@ public class AppTradeCartDetailRespVO { } - @Schema(title = "订单", description = "对应 PriceCalculateRespDTO.Order 类，用于费用（合计）") + @Schema(description = "订单,对应 PriceCalculateRespDTO.Order 类，用于费用（合计）") @Data public static class Order { // TODO 芋艿：后续可以去除一些无用的字段 - @Schema(title = "商品原价（总）", required = true, example = "100") + @Schema(description = "商品原价（总）", required = true, example = "100") private Integer skuOriginalPrice; - @Schema(title = "商品优惠（总）", required = true, example = "200") + @Schema(description = "商品优惠（总）", required = true, example = "200") private Integer skuPromotionPrice; - @Schema(title = "订单优惠（总）", required = true, example = "300") + @Schema(description = "订单优惠（总）", required = true, example = "300") private Integer orderPromotionPrice; - @Schema(title = "运费金额", required = true, example = "400") + @Schema(description = "运费金额", required = true, example = "400") private Integer deliveryPrice; - @Schema(title = "应付金额（总）", required = true, example = "500") + @Schema(description = "应付金额（总）", required = true, example = "500") private Integer payPrice; } - @Schema(title = "营销活动", description = "对应 PriceCalculateRespDTO.Promotion 类的属性") + @Schema(description = "营销活动,对应 PriceCalculateRespDTO.Promotion 类的属性") @Data public static class Promotion { - @Schema(title = "营销编号", required = true, example = "1024", description = "营销活动的编号、优惠劵的编号") + @Schema(description = "营销编号,营销活动的编号、优惠劵的编号", required = true, example = "1024") private Long id; - @Schema(title = "营销名字", required = true, example = "xx 活动") + @Schema(description = "营销名字", required = true, example = "xx 活动") private String name; - @Schema(title = "营销类型", required = true, example = "1", description = "参见 PromotionTypeEnum 枚举类") + @Schema(description = "营销类型,参见 PromotionTypeEnum 枚举类", required = true, example = "1") private Integer type; // ========== 匹配情况 ========== - @Schema(title = "是否满足优惠条件", required = true, example = "true") + @Schema(description = "是否满足优惠条件", required = true, example = "true") private Boolean meet; - @Schema(title = "满足条件的提示", required = true, example = "圣诞价:省 150.00 元") + @Schema(description = "满足条件的提示", required = true, example = "圣诞价:省 150.00 元") private String meetTip; } diff --git a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartItemAddCountReqVO.java b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartItemAddCountReqVO.java index 20c1e9e8b..280150537 100644 --- a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartItemAddCountReqVO.java +++ b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartItemAddCountReqVO.java @@ -6,15 +6,15 @@ import lombok.Data; import javax.validation.constraints.Min; import javax.validation.constraints.NotNull; -@Schema(title = "用户 App - 购物车添加购物项 Request VO") +@Schema(description = "用户 App - 购物车添加购物项 Request VO") @Data public class AppTradeCartItemAddCountReqVO { - @Schema(title = "商品 SKU 编号", required = true,example = "1024") + @Schema(description = "商品 SKU 编号", required = true,example = "1024") @NotNull(message = "商品 SKU 编号不能为空") private Long skuId; - @Schema(title = "商品数量", required = true, example = "1", description = "注意，这是新增数量") + @Schema(description = "商品数量,注意，这是新增数量", required = true, example = "1") @NotNull(message = "数量不能为空") @Min(message = "数量必须大于 0", value = 1L) private Integer count; diff --git a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartItemUpdateCountReqVO.java b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartItemUpdateCountReqVO.java index 3854b1bec..d3d12487e 100644 --- a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartItemUpdateCountReqVO.java +++ b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartItemUpdateCountReqVO.java @@ -6,15 +6,15 @@ import lombok.Data; import javax.validation.constraints.Min; import javax.validation.constraints.NotNull; -@Schema(title = "用户 App - 购物车更新数量 Request VO") +@Schema(description = "用户 App - 购物车更新数量 Request VO") @Data public class AppTradeCartItemUpdateCountReqVO { - @Schema(title = "商品 SKU 编号", required = true, example = "1024") + @Schema(description = "商品 SKU 编号", required = true, example = "1024") @NotNull(message = "商品 SKU 编号不能为空") private Long skuId; - @Schema(title = "商品数量", required = true, example = "1") + @Schema(description = "商品数量", required = true, example = "1") @NotNull(message = "数量不能为空") @Min(message = "数量必须大于 0", value = 1L) private Integer count; diff --git a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartItemUpdateSelectedReqVO.java b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartItemUpdateSelectedReqVO.java index f126ed41b..62327f320 100644 --- a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartItemUpdateSelectedReqVO.java +++ b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/cart/vo/AppTradeCartItemUpdateSelectedReqVO.java @@ -6,15 +6,15 @@ import lombok.Data; import javax.validation.constraints.NotNull; import java.util.Collection; -@Schema(title = "用户 App - 购物车更新是否选中 Request VO") +@Schema(description = "用户 App - 购物车更新是否选中 Request VO") @Data public class AppTradeCartItemUpdateSelectedReqVO { - @Schema(title = "商品 SKU 编号列表", required = true, example = "1024,2048") + @Schema(description = "商品 SKU 编号列表", required = true, example = "1024,2048") @NotNull(message = "商品 SKU 编号列表不能为空") private Collection skuIds; - @Schema(title = "是否选中", required = true, example = "true") + @Schema(description = "是否选中", required = true, example = "true") @NotNull(message = "是否选中不能为空") private Boolean selected; diff --git a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/AppTradeOrderCreateReqVO.java b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/AppTradeOrderCreateReqVO.java index 99700d2e7..e5b9e8e97 100644 --- a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/AppTradeOrderCreateReqVO.java +++ b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/AppTradeOrderCreateReqVO.java @@ -8,21 +8,21 @@ import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; import java.util.List; -@Schema(title = "用户 App - 交易订单创建 Request VO") +@Schema(description = "用户 App - 交易订单创建 Request VO") @Data public class AppTradeOrderCreateReqVO { - @Schema(name = "收件地址编号", required = true, example = "1") + @Schema(description = "收件地址编号", required = true, example = "1") @NotNull(message = "收件地址不能为空") private Long addressId; - @Schema(name = "优惠劵编号", example = "1024") + @Schema(description = "优惠劵编号", example = "1024") private Long couponId; - @Schema(name = "备注", example = "这个是我的订单哟") + @Schema(description = "备注", example = "这个是我的订单哟") private String remark; - @Schema(name = "是否来自购物车", required = true, example = "true", description = "true - 来自购物车；false - 立即购买") + @Schema(description = "是否来自购物车,true - 来自购物车；false - 立即购买", required = true, example = "true") @NotNull(message = "是否来自购物车不能为空") private Boolean fromCart; @@ -32,15 +32,15 @@ public class AppTradeOrderCreateReqVO { @NotEmpty(message = "必须选择购买的商品") private List items; - @Schema(title = "订单商品项") + @Schema(description = "订单商品项") @Data public static class Item { - @Schema(name = "商品 SKU 编号", required = true, example = "111") + @Schema(description = "商品 SKU 编号", required = true, example = "111") @NotNull(message = "商品 SKU 编号不能为空") private Long skuId; - @Schema(name = "商品 SKU 购买数量", required = true, example = "1024") + @Schema(description = "商品 SKU 购买数量", required = true, example = "1024") @NotNull(message = "商品 SKU 购买数量不能为空") @Min(value = 1, message = "商品 SKU 购买数量必须大于 0") private Integer count; diff --git a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/AppTradeOrderGetCreateInfoRespVO.java b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/AppTradeOrderGetCreateInfoRespVO.java index ee73df098..873e12481 100644 --- a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/AppTradeOrderGetCreateInfoRespVO.java +++ b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/AppTradeOrderGetCreateInfoRespVO.java @@ -6,7 +6,7 @@ import lombok.Data; import java.util.List; -@Schema(title = "用户 App - 订单获得创建信息 Response VO") +@Schema(description = "用户 App - 订单获得创建信息 Response VO") @Data public class AppTradeOrderGetCreateInfoRespVO { @@ -24,7 +24,7 @@ public class AppTradeOrderGetCreateInfoRespVO { // */ // private List coupons; - @Schema(title = "商品分组", description = "多个商品，参加同一个活动，从而形成分组") + @Schema(description = "商品分组,多个商品，参加同一个活动，从而形成分组") @Data public static class ItemGroup { @@ -39,12 +39,12 @@ public class AppTradeOrderGetCreateInfoRespVO { } - @Schema(title = "商品 SKU") + @Schema(description = "商品 SKU") @Data public static class Sku { // SKU 自带信息 - @Schema(title = "SKU 编号", required = true, example = "1024") + @Schema(description = "SKU 编号", required = true, example = "1024") private Integer id; /** * SPU 信息 @@ -139,12 +139,12 @@ public class AppTradeOrderGetCreateInfoRespVO { } - @Schema(title = "费用（合计）") + @Schema(description = "费用（合计）") @Data @AllArgsConstructor public static class Fee { - @Schema(title = "购买总价", required = true, example = "1024") + @Schema(description = "购买总价", required = true, example = "1024") private Integer buyPrice; /** * 优惠总价 diff --git a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/TradeOrderItemRespVO.java b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/TradeOrderItemRespVO.java index a792c756e..6c92ceb0d 100644 --- a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/TradeOrderItemRespVO.java +++ b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/TradeOrderItemRespVO.java @@ -5,47 +5,47 @@ import lombok.Data; import java.time.LocalDateTime; -@Schema(title = "交易订单项 Response VO") +@Schema(description = "交易订单项 Response VO") @Data public class TradeOrderItemRespVO { - @Schema(title = "id自增长", required = true) + @Schema(description = "id自增长", required = true) private Integer id; - @Schema(title = "订单编号", required = true) + @Schema(description = "订单编号", required = true) private Integer orderId; - @Schema(title = "订单项状态", required = true) + @Schema(description = "订单项状态", required = true) private Integer status; - @Schema(title = "商品 SKU 编号", required = true) + @Schema(description = "商品 SKU 编号", required = true) private Integer skuId; - @Schema(title = "商品 SPU 编号", required = true) + @Schema(description = "商品 SPU 编号", required = true) private Integer spuId; - @Schema(title = "商品名字", required = true) + @Schema(description = "商品名字", required = true) private String skuName; - @Schema(title = "图片名字", required = true) + @Schema(description = "图片名字", required = true) private String skuImage; - @Schema(title = "商品数量", required = true) + @Schema(description = "商品数量", required = true) private Integer quantity; - @Schema(title = "原始单价，单位：分", required = true) + @Schema(description = "原始单价，单位：分", required = true) private Integer originPrice; - @Schema(title = "购买单价，单位：分", required = true) + @Schema(description = "购买单价，单位：分", required = true) private Integer buyPrice; - @Schema(title = "最终价格，单位：分", required = true) + @Schema(description = "最终价格，单位：分", required = true) private Integer presentPrice; - @Schema(title = "购买总金额，单位：分", required = true) + @Schema(description = "购买总金额，单位：分", required = true) private Integer buyTotal; - @Schema(title = "优惠总金额，单位：分", required = true) + @Schema(description = "优惠总金额，单位：分", required = true) private Integer discountTotal; - @Schema(title = "最终总金额，单位：分", required = true) + @Schema(description = "最终总金额，单位：分", required = true) private Integer presentTotal; - @Schema(title = "退款总金额，单位：分", required = true) + @Schema(description = "退款总金额，单位：分", required = true) private Integer refundTotal; - @Schema(title = "物流id") + @Schema(description = "物流id") private Integer logisticsId; - @Schema(title = "售后状态", required = true) + @Schema(description = "售后状态", required = true) private Integer afterSaleStatus; - @Schema(title = "售后订单编号") + @Schema(description = "售后订单编号") private Integer afterSaleOrderId; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; diff --git a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/TradeOrderPageReqVO.java b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/TradeOrderPageReqVO.java index 23b5e9d47..4a408f4a9 100644 --- a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/TradeOrderPageReqVO.java +++ b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/TradeOrderPageReqVO.java @@ -5,12 +5,12 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; -@Schema(title = "交易订单分页 Request VO") +@Schema(description = "交易订单分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class TradeOrderPageReqVO extends PageParam { - @Schema(title = "订单状态", example = "1", description = "参见 TradeOrderStatusEnum 枚举") + @Schema(description = "订单状态-参见 TradeOrderStatusEnum 枚举", example = "1") private Integer orderStatus; } diff --git a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/TradeOrderRespVO.java b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/TradeOrderRespVO.java index c8630416d..85a902e1d 100644 --- a/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/TradeOrderRespVO.java +++ b/yudao-module-mall/yudao-module-trade-biz/src/main/java/cn/iocoder/yudao/module/trade/controller/app/order/vo/TradeOrderRespVO.java @@ -5,59 +5,59 @@ import lombok.*; import java.time.LocalDateTime; import java.util.*; -@Schema(title = "订单交易 Response VO") +@Schema(description = "订单交易 Response VO") @Data public class TradeOrderRespVO { - @Schema(title = "订单编号", required = true) + @Schema(description = "订单编号", required = true) private Integer id; - @Schema(title = "用户编号", required = true) + @Schema(description = "用户编号", required = true) private Integer userId; - @Schema(title = "订单单号", required = true) + @Schema(description = "订单单号", required = true) private String orderNo; - @Schema(title = "订单状态", required = true) + @Schema(description = "订单状态", required = true) private Integer orderStatus; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; - @Schema(title = "订单结束时间") + @Schema(description = "订单结束时间") private LocalDateTime endTime; - @Schema(title = "订单金额(总金额)，单位：分", required = true) + @Schema(description = "订单金额(总金额)，单位：分", required = true) private Integer buyPrice; - @Schema(title = "优惠总金额，单位：分", required = true) + @Schema(description = "优惠总金额，单位：分", required = true) private Integer discountPrice; - @Schema(title = "物流金额，单位：分", required = true) + @Schema(description = "物流金额，单位：分", required = true) private Integer logisticsPrice; - @Schema(title = "最终金额，单位：分", required = true) + @Schema(description = "最终金额，单位：分", required = true) private Integer presentPrice; - @Schema(title = "支付金额，单位：分", required = true) + @Schema(description = "支付金额，单位：分", required = true) private Integer payPrice; - @Schema(title = "退款金额，单位：分", required = true) + @Schema(description = "退款金额，单位：分", required = true) private Integer refundPrice; - @Schema(title = "付款时间") + @Schema(description = "付款时间") private LocalDateTime payTime; - @Schema(title = "支付订单编号") + @Schema(description = "支付订单编号") private Integer payTransactionId; - @Schema(title = "支付渠道") + @Schema(description = "支付渠道") private Integer payChannel; - @Schema(title = "配送类型", required = true) + @Schema(description = "配送类型", required = true) private Integer deliveryType; - @Schema(title = "发货时间") + @Schema(description = "发货时间") private LocalDateTime deliveryTime; - @Schema(title = "收货时间") + @Schema(description = "收货时间") private LocalDateTime receiveTime; - @Schema(title = "收件人名称", required = true) + @Schema(description = "收件人名称", required = true) private String receiverName; - @Schema(title = "手机号", required = true) + @Schema(description = "手机号", required = true) private String receiverMobile; - @Schema(title = "地区编码", required = true) + @Schema(description = "地区编码", required = true) private Integer receiverAreaCode; - @Schema(title = "收件详细地址", required = true) + @Schema(description = "收件详细地址", required = true) private String receiverDetailAddress; - @Schema(title = "售后状态", required = true) + @Schema(description = "售后状态", required = true) private Integer afterSaleStatus; - @Schema(title = "优惠劵编号") + @Schema(description = "优惠劵编号") private Integer couponCardId; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; /** diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressBaseVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressBaseVO.java index e82f78ea3..f207ad8be 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressBaseVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressBaseVO.java @@ -12,27 +12,27 @@ import javax.validation.constraints.NotNull; @Data public class AppAddressBaseVO { - @Schema(title = "收件人名称", required = true) + @Schema(description = "收件人名称", required = true) @NotNull(message = "收件人名称不能为空") private String name; - @Schema(title = "手机号", required = true) + @Schema(description = "手机号", required = true) @NotNull(message = "手机号不能为空") private String mobile; - @Schema(title = "地区编号", required = true) + @Schema(description = "地区编号", required = true) @NotNull(message = "地区编号不能为空") private Long areaId; - @Schema(title = "邮编", required = true) + @Schema(description = "邮编", required = true) @NotEmpty(message = "邮编不能为空") private String postCode; - @Schema(title = "收件详细地址", required = true) + @Schema(description = "收件详细地址", required = true) @NotNull(message = "收件详细地址不能为空") private String detailAddress; - @Schema(title = "是否默认地址", required = true) + @Schema(description = "是否默认地址", required = true) @NotNull(message = "是否默认地址不能为空") private Boolean defaulted; diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressCreateReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressCreateReqVO.java index deaa7da87..c92687f27 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressCreateReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressCreateReqVO.java @@ -2,7 +2,7 @@ package cn.iocoder.yudao.module.member.controller.app.address.vo; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@Schema(title = "用户 APP - 用户收件地址创建 Request VO") +@Schema(description = "用户 APP - 用户收件地址创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressRespVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressRespVO.java index 0acc49b7b..4e9df9912 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressRespVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressRespVO.java @@ -3,16 +3,16 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import java.time.LocalDateTime; -@Schema(title = "用户 APP - 用户收件地址 Response VO") +@Schema(description = "用户 APP - 用户收件地址 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class AppAddressRespVO extends AppAddressBaseVO { - @Schema(title = "编号", required = true) + @Schema(description = "编号", required = true) private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressUpdateReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressUpdateReqVO.java index c93d1dbc2..f94197ece 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressUpdateReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/address/vo/AppAddressUpdateReqVO.java @@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "用户 APP - 用户收件地址更新 Request VO") +@Schema(description = "用户 APP - 用户收件地址更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class AppAddressUpdateReqVO extends AppAddressBaseVO { - @Schema(title = "编号", required = true) + @Schema(description = "编号", required = true) @NotNull(message = "编号不能为空") private Long id; diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthCheckCodeReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthCheckCodeReqVO.java index 8cdd0fcd6..170ffa504 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthCheckCodeReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthCheckCodeReqVO.java @@ -15,25 +15,25 @@ import javax.validation.constraints.NotNull; import javax.validation.constraints.Pattern; // TODO 芋艿：code review 相关逻辑 -@Schema(title = "用户 APP - 校验验证码 Request VO") +@Schema(description = "用户 APP - 校验验证码 Request VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AppAuthCheckCodeReqVO { - @Schema(title = "手机号", example = "15601691234") + @Schema(description = "手机号", example = "15601691234") @NotBlank(message = "手机号不能为空") @Mobile private String mobile; - @Schema(title = "手机验证码", required = true, example = "1024") + @Schema(description = "手机验证码", required = true, example = "1024") @NotBlank(message = "手机验证码不能为空") @Length(min = 4, max = 6, message = "手机验证码长度为 4-6 位") @Pattern(regexp = "^[0-9]+$", message = "手机验证码必须都是数字") private String code; - @Schema(title = "发送场景", example = "1", description = "对应 SmsSceneEnum 枚举") + @Schema(description = "发送场景,对应 SmsSceneEnum 枚举", example = "1") @NotNull(message = "发送场景不能为空") @InEnum(SmsSceneEnum.class) private Integer scene; diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthLoginReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthLoginReqVO.java index 9c347b990..237cd15dc 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthLoginReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthLoginReqVO.java @@ -14,33 +14,33 @@ import org.hibernate.validator.constraints.Length; import javax.validation.constraints.AssertTrue; import javax.validation.constraints.NotEmpty; -@Schema(title = "用户 APP - 手机 + 密码登录 Request VO", description = "如果登录并绑定社交用户，需要传递 social 开头的参数") +@Schema(description = "用户 APP - 手机 + 密码登录 Request VO,如果登录并绑定社交用户，需要传递 social 开头的参数") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AppAuthLoginReqVO { - @Schema(title = "手机号", required = true, example = "15601691300") + @Schema(description = "手机号", required = true, example = "15601691300") @NotEmpty(message = "手机号不能为空") @Mobile private String mobile; - @Schema(title = "密码", required = true, example = "buzhidao") + @Schema(description = "密码", required = true, example = "buzhidao") @NotEmpty(message = "密码不能为空") @Length(min = 4, max = 16, message = "密码长度为 4-16 位") private String password; // ========== 绑定社交登录时，需要传递如下参数 ========== - @Schema(title = "社交平台的类型", required = true, example = "10", description = "参见 SysUserSocialTypeEnum 枚举值") + @Schema(description = "社交平台的类型,参见 SysUserSocialTypeEnum 枚举值", required = true, example = "10") @InEnum(SocialTypeEnum.class) private Integer socialType; - @Schema(title = "授权码", required = true, example = "1024") + @Schema(description = "授权码", required = true, example = "1024") private String socialCode; - @Schema(title = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") + @Schema(description = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") private String socialState; @AssertTrue(message = "授权码不能为空") diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthLoginRespVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthLoginRespVO.java index 734c01591..3794b1f4c 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthLoginRespVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthLoginRespVO.java @@ -8,23 +8,23 @@ import lombok.NoArgsConstructor; import java.time.LocalDateTime; -@Schema(title = "用户 APP - 登录 Response VO") +@Schema(description = "用户 APP - 登录 Response VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AppAuthLoginRespVO { - @Schema(title = "用户编号", required = true, example = "1024") + @Schema(description = "用户编号", required = true, example = "1024") private Long userId; - @Schema(title = "访问令牌", required = true, example = "happy") + @Schema(description = "访问令牌", required = true, example = "happy") private String accessToken; - @Schema(title = "刷新令牌", required = true, example = "nice") + @Schema(description = "刷新令牌", required = true, example = "nice") private String refreshToken; - @Schema(title = "过期时间", required = true) + @Schema(description = "过期时间", required = true) private LocalDateTime expiresTime; } diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthResetPasswordReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthResetPasswordReqVO.java index 0be071a84..e25139a31 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthResetPasswordReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthResetPasswordReqVO.java @@ -13,25 +13,25 @@ import javax.validation.constraints.NotEmpty; import javax.validation.constraints.Pattern; // TODO 芋艿：code review 相关逻辑 -@Schema(title = "用户 APP - 重置密码 Request VO") +@Schema(description = "用户 APP - 重置密码 Request VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AppAuthResetPasswordReqVO { - @Schema(title = "新密码", required = true, example = "buzhidao") + @Schema(description = "新密码", required = true, example = "buzhidao") @NotEmpty(message = "新密码不能为空") @Length(min = 4, max = 16, message = "密码长度为 4-16 位") private String password; - @Schema(title = "手机验证码", required = true, example = "1024") + @Schema(description = "手机验证码", required = true, example = "1024") @NotEmpty(message = "手机验证码不能为空") @Length(min = 4, max = 6, message = "手机验证码长度为 4-6 位") @Pattern(regexp = "^[0-9]+$", message = "手机验证码必须都是数字") private String code; - @Schema(title = "手机号",required = true,example = "15878962356") + @Schema(description = "手机号",required = true,example = "15878962356") @NotBlank(message = "手机号不能为空") @Mobile private String mobile; diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthSmsLoginReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthSmsLoginReqVO.java index 256a59452..c4fb20528 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthSmsLoginReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthSmsLoginReqVO.java @@ -15,19 +15,19 @@ import javax.validation.constraints.AssertTrue; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.Pattern; -@Schema(title = "用户 APP - 手机 + 验证码登录 Request VO", description = "如果登录并绑定社交用户，需要传递 social 开头的参数") +@Schema(description = "用户 APP - 手机 + 验证码登录 Request VO,如果登录并绑定社交用户，需要传递 social 开头的参数") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AppAuthSmsLoginReqVO { - @Schema(title = "手机号", required = true, example = "15601691300") + @Schema(description = "手机号", required = true, example = "15601691300") @NotEmpty(message = "手机号不能为空") @Mobile private String mobile; - @Schema(title = "手机验证码", required = true, example = "1024") + @Schema(description = "手机验证码", required = true, example = "1024") @NotEmpty(message = "手机验证码不能为空") @Length(min = 4, max = 6, message = "手机验证码长度为 4-6 位") @Pattern(regexp = "^[0-9]+$", message = "手机验证码必须都是数字") @@ -35,14 +35,14 @@ public class AppAuthSmsLoginReqVO { // ========== 绑定社交登录时，需要传递如下参数 ========== - @Schema(title = "社交平台的类型", required = true, example = "10", description = "参见 SysUserSocialTypeEnum 枚举值") + @Schema(description = "社交平台的类型,参见 SysUserSocialTypeEnum 枚举值", required = true, example = "10") @InEnum(SocialTypeEnum.class) private Integer socialType; - @Schema(title = "授权码", required = true, example = "1024") + @Schema(description = "授权码", required = true, example = "1024") private String socialCode; - @Schema(title = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") + @Schema(description = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") private String socialState; @AssertTrue(message = "授权码不能为空") diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthSmsSendReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthSmsSendReqVO.java index aaf4e30c7..5f4b030f3 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthSmsSendReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthSmsSendReqVO.java @@ -9,16 +9,16 @@ import lombok.experimental.Accessors; import javax.validation.constraints.NotNull; -@Schema(title = "用户 APP - 发送手机验证码 Request VO") +@Schema(description = "用户 APP - 发送手机验证码 Request VO") @Data @Accessors(chain = true) public class AppAuthSmsSendReqVO { - @Schema(title = "手机号", example = "15601691234") + @Schema(description = "手机号", example = "15601691234") @Mobile private String mobile; - @Schema(title = "发送场景", example = "1", description = "对应 SmsSceneEnum 枚举") + @Schema(description = "发送场景,对应 SmsSceneEnum 枚举", example = "1") @NotNull(message = "发送场景不能为空") @InEnum(SmsSceneEnum.class) private Integer scene; diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthSocialLoginReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthSocialLoginReqVO.java index 237017962..21d328064 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthSocialLoginReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthSocialLoginReqVO.java @@ -11,23 +11,23 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; -@Schema(title = "用户 APP - 社交快捷登录 Request VO，使用 code 授权码") +@Schema(description = "用户 APP - 社交快捷登录 Request VO，使用 code 授权码") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AppAuthSocialLoginReqVO { - @Schema(title = "社交平台的类型", required = true, example = "10", description = "参见 SysUserSocialTypeEnum 枚举值") + @Schema(description = "社交平台的类型,参见 SysUserSocialTypeEnum 枚举值", required = true, example = "10") @InEnum(SocialTypeEnum.class) @NotNull(message = "社交平台的类型不能为空") private Integer type; - @Schema(title = "授权码", required = true, example = "1024") + @Schema(description = "授权码", required = true, example = "1024") @NotEmpty(message = "授权码不能为空") private String code; - @Schema(title = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") + @Schema(description = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") @NotEmpty(message = "state 不能为空") private String state; diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthUpdatePasswordReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthUpdatePasswordReqVO.java index d1926c9bb..e2a2d25be 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthUpdatePasswordReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthUpdatePasswordReqVO.java @@ -11,19 +11,19 @@ import javax.validation.constraints.NotBlank; import javax.validation.constraints.NotEmpty; // TODO 芋艿：code review 相关逻辑 -@Schema(title = "用户 APP - 修改密码 Request VO") +@Schema(description = "用户 APP - 修改密码 Request VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AppAuthUpdatePasswordReqVO { - @Schema(title = "用户旧密码", required = true, example = "123456") + @Schema(description = "用户旧密码", required = true, example = "123456") @NotBlank(message = "旧密码不能为空") @Length(min = 4, max = 16, message = "密码长度为 4-16 位") private String oldPassword; - @Schema(title = "新密码", required = true, example = "buzhidao") + @Schema(description = "新密码", required = true, example = "buzhidao") @NotEmpty(message = "新密码不能为空") @Length(min = 4, max = 16, message = "密码长度为 4-16 位") private String password; diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthWeixinMiniAppLoginReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthWeixinMiniAppLoginReqVO.java index 5245507a6..66475d013 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthWeixinMiniAppLoginReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/auth/vo/AppAuthWeixinMiniAppLoginReqVO.java @@ -8,18 +8,18 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotEmpty; -@Schema(title = "用户 APP - 微信小程序手机登录 Request VO") +@Schema(description = "用户 APP - 微信小程序手机登录 Request VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AppAuthWeixinMiniAppLoginReqVO { - @Schema(title = "手机 code", required = true, example = "hello", description = "小程序通过 wx.getPhoneNumber 方法获得") + @Schema(description = "手机 code,小程序通过 wx.getPhoneNumber 方法获得", required = true, example = "hello") @NotEmpty(message = "手机 code 不能为空") private String phoneCode; - @Schema(title = "登录 code", required = true, example = "word", description = "小程序通过 wx.login 方法获得") + @Schema(description = "登录 code,小程序通过 wx.login 方法获得", required = true, example = "word") @NotEmpty(message = "登录 code 不能为空") private String loginCode; diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/social/vo/AppSocialUserBindReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/social/vo/AppSocialUserBindReqVO.java index d1fde4e56..bd57ae155 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/social/vo/AppSocialUserBindReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/social/vo/AppSocialUserBindReqVO.java @@ -11,23 +11,23 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; -@Schema(title = "用户 APP - 社交绑定 Request VO，使用 code 授权码") +@Schema(description = "用户 APP - 社交绑定 Request VO，使用 code 授权码") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AppSocialUserBindReqVO { - @Schema(title = "社交平台的类型", required = true, example = "10", description = "参见 SysUserSocialTypeEnum 枚举值") + @Schema(description = "社交平台的类型,参见 SysUserSocialTypeEnum 枚举值", required = true, example = "10") @InEnum(SocialTypeEnum.class) @NotNull(message = "社交平台的类型不能为空") private Integer type; - @Schema(title = "授权码", required = true, example = "1024") + @Schema(description = "授权码", required = true, example = "1024") @NotEmpty(message = "授权码不能为空") private String code; - @Schema(title = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") + @Schema(description = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") @NotEmpty(message = "state 不能为空") private String state; diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/social/vo/AppSocialUserUnbindReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/social/vo/AppSocialUserUnbindReqVO.java index 5783983fe..7182643e6 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/social/vo/AppSocialUserUnbindReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/social/vo/AppSocialUserUnbindReqVO.java @@ -11,19 +11,19 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; -@Schema(title = "用户 APP - 取消社交绑定 Request VO") +@Schema(description = "用户 APP - 取消社交绑定 Request VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AppSocialUserUnbindReqVO { - @Schema(title = "社交平台的类型", required = true, example = "10", description = "参见 SysUserSocialTypeEnum 枚举值") + @Schema(description = "社交平台的类型,参见 SysUserSocialTypeEnum 枚举值", required = true, example = "10") @InEnum(SocialTypeEnum.class) @NotNull(message = "社交平台的类型不能为空") private Integer type; - @Schema(title = "社交用户的 openid", required = true, example = "IPRmJ0wvBptiPIlGEZiPewGwiEiE") + @Schema(description = "社交用户的 openid", required = true, example = "IPRmJ0wvBptiPIlGEZiPewGwiEiE") @NotEmpty(message = "社交用户的 openid 不能为空") private String openid; diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/user/vo/AppUserInfoRespVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/user/vo/AppUserInfoRespVO.java index 7b09af358..ef0c3193b 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/user/vo/AppUserInfoRespVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/user/vo/AppUserInfoRespVO.java @@ -5,18 +5,18 @@ import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; -@Schema(title = "用户 APP - 用户个人信息 Response VO") +@Schema(description = "用户 APP - 用户个人信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor public class AppUserInfoRespVO { - @Schema(title = "用户昵称", required = true, example = "芋艿") + @Schema(description = "用户昵称", required = true, example = "芋艿") private String nickname; - @Schema(title = "用户头像", required = true, example = "/infra/file/get/35a12e57-4297-4faa-bf7d-7ed2f211c952") + @Schema(description = "用户头像", required = true, example = "/infra/file/get/35a12e57-4297-4faa-bf7d-7ed2f211c952") private String avatar; - @Schema(title = "用户手机号", required = true, example = "15601691300") + @Schema(description = "用户手机号", required = true, example = "15601691300") private String mobile; } diff --git a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/user/vo/AppUserUpdateMobileReqVO.java b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/user/vo/AppUserUpdateMobileReqVO.java index e3c9021b1..d6edf48b9 100644 --- a/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/user/vo/AppUserUpdateMobileReqVO.java +++ b/yudao-module-member/yudao-module-member-biz/src/main/java/cn/iocoder/yudao/module/member/controller/app/user/vo/AppUserUpdateMobileReqVO.java @@ -12,26 +12,26 @@ import javax.validation.constraints.NotBlank; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.Pattern; -@Schema(title = "用户 APP - 修改手机 Request VO") +@Schema(description = "用户 APP - 修改手机 Request VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AppUserUpdateMobileReqVO { - @Schema(title = "手机验证码", required = true, example = "1024") + @Schema(description = "手机验证码", required = true, example = "1024") @NotEmpty(message = "手机验证码不能为空") @Length(min = 4, max = 6, message = "手机验证码长度为 4-6 位") @Pattern(regexp = "^[0-9]+$", message = "手机验证码必须都是数字") private String code; - @Schema(title = "手机号",required = true,example = "15823654487") + @Schema(description = "手机号",required = true,example = "15823654487") @NotBlank(message = "手机号不能为空") @Length(min = 8, max = 11, message = "手机号码长度为 8-11 位") @Mobile private String mobile; - @Schema(title = "原手机验证码", required = true, example = "1024") + @Schema(description = "原手机验证码", required = true, example = "1024") @NotEmpty(message = "原手机验证码不能为空") @Length(min = 4, max = 6, message = "手机验证码长度为 4-6 位") @Pattern(regexp = "^[0-9]+$", message = "手机验证码必须都是数字") @@ -39,7 +39,7 @@ public class AppUserUpdateMobileReqVO { // TODO @芋艿：oldMobile 应该不用传递 - @Schema(title = "原手机号",required = true,example = "15823654487") + @Schema(description = "原手机号",required = true,example = "15823654487") @NotBlank(message = "手机号不能为空") @Length(min = 8, max = 11, message = "手机号码长度为 8-11 位") @Mobile diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppBaseVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppBaseVO.java index 5ddbce516..54e62320d 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppBaseVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppBaseVO.java @@ -10,26 +10,26 @@ import javax.validation.constraints.*; @Data public class PayAppBaseVO { - @Schema(title = "应用名", required = true) + @Schema(description = "应用名", required = true) @NotNull(message = "应用名不能为空") private String name; - @Schema(title = "开启状态", required = true) + @Schema(description = "开启状态", required = true) @NotNull(message = "开启状态不能为空") private Integer status; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; - @Schema(title = "支付结果的回调地址", required = true) + @Schema(description = "支付结果的回调地址", required = true) @NotNull(message = "支付结果的回调地址不能为空") private String payNotifyUrl; - @Schema(title = "退款结果的回调地址", required = true) + @Schema(description = "退款结果的回调地址", required = true) @NotNull(message = "退款结果的回调地址不能为空") private String refundNotifyUrl; - @Schema(title = "商户编号", required = true) + @Schema(description = "商户编号", required = true) @NotNull(message = "商户编号不能为空") private Long merchantId; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppCreateReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppCreateReqVO.java index 4c1086390..36816cc24 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppCreateReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppCreateReqVO.java @@ -2,7 +2,7 @@ package cn.iocoder.yudao.module.pay.controller.admin.merchant.vo.app; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@Schema(title = "管理后台 - 支付应用信息创建 Request VO") +@Schema(description = "管理后台 - 支付应用信息创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppExportReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppExportReqVO.java index f4cc07f40..b13a6e65b 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppExportReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppExportReqVO.java @@ -7,30 +7,30 @@ import org.springframework.format.annotation.DateTimeFormat; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 支付应用信息 Excel 导出 Request VO", description = "参数和 PayAppPageReqVO 是一致的") +@Schema(description = "管理后台 - 支付应用信息 Excel 导出 Request VO,参数和 PayAppPageReqVO 是一致的") @Data public class PayAppExportReqVO { - @Schema(title = "应用名") + @Schema(description = "应用名") private String name; - @Schema(title = "开启状态") + @Schema(description = "开启状态") private Integer status; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; - @Schema(title = "支付结果的回调地址") + @Schema(description = "支付结果的回调地址") private String payNotifyUrl; - @Schema(title = "退款结果的回调地址") + @Schema(description = "退款结果的回调地址") private String refundNotifyUrl; - @Schema(title = "商户名称") + @Schema(description = "商户名称") private String merchantName; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppPageItemRespVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppPageItemRespVO.java index 214d87ee8..72655db05 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppPageItemRespVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppPageItemRespVO.java @@ -8,16 +8,16 @@ import lombok.ToString; import java.time.LocalDateTime; import java.util.Set; -@Schema(title = "管理后台 - 支付应用信息分页查询 Response VO", description = "相比于支付信息，还会多出应用渠道的开关信息") +@Schema(description = "管理后台 - 支付应用信息分页查询 Response VO,相比于支付信息，还会多出应用渠道的开关信息") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayAppPageItemRespVO extends PayAppBaseVO { - @Schema(title = "应用编号", required = true) + @Schema(description = "应用编号", required = true) private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; /** @@ -25,19 +25,19 @@ public class PayAppPageItemRespVO extends PayAppBaseVO { */ private PayMerchant payMerchant; - @Schema(title = "商户") + @Schema(description = "商户") @Data public static class PayMerchant { - @Schema(title = "商户编号", required = true, example = "1") + @Schema(description = "商户编号", required = true, example = "1") private Long id; - @Schema(title = "商户名称", required = true, example = "研发部") + @Schema(description = "商户名称", required = true, example = "研发部") private String name; } - @Schema(title = "渠道编码集合", required = true, example = "alipay_pc,alipay_wap...") + @Schema(description = "渠道编码集合", required = true, example = "alipay_pc,alipay_wap...") private Set channelCodes; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppPageReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppPageReqVO.java index 04312cb1b..1aaadc78a 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppPageReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppPageReqVO.java @@ -8,32 +8,32 @@ import org.springframework.format.annotation.DateTimeFormat; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 支付应用信息分页 Request VO") +@Schema(description = "管理后台 - 支付应用信息分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayAppPageReqVO extends PageParam { - @Schema(title = "应用名") + @Schema(description = "应用名") private String name; - @Schema(title = "开启状态") + @Schema(description = "开启状态") private Integer status; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; - @Schema(title = "支付结果的回调地址") + @Schema(description = "支付结果的回调地址") private String payNotifyUrl; - @Schema(title = "退款结果的回调地址") + @Schema(description = "退款结果的回调地址") private String refundNotifyUrl; - @Schema(title = "商户名称") + @Schema(description = "商户名称") private String merchantName; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppRespVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppRespVO.java index c5fc4fb77..0bb0c5563 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppRespVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppRespVO.java @@ -4,16 +4,16 @@ import lombok.*; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 支付应用信息 Response VO") +@Schema(description = "管理后台 - 支付应用信息 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayAppRespVO extends PayAppBaseVO { - @Schema(title = "应用编号", required = true) + @Schema(description = "应用编号", required = true) private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppUpdateReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppUpdateReqVO.java index e55e86efb..2d940d5c2 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppUpdateReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppUpdateReqVO.java @@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 支付应用信息更新 Request VO") +@Schema(description = "管理后台 - 支付应用信息更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayAppUpdateReqVO extends PayAppBaseVO { - @Schema(title = "应用编号", required = true) + @Schema(description = "应用编号", required = true) @NotNull(message = "应用编号不能为空") private Long id; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppUpdateStatusReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppUpdateStatusReqVO.java index c5d257829..8454f5f2a 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppUpdateStatusReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/app/PayAppUpdateStatusReqVO.java @@ -5,15 +5,15 @@ import lombok.Data; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 应用更新状态 Request VO") +@Schema(description = "管理后台 - 应用更新状态 Request VO") @Data public class PayAppUpdateStatusReqVO { - @Schema(title = "商户编号", required = true, example = "1024") + @Schema(description = "商户编号", required = true, example = "1024") @NotNull(message = "商户编号不能为空") private Long id; - @Schema(title = "状态", required = true, example = "1", description = "见 SysCommonStatusEnum 枚举") + @Schema(description = "状态,见 SysCommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelBaseVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelBaseVO.java index 3ff9f69b9..a8f0c1ec9 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelBaseVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelBaseVO.java @@ -10,26 +10,26 @@ import javax.validation.constraints.*; @Data public class PayChannelBaseVO { - @Schema(title = "渠道编码", required = true) + @Schema(description = "渠道编码", required = true) @NotNull(message = "渠道编码不能为空") private String code; - @Schema(title = "开启状态", required = true) + @Schema(description = "开启状态", required = true) @NotNull(message = "开启状态不能为空") private Integer status; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; - @Schema(title = "渠道费率，单位：百分比", required = true) + @Schema(description = "渠道费率，单位：百分比", required = true) @NotNull(message = "渠道费率，单位：百分比不能为空") private Double feeRate; - @Schema(title = "商户编号", required = true) + @Schema(description = "商户编号", required = true) @NotNull(message = "商户编号不能为空") private Long merchantId; - @Schema(title = "应用编号", required = true) + @Schema(description = "应用编号", required = true) @NotNull(message = "应用编号不能为空") private Long appId; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelCreateReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelCreateReqVO.java index f2bda63fa..89547bc1e 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelCreateReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelCreateReqVO.java @@ -7,13 +7,13 @@ import lombok.ToString; import javax.validation.constraints.NotBlank; -@Schema(title = "管理后台 - 支付渠道 创建 Request VO") +@Schema(description = "管理后台 - 支付渠道 创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayChannelCreateReqVO extends PayChannelBaseVO { - @Schema(title = "渠道配置的 json 字符串") + @Schema(description = "渠道配置的 json 字符串") @NotBlank(message = "渠道配置不能为空") private String config; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelExportReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelExportReqVO.java index 091afc14e..3a7e16fb5 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelExportReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelExportReqVO.java @@ -7,33 +7,33 @@ import org.springframework.format.annotation.DateTimeFormat; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 支付渠道 Excel 导出 Request VO", description = "参数和 PayChannelPageReqVO 是一致的") +@Schema(description = "管理后台 - 支付渠道 Excel 导出 Request VO,参数和 PayChannelPageReqVO 是一致的") @Data public class PayChannelExportReqVO { - @Schema(title = "渠道编码") + @Schema(description = "渠道编码") private String code; - @Schema(title = "开启状态") + @Schema(description = "开启状态") private Integer status; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; - @Schema(title = "渠道费率，单位：百分比") + @Schema(description = "渠道费率，单位：百分比") private Double feeRate; - @Schema(title = "商户编号") + @Schema(description = "商户编号") private Long merchantId; - @Schema(title = "应用编号") + @Schema(description = "应用编号") private Long appId; - @Schema(title = "支付渠道配置") + @Schema(description = "支付渠道配置") private String config; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelPageReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelPageReqVO.java index dd30097c5..00c724893 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelPageReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelPageReqVO.java @@ -8,35 +8,35 @@ import org.springframework.format.annotation.DateTimeFormat; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 支付渠道 分页 Request VO") +@Schema(description = "管理后台 - 支付渠道 分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayChannelPageReqVO extends PageParam { - @Schema(title = "渠道编码") + @Schema(description = "渠道编码") private String code; - @Schema(title = "开启状态") + @Schema(description = "开启状态") private Integer status; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; - @Schema(title = "渠道费率，单位：百分比") + @Schema(description = "渠道费率，单位：百分比") private Double feeRate; - @Schema(title = "商户编号") + @Schema(description = "商户编号") private Long merchantId; - @Schema(title = "应用编号") + @Schema(description = "应用编号") private Long appId; - @Schema(title = "支付渠道配置") + @Schema(description = "支付渠道配置") private String config; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelRespVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelRespVO.java index 92c8f5714..5fa189e18 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelRespVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelRespVO.java @@ -4,18 +4,18 @@ import lombok.*; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 支付渠道 Response VO") +@Schema(description = "管理后台 - 支付渠道 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayChannelRespVO extends PayChannelBaseVO { - @Schema(title = "商户编号", required = true) + @Schema(description = "商户编号", required = true) private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; - @Schema(title = "配置", required = true) + @Schema(description = "配置", required = true) private String config; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelUpdateReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelUpdateReqVO.java index 94c322270..959c069b4 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelUpdateReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/channel/PayChannelUpdateReqVO.java @@ -3,17 +3,17 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 支付渠道 更新 Request VO") +@Schema(description = "管理后台 - 支付渠道 更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayChannelUpdateReqVO extends PayChannelBaseVO { - @Schema(title = "商户编号", required = true) + @Schema(description = "商户编号", required = true) @NotNull(message = "商户编号不能为空") private Long id; - @Schema(title = "渠道配置的json字符串") + @Schema(description = "渠道配置的json字符串") @NotBlank(message = "渠道配置不能为空") private String config; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantBaseVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantBaseVO.java index 71f8d0e61..dd8b3eddc 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantBaseVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantBaseVO.java @@ -11,19 +11,19 @@ import javax.validation.constraints.NotNull; @Data public class PayMerchantBaseVO { - @Schema(title = "商户全称", required = true) + @Schema(description = "商户全称", required = true) @NotNull(message = "商户全称不能为空") private String name; - @Schema(title = "商户简称", required = true) + @Schema(description = "商户简称", required = true) @NotNull(message = "商户简称不能为空") private String shortName; - @Schema(title = "开启状态", required = true) + @Schema(description = "开启状态", required = true) @NotNull(message = "开启状态不能为空") private Integer status; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantCreateReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantCreateReqVO.java index a61f728ab..f63aa123f 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantCreateReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantCreateReqVO.java @@ -2,7 +2,7 @@ package cn.iocoder.yudao.module.pay.controller.admin.merchant.vo.merchant; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@Schema(title = "管理后台 - 支付商户信息创建 Request VO") +@Schema(description = "管理后台 - 支付商户信息创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantExportReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantExportReqVO.java index 1a04a077d..4903531c9 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantExportReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantExportReqVO.java @@ -7,27 +7,27 @@ import org.springframework.format.annotation.DateTimeFormat; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 支付商户信息 Excel 导出 Request VO", description = "参数和 PayMerchantPageReqVO 是一致的") +@Schema(description = "管理后台 - 支付商户信息 Excel 导出 Request VO,参数和 PayMerchantPageReqVO 是一致的") @Data public class PayMerchantExportReqVO { - @Schema(title = "商户号") + @Schema(description = "商户号") private String no; - @Schema(title = "商户全称") + @Schema(description = "商户全称") private String name; - @Schema(title = "商户简称") + @Schema(description = "商户简称") private String shortName; - @Schema(title = "开启状态") + @Schema(description = "开启状态") private Integer status; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantPageReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantPageReqVO.java index ec01270a5..0dccc4dab 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantPageReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantPageReqVO.java @@ -8,29 +8,29 @@ import org.springframework.format.annotation.DateTimeFormat; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 支付商户信息分页 Request VO") +@Schema(description = "管理后台 - 支付商户信息分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayMerchantPageReqVO extends PageParam { - @Schema(title = "商户号") + @Schema(description = "商户号") private String no; - @Schema(title = "商户全称") + @Schema(description = "商户全称") private String name; - @Schema(title = "商户简称") + @Schema(description = "商户简称") private String shortName; - @Schema(title = "开启状态") + @Schema(description = "开启状态") private Integer status; - @Schema(title = "备注") + @Schema(description = "备注") private String remark; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantRespVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantRespVO.java index 54561c116..3e150f71c 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantRespVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantRespVO.java @@ -7,19 +7,19 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 支付商户信息 Response VO") +@Schema(description = "管理后台 - 支付商户信息 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayMerchantRespVO extends PayMerchantBaseVO { - @Schema(title = "商户编号", required = true) + @Schema(description = "商户编号", required = true) private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; - @Schema(title = "商户号", required = true, example = "M233666999") + @Schema(description = "商户号", required = true, example = "M233666999") private String no; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantUpdateReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantUpdateReqVO.java index f6c509764..2fd70e2d9 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantUpdateReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantUpdateReqVO.java @@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 支付商户信息更新 Request VO") +@Schema(description = "管理后台 - 支付商户信息更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayMerchantUpdateReqVO extends PayMerchantBaseVO { - @Schema(title = "商户编号", required = true) + @Schema(description = "商户编号", required = true) @NotNull(message = "商户编号不能为空") private Long id; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantUpdateStatusReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantUpdateStatusReqVO.java index 6fa637e7e..b42cd61f3 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantUpdateStatusReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/merchant/vo/merchant/PayMerchantUpdateStatusReqVO.java @@ -5,15 +5,15 @@ import lombok.Data; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 商户更新状态 Request VO") +@Schema(description = "管理后台 - 商户更新状态 Request VO") @Data public class PayMerchantUpdateStatusReqVO { - @Schema(title = "商户编号", required = true, example = "1024") + @Schema(description = "商户编号", required = true, example = "1024") @NotNull(message = "商户编号不能为空") private Long id; - @Schema(title = "状态", required = true, example = "1", description = "见 SysCommonStatusEnum 枚举") + @Schema(description = "状态,见 SysCommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderBaseVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderBaseVO.java index ebf07630f..7991c7c7e 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderBaseVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderBaseVO.java @@ -17,90 +17,90 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @Data public class PayOrderBaseVO { - @Schema(title = "商户编号", required = true) + @Schema(description = "商户编号", required = true) @NotNull(message = "商户编号不能为空") private Long merchantId; - @Schema(title = "应用编号", required = true) + @Schema(description = "应用编号", required = true) @NotNull(message = "应用编号不能为空") private Long appId; - @Schema(title = "渠道编号") + @Schema(description = "渠道编号") private Long channelId; - @Schema(title = "渠道编码") + @Schema(description = "渠道编码") private String channelCode; - @Schema(title = "商户订单编号", required = true) + @Schema(description = "商户订单编号", required = true) @NotNull(message = "商户订单编号不能为空") private String merchantOrderId; - @Schema(title = "商品标题", required = true) + @Schema(description = "商品标题", required = true) @NotNull(message = "商品标题不能为空") private String subject; - @Schema(title = "商品描述", required = true) + @Schema(description = "商品描述", required = true) @NotNull(message = "商品描述不能为空") private String body; - @Schema(title = "异步通知地址", required = true) + @Schema(description = "异步通知地址", required = true) @NotNull(message = "异步通知地址不能为空") private String notifyUrl; - @Schema(title = "通知商户支付结果的回调状态", required = true) + @Schema(description = "通知商户支付结果的回调状态", required = true) @NotNull(message = "通知商户支付结果的回调状态不能为空") private Integer notifyStatus; - @Schema(title = "支付金额，单位：分", required = true) + @Schema(description = "支付金额，单位：分", required = true) @NotNull(message = "支付金额，单位：分不能为空") private Long amount; - @Schema(title = "渠道手续费，单位：百分比") + @Schema(description = "渠道手续费，单位：百分比") private Double channelFeeRate; - @Schema(title = "渠道手续金额，单位：分") + @Schema(description = "渠道手续金额，单位：分") private Long channelFeeAmount; - @Schema(title = "支付状态", required = true) + @Schema(description = "支付状态", required = true) @NotNull(message = "支付状态不能为空") private Integer status; - @Schema(title = "用户 IP", required = true) + @Schema(description = "用户 IP", required = true) @NotNull(message = "用户 IP不能为空") private String userIp; - @Schema(title = "订单失效时间", required = true) + @Schema(description = "订单失效时间", required = true) @NotNull(message = "订单失效时间不能为空") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime expireTime; - @Schema(title = "订单支付成功时间") + @Schema(description = "订单支付成功时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime successTime; - @Schema(title = "订单支付通知时间") + @Schema(description = "订单支付通知时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime notifyTime; - @Schema(title = "支付成功的订单拓展单编号") + @Schema(description = "支付成功的订单拓展单编号") private Long successExtensionId; - @Schema(title = "退款状态", required = true) + @Schema(description = "退款状态", required = true) @NotNull(message = "退款状态不能为空") private Integer refundStatus; - @Schema(title = "退款次数", required = true) + @Schema(description = "退款次数", required = true) @NotNull(message = "退款次数不能为空") private Integer refundTimes; - @Schema(title = "退款总金额，单位：分", required = true) + @Schema(description = "退款总金额，单位：分", required = true) @NotNull(message = "退款总金额，单位：分不能为空") private Long refundAmount; - @Schema(title = "渠道用户编号") + @Schema(description = "渠道用户编号") private String channelUserId; - @Schema(title = "渠道订单号") + @Schema(description = "渠道订单号") private String channelOrderNo; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderDetailsRespVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderDetailsRespVO.java index 25ec3c9dc..6a1d2c8f6 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderDetailsRespVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderDetailsRespVO.java @@ -7,25 +7,25 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 支付订单详细信息 Response VO") +@Schema(description = "管理后台 - 支付订单详细信息 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayOrderDetailsRespVO extends PayOrderBaseVO { - @Schema(title = "支付订单编号") + @Schema(description = "支付订单编号") private Long id; - @Schema(title = "商户名称") + @Schema(description = "商户名称") private String merchantName; - @Schema(title = "应用名称") + @Schema(description = "应用名称") private String appName; - @Schema(title = "渠道编号名称") + @Schema(description = "渠道编号名称") private String channelCodeName; - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime createTime; /** @@ -34,13 +34,13 @@ public class PayOrderDetailsRespVO extends PayOrderBaseVO { private PayOrderExtension payOrderExtension; @Data - @Schema(title = "支付订单扩展") + @Schema(description = "支付订单扩展") public static class PayOrderExtension { - @Schema(title = "支付订单号") + @Schema(description = "支付订单号") private String no; - @Schema(title = "支付异步通知的内容") + @Schema(description = "支付异步通知的内容") private String channelNotifyData; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderExportReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderExportReqVO.java index cb08e04d4..a5783806c 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderExportReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderExportReqVO.java @@ -8,84 +8,84 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 支付订单 Excel 导出 Request VO", description = "参数和 PayOrderPageReqVO 是一致的") +@Schema(description = "管理后台 - 支付订单 Excel 导出 Request VO，参数和 PayOrderPageReqVO 是一致的") @Data public class PayOrderExportReqVO { - @Schema(title = "商户编号") + @Schema(description = "商户编号") private Long merchantId; - @Schema(title = "应用编号") + @Schema(description = "应用编号") private Long appId; - @Schema(title = "渠道编号") + @Schema(description = "渠道编号") private Long channelId; - @Schema(title = "渠道编码") + @Schema(description = "渠道编码") private String channelCode; - @Schema(title = "商户订单编号") + @Schema(description = "商户订单编号") private String merchantOrderId; - @Schema(title = "商品标题") + @Schema(description = "商品标题") private String subject; - @Schema(title = "商品描述") + @Schema(description = "商品描述") private String body; - @Schema(title = "异步通知地址") + @Schema(description = "异步通知地址") private String notifyUrl; - @Schema(title = "通知商户支付结果的回调状态") + @Schema(description = "通知商户支付结果的回调状态") private Integer notifyStatus; - @Schema(title = "支付金额，单位：分") + @Schema(description = "支付金额，单位：分") private Long amount; - @Schema(title = "渠道手续费，单位：百分比") + @Schema(description = "渠道手续费，单位：百分比") private Double channelFeeRate; - @Schema(title = "渠道手续金额，单位：分") + @Schema(description = "渠道手续金额，单位：分") private Long channelFeeAmount; - @Schema(title = "支付状态") + @Schema(description = "支付状态") private Integer status; - @Schema(title = "用户 IP") + @Schema(description = "用户 IP") private String userIp; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "订单失效时间") + @Schema(description = "订单失效时间") private LocalDateTime[] expireTime; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "开始订单支付成功时间") + @Schema(description = "开始订单支付成功时间") private LocalDateTime[] successTime; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "开始订单支付通知时间") + @Schema(description = "开始订单支付通知时间") private LocalDateTime[] notifyTime; - @Schema(title = "支付成功的订单拓展单编号") + @Schema(description = "支付成功的订单拓展单编号") private Long successExtensionId; - @Schema(title = "退款状态") + @Schema(description = "退款状态") private Integer refundStatus; - @Schema(title = "退款次数") + @Schema(description = "退款次数") private Integer refundTimes; - @Schema(title = "退款总金额，单位：分") + @Schema(description = "退款总金额，单位：分") private Long refundAmount; - @Schema(title = "渠道用户编号") + @Schema(description = "渠道用户编号") private String channelUserId; - @Schema(title = "渠道订单号") + @Schema(description = "渠道订单号") private String channelOrderNo; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderPageItemRespVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderPageItemRespVO.java index 795d2f804..8ca5f2162 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderPageItemRespVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderPageItemRespVO.java @@ -7,28 +7,28 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 支付订单分页 Request VO") +@Schema(description = "管理后台 - 支付订单分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayOrderPageItemRespVO extends PayOrderBaseVO { - @Schema(title = "支付订单编号", required = true) + @Schema(description = "支付订单编号", required = true) private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; - @Schema(title = "商户名称") + @Schema(description = "商户名称") private String merchantName; - @Schema(title = "应用名称") + @Schema(description = "应用名称") private String appName; - @Schema(title = "渠道名称") + @Schema(description = "渠道名称") private String channelCodeName; - @Schema(title = "支付订单号") + @Schema(description = "支付订单号") private String no; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderPageReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderPageReqVO.java index 61d0ab250..2ca72f9fc 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderPageReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderPageReqVO.java @@ -11,86 +11,86 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 支付订单分页 Request VO") +@Schema(description = "管理后台 - 支付订单分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayOrderPageReqVO extends PageParam { - @Schema(title = "商户编号") + @Schema(description = "商户编号") private Long merchantId; - @Schema(title = "应用编号") + @Schema(description = "应用编号") private Long appId; - @Schema(title = "渠道编号") + @Schema(description = "渠道编号") private Long channelId; - @Schema(title = "渠道编码") + @Schema(description = "渠道编码") private String channelCode; - @Schema(title = "商户订单编号") + @Schema(description = "商户订单编号") private String merchantOrderId; - @Schema(title = "商品标题") + @Schema(description = "商品标题") private String subject; - @Schema(title = "商品描述") + @Schema(description = "商品描述") private String body; - @Schema(title = "异步通知地址") + @Schema(description = "异步通知地址") private String notifyUrl; - @Schema(title = "通知商户支付结果的回调状态") + @Schema(description = "通知商户支付结果的回调状态") private Integer notifyStatus; - @Schema(title = "支付金额，单位：分") + @Schema(description = "支付金额，单位：分") private Long amount; - @Schema(title = "渠道手续费，单位：百分比") + @Schema(description = "渠道手续费，单位：百分比") private Double channelFeeRate; - @Schema(title = "渠道手续金额，单位：分") + @Schema(description = "渠道手续金额，单位：分") private Long channelFeeAmount; - @Schema(title = "支付状态") + @Schema(description = "支付状态") private Integer status; - @Schema(title = "用户 IP") + @Schema(description = "用户 IP") private String userIp; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "订单失效时间") + @Schema(description = "订单失效时间") private LocalDateTime[] expireTime; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "订单支付成功时间") + @Schema(description = "订单支付成功时间") private LocalDateTime[] successTime; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "订单支付通知时间") + @Schema(description = "订单支付通知时间") private LocalDateTime[] notifyTime; - @Schema(title = "支付成功的订单拓展单编号") + @Schema(description = "支付成功的订单拓展单编号") private Long successExtensionId; - @Schema(title = "退款状态") + @Schema(description = "退款状态") private Integer refundStatus; - @Schema(title = "退款次数") + @Schema(description = "退款次数") private Integer refundTimes; - @Schema(title = "退款总金额，单位：分") + @Schema(description = "退款总金额，单位：分") private Long refundAmount; - @Schema(title = "渠道用户编号") + @Schema(description = "渠道用户编号") private String channelUserId; - @Schema(title = "渠道订单号") + @Schema(description = "渠道订单号") private String channelOrderNo; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderRespVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderRespVO.java index 09c71e055..57794982d 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderRespVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/order/vo/PayOrderRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 支付订单 Response VO") +@Schema(description = "管理后台 - 支付订单 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayOrderRespVO extends PayOrderBaseVO { - @Schema(title = "支付订单编号", required = true) + @Schema(description = "支付订单编号", required = true) private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundBaseVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundBaseVO.java index 5df3ffa06..54ac525d5 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundBaseVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundBaseVO.java @@ -15,94 +15,94 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_ @Data public class PayRefundBaseVO { - @Schema(title = "商户编号", required = true) + @Schema(description = "商户编号", required = true) @NotNull(message = "商户编号不能为空") private Long merchantId; - @Schema(title = "应用编号", required = true) + @Schema(description = "应用编号", required = true) @NotNull(message = "应用编号不能为空") private Long appId; - @Schema(title = "渠道编号", required = true) + @Schema(description = "渠道编号", required = true) @NotNull(message = "渠道编号不能为空") private Long channelId; - @Schema(title = "渠道编码", required = true) + @Schema(description = "渠道编码", required = true) @NotNull(message = "渠道编码不能为空") private String channelCode; - @Schema(title = "支付订单编号 pay_order 表id", required = true) + @Schema(description = "支付订单编号 pay_order 表id", required = true) @NotNull(message = "支付订单编号 pay_order 表id不能为空") private Long orderId; - @Schema(title = "交易订单号 pay_extension 表no 字段", required = true) + @Schema(description = "交易订单号 pay_extension 表no 字段", required = true) @NotNull(message = "交易订单号 pay_extension 表no 字段不能为空") private String tradeNo; - @Schema(title = "商户订单编号（商户系统生成）", required = true) + @Schema(description = "商户订单编号（商户系统生成）", required = true) @NotNull(message = "商户订单编号（商户系统生成）不能为空") private String merchantOrderId; - @Schema(title = "商户退款订单号（商户系统生成）", required = true) + @Schema(description = "商户退款订单号（商户系统生成）", required = true) @NotNull(message = "商户退款订单号（商户系统生成）不能为空") private String merchantRefundNo; - @Schema(title = "异步通知商户地址", required = true) + @Schema(description = "异步通知商户地址", required = true) @NotNull(message = "异步通知商户地址不能为空") private String notifyUrl; - @Schema(title = "通知商户退款结果的回调状态", required = true) + @Schema(description = "通知商户退款结果的回调状态", required = true) @NotNull(message = "通知商户退款结果的回调状态不能为空") private Integer notifyStatus; - @Schema(title = "退款状态", required = true) + @Schema(description = "退款状态", required = true) @NotNull(message = "退款状态不能为空") private Integer status; - @Schema(title = "退款类型(部分退款，全部退款)", required = true) + @Schema(description = "退款类型(部分退款，全部退款)", required = true) @NotNull(message = "退款类型(部分退款，全部退款)不能为空") private Integer type; - @Schema(title = "支付金额,单位分", required = true) + @Schema(description = "支付金额,单位分", required = true) @NotNull(message = "支付金额,单位分不能为空") private Long payAmount; - @Schema(title = "退款金额,单位分", required = true) + @Schema(description = "退款金额,单位分", required = true) @NotNull(message = "退款金额,单位分不能为空") private Long refundAmount; - @Schema(title = "退款原因", required = true) + @Schema(description = "退款原因", required = true) @NotNull(message = "退款原因不能为空") private String reason; - @Schema(title = "用户 IP") + @Schema(description = "用户 IP") private String userIp; - @Schema(title = "渠道订单号，pay_order 中的channel_order_no 对应", required = true) + @Schema(description = "渠道订单号，pay_order 中的channel_order_no 对应", required = true) @NotNull(message = "渠道订单号，pay_order 中的channel_order_no 对应不能为空") private String channelOrderNo; - @Schema(title = "渠道退款单号，渠道返回") + @Schema(description = "渠道退款单号，渠道返回") private String channelRefundNo; - @Schema(title = "渠道调用报错时，错误码") + @Schema(description = "渠道调用报错时，错误码") private String channelErrorCode; - @Schema(title = "渠道调用报错时，错误信息") + @Schema(description = "渠道调用报错时，错误信息") private String channelErrorMsg; - @Schema(title = "支付渠道的额外参数") + @Schema(description = "支付渠道的额外参数") private String channelExtras; - @Schema(title = "退款失效时间") + @Schema(description = "退款失效时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime expireTime; - @Schema(title = "退款成功时间") + @Schema(description = "退款成功时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime successTime; - @Schema(title = "退款通知时间") + @Schema(description = "退款通知时间") @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) private LocalDateTime notifyTime; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundCreateReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundCreateReqVO.java index 7f100464e..86cf94636 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundCreateReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundCreateReqVO.java @@ -2,7 +2,7 @@ package cn.iocoder.yudao.module.pay.controller.admin.refund.vo; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@Schema(title = "管理后台 - 退款订单创建 Request VO") +@Schema(description = "管理后台 - 退款订单创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundDetailsRespVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundDetailsRespVO.java index 9ad9fbd20..a02099946 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundDetailsRespVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundDetailsRespVO.java @@ -8,31 +8,31 @@ import lombok.ToString; import javax.validation.constraints.NotNull; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 退款订单详情 Response VO") +@Schema(description = "管理后台 - 退款订单详情 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayRefundDetailsRespVO extends PayRefundBaseVO { - @Schema(title = "支付退款编号", required = true) + @Schema(description = "支付退款编号", required = true) private Long id; - @Schema(title = "商户名称") + @Schema(description = "商户名称") private String merchantName; - @Schema(title = "应用名称") + @Schema(description = "应用名称") private String appName; - @Schema(title = "渠道编号名称") + @Schema(description = "渠道编号名称") private String channelCodeName; @NotNull(message = "商品标题不能为空") private String subject; - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime createTime; - @Schema(title = "更新时间") + @Schema(description = "更新时间") private LocalDateTime updateTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundExportReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundExportReqVO.java index bb1a25f91..bc7d7946b 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundExportReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundExportReqVO.java @@ -8,87 +8,87 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 退款订单 Excel 导出 Request VO", description = "参数和 PayRefundPageReqVO 是一致的") +@Schema(description = "管理后台 - 退款订单 Excel 导出 Request VO，参数和 PayRefundPageReqVO 是一致的") @Data public class PayRefundExportReqVO { - @Schema(title = "商户编号") + @Schema(description = "商户编号") private Long merchantId; - @Schema(title = "应用编号") + @Schema(description = "应用编号") private Long appId; - @Schema(title = "渠道编号") + @Schema(description = "渠道编号") private Long channelId; - @Schema(title = "渠道编码") + @Schema(description = "渠道编码") private String channelCode; - @Schema(title = "支付订单编号 pay_order 表id") + @Schema(description = "支付订单编号 pay_order 表id") private Long orderId; - @Schema(title = "交易订单号 pay_extension 表no 字段") + @Schema(description = "交易订单号 pay_extension 表no 字段") private String tradeNo; - @Schema(title = "商户订单编号（商户系统生成）") + @Schema(description = "商户订单编号（商户系统生成）") private String merchantOrderId; - @Schema(title = "商户退款订单号（商户系统生成）") + @Schema(description = "商户退款订单号（商户系统生成）") private String merchantRefundNo; - @Schema(title = "异步通知商户地址") + @Schema(description = "异步通知商户地址") private String notifyUrl; - @Schema(title = "通知商户退款结果的回调状态") + @Schema(description = "通知商户退款结果的回调状态") private Integer notifyStatus; - @Schema(title = "退款状态") + @Schema(description = "退款状态") private Integer status; - @Schema(title = "退款类型(部分退款，全部退款)") + @Schema(description = "退款类型(部分退款，全部退款)") private Integer type; - @Schema(title = "支付金额,单位分") + @Schema(description = "支付金额,单位分") private Long payAmount; - @Schema(title = "退款金额,单位分") + @Schema(description = "退款金额,单位分") private Long refundAmount; - @Schema(title = "退款原因") + @Schema(description = "退款原因") private String reason; - @Schema(title = "用户 IP") + @Schema(description = "用户 IP") private String userIp; - @Schema(title = "渠道订单号，pay_order 中的channel_order_no 对应") + @Schema(description = "渠道订单号，pay_order 中的channel_order_no 对应") private String channelOrderNo; - @Schema(title = "渠道退款单号，渠道返回") + @Schema(description = "渠道退款单号，渠道返回") private String channelRefundNo; - @Schema(title = "渠道调用报错时，错误码") + @Schema(description = "渠道调用报错时，错误码") private String channelErrorCode; - @Schema(title = "渠道调用报错时，错误信息") + @Schema(description = "渠道调用报错时，错误信息") private String channelErrorMsg; - @Schema(title = "支付渠道的额外参数") + @Schema(description = "支付渠道的额外参数") private String channelExtras; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "退款失效时间") + @Schema(description = "退款失效时间") private LocalDateTime[] expireTime; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "退款成功时间") + @Schema(description = "退款成功时间") private LocalDateTime[] successTime; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "退款通知时间") + @Schema(description = "退款通知时间") private LocalDateTime[] notifyTime; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundPageItemRespVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundPageItemRespVO.java index 192a11c44..df2d0aadd 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundPageItemRespVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundPageItemRespVO.java @@ -7,25 +7,25 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 退款订单分页查询 Response VO") +@Schema(description = "管理后台 - 退款订单分页查询 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayRefundPageItemRespVO extends PayRefundBaseVO { - @Schema(title = "支付订单编号", required = true) + @Schema(description = "支付订单编号", required = true) private Long id; - @Schema(title = "商户名称") + @Schema(description = "商户名称") private String merchantName; - @Schema(title = "应用名称") + @Schema(description = "应用名称") private String appName; - @Schema(title = "渠道名称") + @Schema(description = "渠道名称") private String channelCodeName; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundPageReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundPageReqVO.java index c126cfe0f..49d87f645 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundPageReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundPageReqVO.java @@ -11,89 +11,89 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 退款订单分页 Request VO") +@Schema(description = "管理后台 - 退款订单分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayRefundPageReqVO extends PageParam { - @Schema(title = "商户编号") + @Schema(description = "商户编号") private Long merchantId; - @Schema(title = "应用编号") + @Schema(description = "应用编号") private Long appId; - @Schema(title = "渠道编号") + @Schema(description = "渠道编号") private Long channelId; - @Schema(title = "渠道编码") + @Schema(description = "渠道编码") private String channelCode; - @Schema(title = "支付订单编号 pay_order 表id") + @Schema(description = "支付订单编号 pay_order 表id") private Long orderId; - @Schema(title = "交易订单号 pay_extension 表no 字段") + @Schema(description = "交易订单号 pay_extension 表no 字段") private String tradeNo; - @Schema(title = "商户订单编号（商户系统生成）") + @Schema(description = "商户订单编号（商户系统生成）") private String merchantOrderId; - @Schema(title = "商户退款订单号（商户系统生成）") + @Schema(description = "商户退款订单号（商户系统生成）") private String merchantRefundNo; - @Schema(title = "异步通知商户地址") + @Schema(description = "异步通知商户地址") private String notifyUrl; - @Schema(title = "通知商户退款结果的回调状态") + @Schema(description = "通知商户退款结果的回调状态") private Integer notifyStatus; - @Schema(title = "退款状态") + @Schema(description = "退款状态") private Integer status; - @Schema(title = "退款类型(部分退款，全部退款)") + @Schema(description = "退款类型(部分退款，全部退款)") private Integer type; - @Schema(title = "支付金额,单位分") + @Schema(description = "支付金额,单位分") private Long payAmount; - @Schema(title = "退款金额,单位分") + @Schema(description = "退款金额,单位分") private Long refundAmount; - @Schema(title = "退款原因") + @Schema(description = "退款原因") private String reason; - @Schema(title = "用户 IP") + @Schema(description = "用户 IP") private String userIp; - @Schema(title = "渠道订单号，pay_order 中的channel_order_no 对应") + @Schema(description = "渠道订单号，pay_order 中的channel_order_no 对应") private String channelOrderNo; - @Schema(title = "渠道退款单号，渠道返回") + @Schema(description = "渠道退款单号，渠道返回") private String channelRefundNo; - @Schema(title = "渠道调用报错时，错误码") + @Schema(description = "渠道调用报错时，错误码") private String channelErrorCode; - @Schema(title = "渠道调用报错时，错误信息") + @Schema(description = "渠道调用报错时，错误信息") private String channelErrorMsg; - @Schema(title = "支付渠道的额外参数") + @Schema(description = "支付渠道的额外参数") private String channelExtras; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "退款失效时间") + @Schema(description = "退款失效时间") private LocalDateTime[] expireTime; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "退款成功时间") + @Schema(description = "退款成功时间") private LocalDateTime[] successTime; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "退款通知时间") + @Schema(description = "退款通知时间") private LocalDateTime[] notifyTime; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundRespVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundRespVO.java index 6f040aafc..1374074e8 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundRespVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 退款订单 Response VO") +@Schema(description = "管理后台 - 退款订单 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayRefundRespVO extends PayRefundBaseVO { - @Schema(title = "支付退款编号", required = true) + @Schema(description = "支付退款编号", required = true) private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundUpdateReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundUpdateReqVO.java index 1cb8c7506..bb28fe2d0 100755 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundUpdateReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/admin/refund/vo/PayRefundUpdateReqVO.java @@ -3,13 +3,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 退款订单更新 Request VO") +@Schema(description = "管理后台 - 退款订单更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PayRefundUpdateReqVO extends PayRefundBaseVO { - @Schema(title = "支付退款编号", required = true) + @Schema(description = "支付退款编号", required = true) @NotNull(message = "支付退款编号不能为空") private Long id; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/order/vo/AppPayOrderSubmitReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/order/vo/AppPayOrderSubmitReqVO.java index e2275f6e4..38f19c735 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/order/vo/AppPayOrderSubmitReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/order/vo/AppPayOrderSubmitReqVO.java @@ -8,20 +8,20 @@ import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; import java.util.Map; -@Schema(title = "用户 APP - 支付订单提交 Request VO") +@Schema(description = "用户 APP - 支付订单提交 Request VO") @Data @Accessors(chain = true) public class AppPayOrderSubmitReqVO { - @Schema(title = "支付单编号", required = true, example = "1024") + @Schema(description = "支付单编号", required = true, example = "1024") @NotNull(message = "支付单编号不能为空") private Long id; - @Schema(title = "支付渠道", required = true, example = "wx_pub") + @Schema(description = "支付渠道", required = true, example = "wx_pub") @NotEmpty(message = "支付渠道不能为空") private String channelCode; - @Schema(title = "支付渠道的额外参数", description = "例如说，微信公众号需要传递 openid 参数") + @Schema(description = "支付渠道的额外参数，例如说，微信公众号需要传递 openid 参数") private Map channelExtras; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/order/vo/AppPayOrderSubmitRespVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/order/vo/AppPayOrderSubmitRespVO.java index ee33ef6ac..1eb4a852d 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/order/vo/AppPayOrderSubmitRespVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/order/vo/AppPayOrderSubmitRespVO.java @@ -7,7 +7,7 @@ import lombok.Data; import lombok.NoArgsConstructor; import lombok.experimental.Accessors; -@Schema(title = "用户 APP - 支付订单提交 Response VO") +@Schema(description = "用户 APP - 支付订单提交 Response VO") @Data @Accessors(chain = true) @Builder diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/refund/vo/AppPayRefundReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/refund/vo/AppPayRefundReqVO.java index 6ea1528f1..09c31dae6 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/refund/vo/AppPayRefundReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/refund/vo/AppPayRefundReqVO.java @@ -8,25 +8,25 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; -@Schema(title = "用户 APP - 退款订单 Req VO") +@Schema(description = "用户 APP - 退款订单 Req VO") @Data @NoArgsConstructor @AllArgsConstructor public class AppPayRefundReqVO { - @Schema(title = "支付订单编号自增", required = true, example = "10") + @Schema(description = "支付订单编号自增", required = true, example = "10") @NotNull(message = "支付订单编号自增") private Long payOrderId; - @Schema(title = "退款金额", required = true, example = "1") + @Schema(description = "退款金额", required = true, example = "1") @NotNull(message = "退款金额") private Long amount; - @Schema(title = "退款原因", required = true, example = "不喜欢") + @Schema(description = "退款原因", required = true, example = "不喜欢") @NotEmpty(message = "退款原因") private String reason; - @Schema(title = "商户退款订单号", required = true, example = "MR202111180000000001") + @Schema(description = "商户退款订单号", required = true, example = "MR202111180000000001") //TODO 测试暂时模拟生成 //@NotEmpty(message = "商户退款订单号") private String merchantRefundId; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/refund/vo/AppPayRefundRespVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/refund/vo/AppPayRefundRespVO.java index 21466c05d..3d2d65e53 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/refund/vo/AppPayRefundRespVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/controller/app/refund/vo/AppPayRefundRespVO.java @@ -7,7 +7,7 @@ import lombok.Data; import lombok.NoArgsConstructor; import lombok.experimental.Accessors; -@Schema(title = "用户 APP - 提交退款订单 Response VO") +@Schema(description = "用户 APP - 提交退款订单 Response VO") @Data @Accessors(chain = true) @Builder @@ -15,7 +15,7 @@ import lombok.experimental.Accessors; @AllArgsConstructor public class AppPayRefundRespVO { - @Schema(title = "退款订单编号", required = true, example = "10") + @Schema(description = "退款订单编号", required = true, example = "10") private Long refundId; } diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/service/notify/vo/PayNotifyOrderReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/service/notify/vo/PayNotifyOrderReqVO.java index c9e753c67..220a807f4 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/service/notify/vo/PayNotifyOrderReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/service/notify/vo/PayNotifyOrderReqVO.java @@ -9,18 +9,18 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; -@Schema(title = "支付单的通知 Request VO", description = "业务方接入支付回调时，使用该 VO 对象") +@Schema(description = "支付单的通知 Request VO,业务方接入支付回调时，使用该 VO 对象") @Data @Builder @NoArgsConstructor @AllArgsConstructor public class PayNotifyOrderReqVO { - @Schema(title = "商户订单编号", required = true, example = "10") + @Schema(description = "商户订单编号", required = true, example = "10") @NotEmpty(message = "商户订单号不能为空") private String merchantOrderId; - @Schema(title = "支付订单编号", required = true, example = "20") + @Schema(description = "支付订单编号", required = true, example = "20") @NotNull(message = "支付订单编号不能为空") private Long payOrderId; diff --git a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/service/notify/vo/PayRefundOrderReqVO.java b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/service/notify/vo/PayRefundOrderReqVO.java index ab7d6ea03..7694d8403 100644 --- a/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/service/notify/vo/PayRefundOrderReqVO.java +++ b/yudao-module-pay/yudao-module-pay-biz/src/main/java/cn/iocoder/yudao/module/pay/service/notify/vo/PayRefundOrderReqVO.java @@ -9,22 +9,22 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; -@Schema(title = "退款单的通知 Request VO", description = "业务方接入退款回调时，使用该 VO 对象") +@Schema(description = "退款单的通知 Request VO,业务方接入退款回调时，使用该 VO 对象") @Data @Builder @NoArgsConstructor @AllArgsConstructor public class PayRefundOrderReqVO { - @Schema(title = "商户退款单编号", required = true, example = "10") + @Schema(description = "商户退款单编号", required = true, example = "10") @NotEmpty(message = "商户退款单编号不能为空") private String merchantOrderId; - @Schema(title = "支付退款编号", required = true, example = "20") + @Schema(description = "支付退款编号", required = true, example = "20") @NotNull(message = "支付退款编号不能为空") private Long payRefundId; - @Schema(title = "退款状态(成功，失败)", required = true, example = "10") + @Schema(description = "退款状态(成功，失败)", required = true, example = "10") private Integer status; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthLoginReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthLoginReqVO.java index 2f8ab7f36..757e7aef5 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthLoginReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthLoginReqVO.java @@ -14,42 +14,41 @@ import javax.validation.constraints.AssertTrue; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.Pattern; -@Schema(title = "管理后台 - 账号密码登录 Request VO", description = "如果登录并绑定社交用户，需要传递 social 开头的参数") +@Schema(description = "管理后台 - 账号密码登录 Request VO，如果登录并绑定社交用户，需要传递 social 开头的参数") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AuthLoginReqVO { - @Schema(title = "账号", required = true, example = "yudaoyuanma") + @Schema(description = "账号", required = true, example = "yudaoyuanma") @NotEmpty(message = "登录账号不能为空") @Length(min = 4, max = 16, message = "账号长度为 4-16 位") @Pattern(regexp = "^[A-Za-z0-9]+$", message = "账号格式为数字以及字母") private String username; - @Schema(title = "密码", required = true, example = "buzhidao") + @Schema(description = "密码", required = true, example = "buzhidao") @NotEmpty(message = "密码不能为空") @Length(min = 4, max = 16, message = "密码长度为 4-16 位") private String password; // ========== 图片验证码相关 ========== - @Schema(title = "验证码", required = true, - example = "PfcH6mgr8tpXuMWFjvW6YVaqrswIuwmWI5dsVZSg7sGpWtDCUbHuDEXl3cFB1+VvCC/rAkSwK8Fad52FSuncVg==", - description = "验证码开启时，需要传递") + @Schema(description = "验证码，验证码开启时，需要传递", required = true, + example = "PfcH6mgr8tpXuMWFjvW6YVaqrswIuwmWI5dsVZSg7sGpWtDCUbHuDEXl3cFB1+VvCC/rAkSwK8Fad52FSuncVg==") @NotEmpty(message = "验证码不能为空", groups = CodeEnableGroup.class) private String captchaVerification; // ========== 绑定社交登录时，需要传递如下参数 ========== - @Schema(title = "社交平台的类型", required = true, example = "10", description = "参见 SysUserSocialTypeEnum 枚举值") + @Schema(description = "社交平台的类型，参见 SysUserSocialTypeEnum 枚举值", required = true, example = "10") @InEnum(SocialTypeEnum.class) private Integer socialType; - @Schema(title = "授权码", required = true, example = "1024") + @Schema(description = "授权码", required = true, example = "1024") private String socialCode; - @Schema(title = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") + @Schema(description = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") private String socialState; /** diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthLoginRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthLoginRespVO.java index 2faf84567..79f745208 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthLoginRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthLoginRespVO.java @@ -8,23 +8,23 @@ import lombok.NoArgsConstructor; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 登录 Response VO") +@Schema(description = "管理后台 - 登录 Response VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AuthLoginRespVO { - @Schema(title = "用户编号", required = true, example = "1024") + @Schema(description = "用户编号", required = true, example = "1024") private Long userId; - @Schema(title = "访问令牌", required = true, example = "happy") + @Schema(description = "访问令牌", required = true, example = "happy") private String accessToken; - @Schema(title = "刷新令牌", required = true, example = "nice") + @Schema(description = "刷新令牌", required = true, example = "nice") private String refreshToken; - @Schema(title = "过期时间", required = true) + @Schema(description = "过期时间", required = true) private LocalDateTime expiresTime; } 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 9af118f70..58948178f 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 @@ -8,35 +8,35 @@ import lombok.NoArgsConstructor; import java.util.List; -@Schema(title = "管理后台 - 登录用户的菜单信息 Response VO") +@Schema(description = "管理后台 - 登录用户的菜单信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AuthMenuRespVO { - @Schema(title = "菜单名称", required = true, example = "芋道") + @Schema(description = "菜单名称", required = true, example = "芋道") private Long id; - @Schema(title = "父菜单 ID", required = true, example = "1024") + @Schema(description = "父菜单 ID", required = true, example = "1024") private Long parentId; - @Schema(title = "菜单名称", required = true, example = "芋道") + @Schema(description = "菜单名称", required = true, example = "芋道") private String name; - @Schema(title = "路由地址", example = "post", description = "仅菜单类型为菜单或者目录时，才需要传") + @Schema(description = "路由地址,仅菜单类型为菜单或者目录时，才需要传", example = "post") private String path; - @Schema(title = "组件路径", example = "system/post/index", description = "仅菜单类型为菜单时，才需要传") + @Schema(description = "组件路径,仅菜单类型为菜单时，才需要传", example = "system/post/index") private String component; - @Schema(title = "菜单图标", example = "/menu/list", description = "仅菜单类型为菜单或者目录时，才需要传") + @Schema(description = "菜单图标,仅菜单类型为菜单或者目录时，才需要传", example = "/menu/list") private String icon; - @Schema(title = "是否可见", required = true, example = "false") + @Schema(description = "是否可见", required = true, example = "false") private Boolean visible; - @Schema(title = "是否缓存", required = true, example = "false") + @Schema(description = "是否缓存", required = true, example = "false") private Boolean keepAlive; /** diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthPermissionInfoRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthPermissionInfoRespVO.java index cfe8725b0..957ca4b47 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthPermissionInfoRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthPermissionInfoRespVO.java @@ -8,36 +8,36 @@ import lombok.NoArgsConstructor; import java.util.Set; -@Schema(title = "管理后台 - 登录用户的权限信息 Response VO", description = "额外包括用户信息和角色列表") +@Schema(description = "管理后台 - 登录用户的权限信息 Response VO,额外包括用户信息和角色列表") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AuthPermissionInfoRespVO { - @Schema(title = "用户信息", required = true) + @Schema(description = "用户信息", required = true) private UserVO user; - @Schema(title = "角色标识数组", required = true) + @Schema(description = "角色标识数组", required = true) private Set roles; - @Schema(title = "操作权限数组", required = true) + @Schema(description = "操作权限数组", required = true) private Set permissions; - @Schema(title = "用户信息 VO") + @Schema(description = "用户信息 VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public static class UserVO { - @Schema(title = "用户编号", required = true, example = "1024") + @Schema(description = "用户编号", required = true, example = "1024") private Long id; - @Schema(title = "用户昵称", required = true, example = "芋道源码") + @Schema(description = "用户昵称", required = true, example = "芋道源码") private String nickname; - @Schema(title = "用户头像", required = true, example = "http://www.iocoder.cn/xx.jpg") + @Schema(description = "用户头像", required = true, example = "http://www.iocoder.cn/xx.jpg") private String avatar; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthSmsLoginReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthSmsLoginReqVO.java index 61e084254..5245b2f05 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthSmsLoginReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthSmsLoginReqVO.java @@ -9,19 +9,19 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotEmpty; -@Schema(title = "管理后台 - 短信验证码的登录 Request VO") +@Schema(description = "管理后台 - 短信验证码的登录 Request VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AuthSmsLoginReqVO { - @Schema(title = "手机号", required = true, example = "yudaoyuanma") + @Schema(description = "手机号", required = true, example = "yudaoyuanma") @NotEmpty(message = "手机号不能为空") @Mobile private String mobile; - @Schema(title = "短信验证码", required = true, example = "1024") + @Schema(description = "短信验证码", required = true, example = "1024") @NotEmpty(message = "验证码不能为空") private String code; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthSmsSendReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthSmsSendReqVO.java index 89b4cb97d..0f8ce8343 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthSmsSendReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthSmsSendReqVO.java @@ -12,19 +12,19 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 发送手机验证码 Request VO") +@Schema(description = "管理后台 - 发送手机验证码 Request VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AuthSmsSendReqVO { - @Schema(title = "手机号", required = true, example = "yudaoyuanma") + @Schema(description = "手机号", required = true, example = "yudaoyuanma") @NotEmpty(message = "手机号不能为空") @Mobile private String mobile; - @Schema(title = "短信场景", required = true, example = "1") + @Schema(description = "短信场景", required = true, example = "1") @NotNull(message = "发送场景不能为空") @InEnum(SmsSceneEnum.class) private Integer scene; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthSocialLoginReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthSocialLoginReqVO.java index 10648edd3..9de058c12 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthSocialLoginReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthSocialLoginReqVO.java @@ -11,23 +11,23 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 社交绑定登录 Request VO，使用 code 授权码 + 账号密码") +@Schema(description = "管理后台 - 社交绑定登录 Request VO，使用 code 授权码 + 账号密码") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class AuthSocialLoginReqVO { - @Schema(title = "社交平台的类型", required = true, example = "10", description = "参见 UserSocialTypeEnum 枚举值") + @Schema(description = "社交平台的类型,参见 UserSocialTypeEnum 枚举值", required = true, example = "10") @InEnum(SocialTypeEnum.class) @NotNull(message = "社交平台的类型不能为空") private Integer type; - @Schema(title = "授权码", required = true, example = "1024") + @Schema(description = "授权码", required = true, example = "1024") @NotEmpty(message = "授权码不能为空") private String code; - @Schema(title = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") + @Schema(description = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") @NotEmpty(message = "state 不能为空") private String state; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptBaseVO.java index c07c45ffc..25f32c21a 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptBaseVO.java @@ -14,31 +14,31 @@ import javax.validation.constraints.Size; @Data public class DeptBaseVO { - @Schema(title = "菜单名称", required = true, example = "芋道") + @Schema(description = "菜单名称", required = true, example = "芋道") @NotBlank(message = "部门名称不能为空") @Size(max = 30, message = "部门名称长度不能超过30个字符") private String name; - @Schema(title = "父菜单 ID", example = "1024") + @Schema(description = "父菜单 ID", example = "1024") private Long parentId; - @Schema(title = "显示顺序不能为空", required = true, example = "1024") + @Schema(description = "显示顺序不能为空", required = true, example = "1024") @NotNull(message = "显示顺序不能为空") private Integer sort; - @Schema(title = "负责人的用户编号", example = "2048") + @Schema(description = "负责人的用户编号", example = "2048") private Long leaderUserId; - @Schema(title = "联系电话", example = "15601691000") + @Schema(description = "联系电话", example = "15601691000") @Size(max = 11, message = "联系电话长度不能超过11个字符") private String phone; - @Schema(title = "邮箱", example = "yudao@iocoder.cn") + @Schema(description = "邮箱", example = "yudao@iocoder.cn") @Email(message = "邮箱格式不正确") @Size(max = 50, message = "邮箱长度不能超过50个字符") private String email; - @Schema(title = "状态", required = true, example = "1", description = "见 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/dept/vo/dept/DeptCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptCreateReqVO.java index 8db5621e0..66741f6da 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptCreateReqVO.java @@ -4,7 +4,7 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 部门创建 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/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 75de37bf1..469dc6ac6 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 @@ -3,14 +3,14 @@ package cn.iocoder.yudao.module.system.controller.admin.dept.vo.dept; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(title = "管理后台 - 部门列表 Request VO") +@Schema(description = "管理后台 - 部门列表 Request VO") @Data public class DeptListReqVO { - @Schema(title = "部门名称", example = "芋道", description = "模糊匹配") + @Schema(description = "部门名称,模糊匹配", example = "芋道") private String name; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; } 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 bbc55e91c..7d8933a0c 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 @@ -6,18 +6,18 @@ import lombok.EqualsAndHashCode; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 部门信息 Response VO") +@Schema(description = "管理后台 - 部门信息 Response VO") @Data @EqualsAndHashCode(callSuper = true) public class DeptRespVO extends DeptBaseVO { - @Schema(title = "部门编号", required = true, example = "1024") + @Schema(description = "部门编号", required = true, example = "1024") private Long id; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1") private Integer status; - @Schema(title = "创建时间", required = true, example = "时间戳格式") + @Schema(description = "创建时间", required = true, example = "时间戳格式") private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptSimpleRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptSimpleRespVO.java index ad353fdd8..582eaae51 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptSimpleRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptSimpleRespVO.java @@ -5,19 +5,19 @@ import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; -@Schema(title = "管理后台 - 部门精简信息 Response VO") +@Schema(description = "管理后台 - 部门精简信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor public class DeptSimpleRespVO { - @Schema(title = "部门编号", required = true, example = "1024") + @Schema(description = "部门编号", required = true, example = "1024") private Long id; - @Schema(title = "部门名称", required = true, example = "芋道") + @Schema(description = "部门名称", required = true, example = "芋道") private String name; - @Schema(title = "父部门 ID", required = true, example = "1024") + @Schema(description = "父部门 ID", required = true, example = "1024") private Long parentId; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptUpdateReqVO.java index ec40b6e7b..18d002438 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptUpdateReqVO.java @@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 部门更新 Request VO") +@Schema(description = "管理后台 - 部门更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class DeptUpdateReqVO extends DeptBaseVO { - @Schema(title = "部门编号", required = true, example = "1024") + @Schema(description = "部门编号", required = true, example = "1024") @NotNull(message = "部门编号不能为空") private Long id; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostBaseVO.java index 2504f21e5..df3f10ec5 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostBaseVO.java @@ -13,24 +13,24 @@ import javax.validation.constraints.Size; @Data public class PostBaseVO { - @Schema(title = "岗位名称", required = true, example = "小博主") + @Schema(description = "岗位名称", required = true, example = "小博主") @NotBlank(message = "岗位名称不能为空") @Size(max = 50, message = "岗位名称长度不能超过50个字符") private String name; - @Schema(title = "岗位编码", required = true, example = "yudao") + @Schema(description = "岗位编码", required = true, example = "yudao") @NotBlank(message = "岗位编码不能为空") @Size(max = 64, message = "岗位编码长度不能超过64个字符") private String code; - @Schema(title = "显示顺序不能为空", required = true, example = "1024") + @Schema(description = "显示顺序不能为空", required = true, example = "1024") @NotNull(message = "显示顺序不能为空") private Integer sort; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1") private Integer status; - @Schema(title = "备注", example = "快乐的备注") + @Schema(description = "备注", example = "快乐的备注") private String remark; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostCreateReqVO.java index 807454840..b2e52e174 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostCreateReqVO.java @@ -4,7 +4,7 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; -@Schema(title = "管理后台 - 岗位创建 Request VO") +@Schema(description = "管理后台 - 岗位创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class PostCreateReqVO extends PostBaseVO { diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostExportReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostExportReqVO.java index 9e349ce12..8b7cc79a3 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostExportReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostExportReqVO.java @@ -3,17 +3,17 @@ package cn.iocoder.yudao.module.system.controller.admin.dept.vo.post; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(title = "管理后台 - 岗位导出 Request VO", description = "参数和 PostExcelVO 是一致的") +@Schema(description = "管理后台 - 岗位导出 Request VO,参数和 PostExcelVO 是一致的") @Data public class PostExportReqVO { - @Schema(title = "岗位编码", example = "yudao", description = "模糊匹配") + @Schema(description = "岗位编码,模糊匹配", example = "yudao") private String code; - @Schema(title = "岗位名称", example = "芋道", description = "模糊匹配") + @Schema(description = "岗位名称,模糊匹配", example = "芋道") private String name; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostListReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostListReqVO.java index 2450c39ee..abb166132 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostListReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostListReqVO.java @@ -4,15 +4,15 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; -@Schema(title = "管理后台 - 岗位列表 Request VO") +@Schema(description = "管理后台 - 岗位列表 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class PostListReqVO extends PostBaseVO { - @Schema(title = "岗位名称", example = "芋道", description = "模糊匹配") + @Schema(description = "岗位名称,模糊匹配", example = "芋道") private String name; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostPageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostPageReqVO.java index 3a027ea29..0806725f5 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostPageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostPageReqVO.java @@ -5,18 +5,18 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; -@Schema(title = "管理后台 - 岗位分页 Request VO") +@Schema(description = "管理后台 - 岗位分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class PostPageReqVO extends PageParam { - @Schema(title = "岗位编码", example = "yudao", description = "模糊匹配") + @Schema(description = "岗位编码,模糊匹配", example = "yudao") private String code; - @Schema(title = "岗位名称", example = "芋道", description = "模糊匹配") + @Schema(description = "岗位名称,模糊匹配", example = "芋道") private String name; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostRespVO.java index acd66af5e..807abadeb 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostRespVO.java @@ -6,15 +6,15 @@ import lombok.EqualsAndHashCode; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 岗位信息 Response VO") +@Schema(description = "管理后台 - 岗位信息 Response VO") @Data @EqualsAndHashCode(callSuper = true) public class PostRespVO extends PostBaseVO { - @Schema(title = "岗位序号", required = true, example = "1024") + @Schema(description = "岗位序号", required = true, example = "1024") private Long id; - @Schema(title = "创建时间", required = true, example = "时间戳格式") + @Schema(description = "创建时间", required = true, example = "时间戳格式") private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostSimpleRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostSimpleRespVO.java index b94398007..eeb613b40 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostSimpleRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostSimpleRespVO.java @@ -5,16 +5,16 @@ import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; -@Schema(title = "管理后台 - 岗位精简信息 Response VO") +@Schema(description = "管理后台 - 岗位精简信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor public class PostSimpleRespVO { - @Schema(title = "岗位编号", required = true, example = "1024") + @Schema(description = "岗位编号", required = true, example = "1024") private Long id; - @Schema(title = "岗位名称", required = true, example = "芋道") + @Schema(description = "岗位名称", required = true, example = "芋道") private String name; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostUpdateReqVO.java index d32c8e8fa..e78c8160f 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/post/PostUpdateReqVO.java @@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 岗位更新 Request VO") +@Schema(description = "管理后台 - 岗位更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class PostUpdateReqVO extends PostBaseVO { - @Schema(title = "岗位编号", required = true, example = "1024") + @Schema(description = "岗位编号", required = true, example = "1024") @NotNull(message = "岗位编号不能为空") private Long id; 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 79c32b9a8..90b5b9fea 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 @@ -14,36 +14,36 @@ import javax.validation.constraints.Size; @Data public class DictDataBaseVO { - @Schema(title = "显示顺序不能为空", required = true, example = "1024") + @Schema(description = "显示顺序不能为空", required = true, example = "1024") @NotNull(message = "显示顺序不能为空") private Integer sort; - @Schema(title = "字典标签", required = true, example = "芋道") + @Schema(description = "字典标签", required = true, example = "芋道") @NotBlank(message = "字典标签不能为空") @Size(max = 100, message = "字典标签长度不能超过100个字符") private String label; - @Schema(title = "字典值", required = true, example = "iocoder") + @Schema(description = "字典值", required = true, example = "iocoder") @NotBlank(message = "字典键值不能为空") @Size(max = 100, message = "字典键值长度不能超过100个字符") private String value; - @Schema(title = "字典类型", required = true, example = "sys_common_sex") + @Schema(description = "字典类型", required = true, example = "sys_common_sex") @NotBlank(message = "字典类型不能为空") @Size(max = 100, message = "字典类型长度不能超过100个字符") private String dictType; - @Schema(title = "状态", required = true, example = "1", description = "见 CommonStatusEnum 枚举") + @Schema(description = "状态,见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") // @InEnum(value = CommonStatusEnum.class, message = "修改状态必须是 {value}") private Integer status; - @Schema(title = "颜色类型", example = "default", description = "default、primary、success、info、warning、danger") + @Schema(description = "颜色类型,default、primary、success、info、warning、danger", example = "default") private String colorType; - @Schema(title = "css 样式", example = "btn-visible") + @Schema(description = "css 样式", example = "btn-visible") private String cssClass; - @Schema(title = "备注", example = "我是一个角色") + @Schema(description = "备注", example = "我是一个角色") private String remark; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataCreateReqVO.java index b4fe37ba9..6f225eba4 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataCreateReqVO.java @@ -4,7 +4,7 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; -@Schema(title = "管理后台 - 字典数据创建 Request VO") +@Schema(description = "管理后台 - 字典数据创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class DictDataCreateReqVO extends DictDataBaseVO { diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataExportReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataExportReqVO.java index 94f1a4ffb..60e91db19 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataExportReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataExportReqVO.java @@ -5,19 +5,19 @@ import lombok.Data; import javax.validation.constraints.Size; -@Schema(title = "管理后台 - 字典类型导出 Request VO") +@Schema(description = "管理后台 - 字典类型导出 Request VO") @Data public class DictDataExportReqVO { - @Schema(title = "字典标签", example = "芋道") + @Schema(description = "字典标签", example = "芋道") @Size(max = 100, message = "字典标签长度不能超过100个字符") private String label; - @Schema(title = "字典类型", example = "sys_common_sex", description = "模糊匹配") + @Schema(description = "字典类型,模糊匹配", example = "sys_common_sex") @Size(max = 100, message = "字典类型类型长度不能超过100个字符") private String dictType; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") 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/data/DictDataPageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataPageReqVO.java index a883c8048..bceec1600 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataPageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataPageReqVO.java @@ -7,20 +7,20 @@ import lombok.EqualsAndHashCode; import javax.validation.constraints.Size; -@Schema(title = "管理后台 - 字典类型分页列表 Request VO") +@Schema(description = "管理后台 - 字典类型分页列表 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class DictDataPageReqVO extends PageParam { - @Schema(title = "字典标签", example = "芋道") + @Schema(description = "字典标签", example = "芋道") @Size(max = 100, message = "字典标签长度不能超过100个字符") private String label; - @Schema(title = "字典类型", example = "sys_common_sex", description = "模糊匹配") + @Schema(description = "字典类型,模糊匹配", example = "sys_common_sex") @Size(max = 100, message = "字典类型类型长度不能超过100个字符") private String dictType; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") 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/data/DictDataRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataRespVO.java index 72cb23cf7..b3afef470 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataRespVO.java @@ -8,17 +8,17 @@ import lombok.NoArgsConstructor; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 字典数据信息 Response VO") +@Schema(description = "管理后台 - 字典数据信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor @EqualsAndHashCode(callSuper = true) public class DictDataRespVO extends DictDataBaseVO { - @Schema(title = "字典数据编号", required = true, example = "1024") + @Schema(description = "字典数据编号", required = true, example = "1024") private Long id; - @Schema(title = "创建时间", required = true, example = "时间戳格式") + @Schema(description = "创建时间", required = true, example = "时间戳格式") private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataSimpleRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataSimpleRespVO.java index d61458446..31256e68d 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataSimpleRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataSimpleRespVO.java @@ -3,22 +3,22 @@ package cn.iocoder.yudao.module.system.controller.admin.dict.vo.data; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(title = "管理后台 - 数据字典精简 Response VO") +@Schema(description = "管理后台 - 数据字典精简 Response VO") @Data public class DictDataSimpleRespVO { - @Schema(title = "字典类型", required = true, example = "gender") + @Schema(description = "字典类型", required = true, example = "gender") private String dictType; - @Schema(title = "字典键值", required = true, example = "1") + @Schema(description = "字典键值", required = true, example = "1") private String value; - @Schema(title = "字典标签", required = true, example = "男") + @Schema(description = "字典标签", required = true, example = "男") private String label; - @Schema(title = "颜色类型", example = "default", description = "default、primary、success、info、warning、danger") + @Schema(description = "颜色类型,default、primary、success、info、warning、danger", example = "default") private String colorType; - @Schema(title = "css 样式", example = "btn-visible") + @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/data/DictDataUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataUpdateReqVO.java index 9481ab1b4..ddbe8d734 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataUpdateReqVO.java @@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 字典数据更新 Request VO") +@Schema(description = "管理后台 - 字典数据更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class DictDataUpdateReqVO extends DictDataBaseVO { - @Schema(title = "字典数据编号", required = true, example = "1024") + @Schema(description = "字典数据编号", required = true, example = "1024") @NotNull(message = "字典数据编号不能为空") private Long id; 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 d4e28e043..876eb8842 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 @@ -14,16 +14,16 @@ import javax.validation.constraints.Size; @Data public class DictTypeBaseVO { - @Schema(title = "字典名称", required = true, example = "性别") + @Schema(description = "字典名称", required = true, example = "性别") @NotBlank(message = "字典名称不能为空") @Size(max = 100, message = "字典类型名称长度不能超过100个字符") private String name; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; - @Schema(title = "备注", example = "快乐的备注") + @Schema(description = "备注", example = "快乐的备注") private String remark; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeCreateReqVO.java index f7c158503..fc91e9197 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeCreateReqVO.java @@ -7,12 +7,12 @@ import lombok.EqualsAndHashCode; import javax.validation.constraints.NotNull; import javax.validation.constraints.Size; -@Schema(title = "管理后台 - 字典类型创建 Request VO") +@Schema(description = "管理后台 - 字典类型创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class DictTypeCreateReqVO extends DictTypeBaseVO { - @Schema(title = "字典类型", required = true, example = "sys_common_sex") + @Schema(description = "字典类型", required = true, example = "sys_common_sex") @NotNull(message = "字典类型不能为空") @Size(max = 100, message = "字典类型类型长度不能超过100个字符") private String type; 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 73d7093e6..b7d227ea3 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 @@ -8,21 +8,21 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 字典类型分页列表 Request VO") +@Schema(description = "管理后台 - 字典类型分页列表 Request VO") @Data public class DictTypeExportReqVO { - @Schema(title = "字典类型名称", example = "芋道", description = "模糊匹配") + @Schema(description = "字典类型名称,模糊匹配", example = "芋道") private String name; - @Schema(title = "字典类型", example = "sys_common_sex", description = "模糊匹配") + @Schema(description = "字典类型,模糊匹配", example = "sys_common_sex") private String type; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } 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 1c7b48a91..336836f89 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 @@ -11,23 +11,23 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 字典类型分页列表 Request VO") +@Schema(description = "管理后台 - 字典类型分页列表 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class DictTypePageReqVO extends PageParam { - @Schema(title = "字典类型名称", example = "芋道", description = "模糊匹配") + @Schema(description = "字典类型名称,模糊匹配", example = "芋道") private String name; - @Schema(title = "字典类型", example = "sys_common_sex", description = "模糊匹配") + @Schema(description = "字典类型,模糊匹配", example = "sys_common_sex") @Size(max = 100, message = "字典类型类型长度不能超过100个字符") private String type; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeRespVO.java index cb39b1acf..06aeb469b 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeRespVO.java @@ -8,20 +8,20 @@ import lombok.NoArgsConstructor; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 字典类型信息 Response VO") +@Schema(description = "管理后台 - 字典类型信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor @EqualsAndHashCode(callSuper = true) public class DictTypeRespVO extends DictTypeBaseVO { - @Schema(title = "字典类型编号", required = true, example = "1024") + @Schema(description = "字典类型编号", required = true, example = "1024") private Long id; - @Schema(title = "字典类型", required = true, example = "sys_common_sex") + @Schema(description = "字典类型", required = true, example = "sys_common_sex") private String type; - @Schema(title = "创建时间", required = true, example = "时间戳格式") + @Schema(description = "创建时间", required = true, example = "时间戳格式") private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeSimpleRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeSimpleRespVO.java index b68f5ebf1..61ca6a7c9 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeSimpleRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeSimpleRespVO.java @@ -5,19 +5,19 @@ import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; -@Schema(title = "管理后台 - 字典类型精简信息 Response VO") +@Schema(description = "管理后台 - 字典类型精简信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor public class DictTypeSimpleRespVO { - @Schema(title = "字典类型编号", required = true, example = "1024") + @Schema(description = "字典类型编号", required = true, example = "1024") private Long id; - @Schema(title = "字典类型名称", required = true, example = "芋道") + @Schema(description = "字典类型名称", required = true, example = "芋道") private String name; - @Schema(title = "字典类型", required = true, example = "sys_common_sex") + @Schema(description = "字典类型", required = true, example = "sys_common_sex") private String type; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeUpdateReqVO.java index 579108d23..0a3120770 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeUpdateReqVO.java @@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 字典类型更新 Request VO") +@Schema(description = "管理后台 - 字典类型更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class DictTypeUpdateReqVO extends DictTypeBaseVO { - @Schema(title = "字典类型编号", required = true, example = "1024") + @Schema(description = "字典类型编号", required = true, example = "1024") @NotNull(message = "字典类型编号不能为空") private Long id; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeBaseVO.java index ac5c7445f..6425e106c 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeBaseVO.java @@ -12,19 +12,19 @@ import javax.validation.constraints.NotNull; @Data public class ErrorCodeBaseVO { - @Schema(title = "应用名", required = true, example = "dashboard") + @Schema(description = "应用名", required = true, example = "dashboard") @NotNull(message = "应用名不能为空") private String applicationName; - @Schema(title = "错误码编码", required = true, example = "1234") + @Schema(description = "错误码编码", required = true, example = "1234") @NotNull(message = "错误码编码不能为空") private Integer code; - @Schema(title = "错误码错误提示", required = true, example = "帅气") + @Schema(description = "错误码错误提示", required = true, example = "帅气") @NotNull(message = "错误码错误提示不能为空") private String message; - @Schema(title = "备注", example = "哈哈哈") + @Schema(description = "备注", example = "哈哈哈") private String memo; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeCreateReqVO.java index 7d85826d1..0f859dbd9 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeCreateReqVO.java @@ -5,7 +5,7 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 错误码创建 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/errorcode/vo/ErrorCodeExportReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeExportReqVO.java index 90f5e739a..cb2488ee8 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeExportReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeExportReqVO.java @@ -8,24 +8,24 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 错误码 Excel 导出 Request VO", description = "参数和 InfErrorCodePageReqVO 是一致的") +@Schema(description = "管理后台 - 错误码 Excel 导出 Request VO,参数和 InfErrorCodePageReqVO 是一致的") @Data public class ErrorCodeExportReqVO { - @Schema(title = "错误码类型", example = "1") + @Schema(description = "错误码类型", example = "1") private Integer type; - @Schema(title = "应用名", example = "dashboard") + @Schema(description = "应用名", example = "dashboard") private String applicationName; - @Schema(title = "错误码编码", example = "1234") + @Schema(description = "错误码编码", example = "1234") private Integer code; - @Schema(title = "错误码错误提示", example = "帅气") + @Schema(description = "错误码错误提示", example = "帅气") private String message; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodePageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodePageReqVO.java index baeb1e203..8e5bbdb07 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodePageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodePageReqVO.java @@ -11,26 +11,26 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 错误码分页 Request VO") +@Schema(description = "管理后台 - 错误码分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ErrorCodePageReqVO extends PageParam { - @Schema(title = "错误码类型", example = "1", description = "参见 ErrorCodeTypeEnum 枚举类") + @Schema(description = "错误码类型,参见 ErrorCodeTypeEnum 枚举类", example = "1") private Integer type; - @Schema(title = "应用名", example = "dashboard") + @Schema(description = "应用名", example = "dashboard") private String applicationName; - @Schema(title = "错误码编码", example = "1234") + @Schema(description = "错误码编码", example = "1234") private Integer code; - @Schema(title = "错误码错误提示", example = "帅气") + @Schema(description = "错误码错误提示", example = "帅气") private String message; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeRespVO.java index 35712ad76..9fe447f90 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeRespVO.java @@ -7,19 +7,19 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 错误码 Response VO") +@Schema(description = "管理后台 - 错误码 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ErrorCodeRespVO extends ErrorCodeBaseVO { - @Schema(title = "错误码编号", required = true, example = "1024") + @Schema(description = "错误码编号", required = true, example = "1024") private Long id; - @Schema(title = "错误码类型", required = true, example = "1", description = "参见 ErrorCodeTypeEnum 枚举类") + @Schema(description = "错误码类型,参见 ErrorCodeTypeEnum 枚举类", required = true, example = "1") private Integer type; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeUpdateReqVO.java index cb0bb2055..64622acd2 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/errorcode/vo/ErrorCodeUpdateReqVO.java @@ -7,13 +7,13 @@ import lombok.ToString; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 错误码更新 Request VO") +@Schema(description = "管理后台 - 错误码更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ErrorCodeUpdateReqVO extends ErrorCodeBaseVO { - @Schema(title = "错误码编号", required = true, example = "1024") + @Schema(description = "错误码编号", required = true, example = "1024") @NotNull(message = "错误码编号不能为空") private Long id; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogBaseVO.java index 0e749c544..d5769c597 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogBaseVO.java @@ -15,28 +15,28 @@ import javax.validation.constraints.Size; @Data public class LoginLogBaseVO { - @Schema(title = "日志类型", required = true, example = "1", description = "参见 LoginLogTypeEnum 枚举类") + @Schema(description = "日志类型,参见 LoginLogTypeEnum 枚举类", required = true, example = "1") @NotNull(message = "日志类型不能为空") private Integer logType; - @Schema(title = "链路追踪编号", example = "89aca178-a370-411c-ae02-3f0d672be4ab") + @Schema(description = "链路追踪编号", example = "89aca178-a370-411c-ae02-3f0d672be4ab") @NotEmpty(message = "链路追踪编号不能为空") private String traceId; - @Schema(title = "用户账号", required = true, example = "yudao") + @Schema(description = "用户账号", required = true, example = "yudao") @NotBlank(message = "用户账号不能为空") @Size(max = 30, message = "用户账号长度不能超过30个字符") private String username; - @Schema(title = "登录结果", required = true, example = "1", description = "参见 LoginResultEnum 枚举类") + @Schema(description = "登录结果,参见 LoginResultEnum 枚举类", required = true, example = "1") @NotNull(message = "登录结果不能为空") private Integer result; - @Schema(title = "用户 IP", required = true, example = "127.0.0.1") + @Schema(description = "用户 IP", required = true, example = "127.0.0.1") @NotEmpty(message = "用户 IP 不能为空") private String userIp; - @Schema(title = "浏览器 UserAgent", example = "Mozilla/5.0") + @Schema(description = "浏览器 UserAgent", example = "Mozilla/5.0") private String userAgent; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogExportReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogExportReqVO.java index c95be8148..a62d9da23 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogExportReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogExportReqVO.java @@ -8,20 +8,20 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 登录日志分页列表 Request VO") +@Schema(description = "管理后台 - 登录日志分页列表 Request VO") @Data public class LoginLogExportReqVO { - @Schema(title = "用户 IP", example = "127.0.0.1", description = "模拟匹配") + @Schema(description = "用户 IP,模拟匹配", example = "127.0.0.1") private String userIp; - @Schema(title = "用户账号", example = "芋道", description = "模拟匹配") + @Schema(description = "用户账号,模拟匹配", example = "芋道") private String username; - @Schema(title = "操作状态", example = "true") + @Schema(description = "操作状态", example = "true") private Boolean status; - @Schema(title = "登录时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") + @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[] createTime; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogPageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogPageReqVO.java index 1767fd298..73f6d38a7 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogPageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogPageReqVO.java @@ -10,21 +10,21 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 登录日志分页列表 Request VO") +@Schema(description = "管理后台 - 登录日志分页列表 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class LoginLogPageReqVO extends PageParam { - @Schema(title = "用户 IP", example = "127.0.0.1", description = "模拟匹配") + @Schema(description = "用户 IP,模拟匹配", example = "127.0.0.1") private String userIp; - @Schema(title = "用户账号", example = "芋道", description = "模拟匹配") + @Schema(description = "用户账号,模拟匹配", example = "芋道") private String username; - @Schema(title = "操作状态", example = "true") + @Schema(description = "操作状态", example = "true") private Boolean status; - @Schema(title = "登录时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") + @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[] createTime; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogRespVO.java index 4c57e0d59..a67d871ea 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/loginlog/LoginLogRespVO.java @@ -8,23 +8,23 @@ import lombok.ToString; import javax.validation.constraints.NotNull; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 登录日志 Response VO") +@Schema(description = "管理后台 - 登录日志 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class LoginLogRespVO extends LoginLogBaseVO { - @Schema(title = "日志编号", required = true, example = "1024") + @Schema(description = "日志编号", required = true, example = "1024") private Long id; - @Schema(title = "用户编号", example = "666") + @Schema(description = "用户编号", example = "666") private Long userId; - @Schema(title = "用户类型", required = true, example = "2", description = "参见 UserTypeEnum 枚举") + @Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2") @NotNull(message = "用户类型不能为空") private Integer userType; - @Schema(title = "登录时间", required = true) + @Schema(description = "登录时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogBaseVO.java index e36da5c07..e3187b0d5 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogBaseVO.java @@ -15,71 +15,71 @@ import java.util.Map; @Data public class OperateLogBaseVO { - @Schema(title = "链路追踪编号", required = true, example = "89aca178-a370-411c-ae02-3f0d672be4ab") + @Schema(description = "链路追踪编号", required = true, example = "89aca178-a370-411c-ae02-3f0d672be4ab") @NotEmpty(message = "链路追踪编号不能为空") private String traceId; - @Schema(title = "用户编号", required = true, example = "1024") + @Schema(description = "用户编号", required = true, example = "1024") @NotNull(message = "用户编号不能为空") private Long userId; - @Schema(title = "操作模块", required = true, example = "订单") + @Schema(description = "操作模块", required = true, example = "订单") @NotEmpty(message = "操作模块不能为空") private String module; - @Schema(title = "操作名", required = true, example = "创建订单") + @Schema(description = "操作名", required = true, example = "创建订单") @NotEmpty(message = "操作名") private String name; - @Schema(title = "操作分类", required = true, example = "1", description = "参见 OperateLogTypeEnum 枚举类") + @Schema(description = "操作分类,参见 OperateLogTypeEnum 枚举类", required = true, example = "1") @NotNull(message = "操作分类不能为空") private Integer type; - @Schema(title = "操作明细", example = "修改编号为 1 的用户信息，将性别从男改成女，将姓名从芋道改成源码。") + @Schema(description = "操作明细", example = "修改编号为 1 的用户信息，将性别从男改成女，将姓名从芋道改成源码。") private String content; - @Schema(title = "拓展字段", example = "{'orderId': 1}") + @Schema(description = "拓展字段", example = "{'orderId': 1}") private Map exts; - @Schema(title = "请求方法名", required = true, example = "GET") + @Schema(description = "请求方法名", required = true, example = "GET") @NotEmpty(message = "请求方法名不能为空") private String requestMethod; - @Schema(title = "请求地址", required = true, example = "/xxx/yyy") + @Schema(description = "请求地址", required = true, example = "/xxx/yyy") @NotEmpty(message = "请求地址不能为空") private String requestUrl; - @Schema(title = "用户 IP", required = true, example = "127.0.0.1") + @Schema(description = "用户 IP", required = true, example = "127.0.0.1") @NotEmpty(message = "用户 IP 不能为空") private String userIp; - @Schema(title = "浏览器 UserAgent", required = true, example = "Mozilla/5.0") + @Schema(description = "浏览器 UserAgent", required = true, example = "Mozilla/5.0") @NotEmpty(message = "浏览器 UserAgent 不能为空") private String userAgent; - @Schema(title = "Java 方法名", required = true, example = "cn.iocoder.yudao.adminserver.UserController.save(...)") + @Schema(description = "Java 方法名", required = true, example = "cn.iocoder.yudao.adminserver.UserController.save(...)") @NotEmpty(message = "Java 方法名不能为空") private String javaMethod; - @Schema(title = "Java 方法的参数") + @Schema(description = "Java 方法的参数") private String javaMethodArgs; - @Schema(title = "开始时间", required = true) + @Schema(description = "开始时间", required = true) @NotNull(message = "开始时间不能为空") private LocalDateTime startTime; - @Schema(title = "执行时长，单位：毫秒", required = true) + @Schema(description = "执行时长，单位：毫秒", required = true) @NotNull(message = "执行时长不能为空") private Integer duration; - @Schema(title = "结果码", required = true) + @Schema(description = "结果码", required = true) @NotNull(message = "结果码不能为空") private Integer resultCode; - @Schema(title = "结果提示") + @Schema(description = "结果提示") private String resultMsg; - @Schema(title = "结果数据") + @Schema(description = "结果数据") private String resultData; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogExportReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogExportReqVO.java index c323b2cb6..c12aca80e 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogExportReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogExportReqVO.java @@ -8,23 +8,23 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 操作日志分页列表 Request VO") +@Schema(description = "管理后台 - 操作日志分页列表 Request VO") @Data public class OperateLogExportReqVO { - @Schema(title = "操作模块", example = "订单", description = "模拟匹配") + @Schema(description = "操作模块,模拟匹配", example = "订单") private String module; - @Schema(title = "用户昵称", example = "芋道", description = "模拟匹配") + @Schema(description = "用户昵称,模拟匹配", example = "芋道") private String userNickname; - @Schema(title = "操作分类", example = "1", description = "参见 OperateLogTypeEnum 枚举类") + @Schema(description = "操作分类,参见 OperateLogTypeEnum 枚举类", example = "1") private Integer type; - @Schema(title = "操作状态", example = "true") + @Schema(description = "操作状态", example = "true") private Boolean success; - @Schema(title = "开始时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") + @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[] startTime; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogPageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogPageReqVO.java index c6eed986e..13a23ac02 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogPageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogPageReqVO.java @@ -9,23 +9,23 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 操作日志分页列表 Request VO") +@Schema(description = "管理后台 - 操作日志分页列表 Request VO") @Data public class OperateLogPageReqVO extends PageParam { - @Schema(title = "操作模块", example = "订单", description = "模拟匹配") + @Schema(description = "操作模块,模拟匹配", example = "订单") private String module; - @Schema(title = "用户昵称", example = "芋道", description = "模拟匹配") + @Schema(description = "用户昵称,模拟匹配", example = "芋道") private String userNickname; - @Schema(title = "操作分类", example = "1", description = "参见 OperateLogTypeEnum 枚举类") + @Schema(description = "操作分类,参见 OperateLogTypeEnum 枚举类", example = "1") private Integer type; - @Schema(title = "操作状态", example = "true") + @Schema(description = "操作状态", example = "true") private Boolean success; - @Schema(title = "开始时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") + @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[] startTime; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogRespVO.java index 139f1b20e..1e88408ff 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/logger/vo/operatelog/OperateLogRespVO.java @@ -5,16 +5,16 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 操作日志 Response VO") +@Schema(description = "管理后台 - 操作日志 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class OperateLogRespVO extends OperateLogBaseVO { - @Schema(title = "日志编号", required = true, example = "1024") + @Schema(description = "日志编号", required = true, example = "1024") private Long id; - @Schema(title = "用户昵称", required = true, example = "芋艿") + @Schema(description = "用户昵称", required = true, example = "芋艿") private String userNickname; } 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 218812656..0b90841be 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 @@ -14,19 +14,19 @@ import javax.validation.constraints.Size; @Data public class NoticeBaseVO { - @Schema(title = "公告标题", required = true, example = "小博主") + @Schema(description = "公告标题", required = true, example = "小博主") @NotBlank(message = "公告标题不能为空") @Size(max = 50, message = "公告标题不能超过50个字符") private String title; - @Schema(title = "公告类型", required = true, example = "小博主") + @Schema(description = "公告类型", required = true, example = "小博主") @NotNull(message = "公告类型不能为空") private Integer type; - @Schema(title = "公告内容", required = true, example = "半生编码") + @Schema(description = "公告内容", required = true, example = "半生编码") private String content; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1") private Integer status; } 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 ceb834306..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 @@ -4,7 +4,7 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; -@Schema(title = "管理后台 - 通知公告创建 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 1939e288e..53ad45f56 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 @@ -5,15 +5,15 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; -@Schema(title = "管理后台 - 通知公告分页 Request VO") +@Schema(description = "管理后台 - 通知公告分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class NoticePageReqVO extends PageParam { - @Schema(title = "通知公告名称", example = "芋道", description = "模糊匹配") + @Schema(description = "通知公告名称,模糊匹配", example = "芋道") private String title; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeRespVO.java index 0e84852d0..7b83d9d15 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeRespVO.java @@ -6,15 +6,15 @@ import lombok.EqualsAndHashCode; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 通知公告信息 Response VO") +@Schema(description = "管理后台 - 通知公告信息 Response VO") @Data @EqualsAndHashCode(callSuper = true) public class NoticeRespVO extends NoticeBaseVO { - @Schema(title = "通知公告序号", required = true, example = "1024") + @Schema(description = "通知公告序号", required = true, example = "1024") private Long id; - @Schema(title = "创建时间", required = true, example = "时间戳格式") + @Schema(description = "创建时间", required = true, example = "时间戳格式") private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeUpdateReqVO.java index 89f80173d..af1d53ed1 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeUpdateReqVO.java @@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 岗位公告更新 Request VO") +@Schema(description = "管理后台 - 岗位公告更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class NoticeUpdateReqVO extends NoticeBaseVO { - @Schema(title = "岗位公告编号", required = true, example = "1024") + @Schema(description = "岗位公告编号", required = true, example = "1024") @NotNull(message = "岗位公告编号不能为空") private Long id; 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 aea3e059b..c0056ed3d 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 @@ -18,60 +18,60 @@ import java.util.List; @Data public class OAuth2ClientBaseVO { - @Schema(title = "客户端编号", required = true, example = "tudou") + @Schema(description = "客户端编号", required = true, example = "tudou") @NotNull(message = "客户端编号不能为空") private String clientId; - @Schema(title = "客户端密钥", required = true, example = "fan") + @Schema(description = "客户端密钥", required = true, example = "fan") @NotNull(message = "客户端密钥不能为空") private String secret; - @Schema(title = "应用名", required = true, example = "土豆") + @Schema(description = "应用名", required = true, example = "土豆") @NotNull(message = "应用名不能为空") private String name; - @Schema(title = "应用图标", required = true, example = "https://www.iocoder.cn/xx.png") + @Schema(description = "应用图标", required = true, example = "https://www.iocoder.cn/xx.png") @NotNull(message = "应用图标不能为空") @URL(message = "应用图标的地址不正确") private String logo; - @Schema(title = "应用描述", example = "我是一个应用") + @Schema(description = "应用描述", example = "我是一个应用") private String description; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态,参见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; - @Schema(title = "访问令牌的有效期", required = true, example = "8640") + @Schema(description = "访问令牌的有效期", required = true, example = "8640") @NotNull(message = "访问令牌的有效期不能为空") private Integer accessTokenValiditySeconds; - @Schema(title = "刷新令牌的有效期", required = true, example = "8640000") + @Schema(description = "刷新令牌的有效期", required = true, example = "8640000") @NotNull(message = "刷新令牌的有效期不能为空") private Integer refreshTokenValiditySeconds; - @Schema(title = "可重定向的 URI 地址", required = true, example = "https://www.iocoder.cn") + @Schema(description = "可重定向的 URI 地址", required = true, example = "https://www.iocoder.cn") @NotNull(message = "可重定向的 URI 地址不能为空") private List<@NotEmpty(message = "重定向的 URI 不能为空") @URL(message = "重定向的 URI 格式不正确") String> redirectUris; - @Schema(title = "授权类型", required = true, example = "password", description = "参见 OAuth2GrantTypeEnum 枚举") + @Schema(description = "授权类型,参见 OAuth2GrantTypeEnum 枚举", required = true, example = "password") @NotNull(message = "授权类型不能为空") private List authorizedGrantTypes; - @Schema(title = "授权范围", example = "user_info") + @Schema(description = "授权范围", example = "user_info") private List scopes; - @Schema(title = "自动通过的授权范围", example = "user_info") + @Schema(description = "自动通过的授权范围", example = "user_info") private List autoApproveScopes; - @Schema(title = "权限", example = "system:user:query") + @Schema(description = "权限", example = "system:user:query") private List authorities; - @Schema(title = "资源", example = "1024") + @Schema(description = "资源", example = "1024") private List resourceIds; - @Schema(title = "附加信息", example = "{yunai: true}") + @Schema(description = "附加信息", example = "{yunai: true}") private String additionalInformation; @AssertTrue(message = "附加信息必须是 JSON 格式") 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 34c4350ba..b7b8ffc38 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 @@ -3,7 +3,7 @@ package cn.iocoder.yudao.module.system.controller.admin.oauth2.vo.client; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@Schema(title = "管理后台 - OAuth2 客户端创建 Request VO") +@Schema(description = "管理后台 - OAuth2 客户端创建 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/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 c815331e9..66fd1f41b 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 @@ -4,16 +4,16 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import cn.iocoder.yudao.framework.common.pojo.PageParam; -@Schema(title = "管理后台 - OAuth2 客户端分页 Request VO") +@Schema(description = "管理后台 - OAuth2 客户端分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class OAuth2ClientPageReqVO extends PageParam { - @Schema(title = "应用名", example = "土豆", description = "模糊匹配") + @Schema(description = "应用名,模糊匹配", example = "土豆") private String name; - @Schema(title = "状态", example = "1", description = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态,参见 CommonStatusEnum 枚举", example = "1") private Integer status; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientRespVO.java index dc39d7c2a..28aff686c 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - OAuth2 客户端 Response VO") +@Schema(description = "管理后台 - OAuth2 客户端 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class OAuth2ClientRespVO extends OAuth2ClientBaseVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientUpdateReqVO.java index 32968b4cd..ba76eaeb9 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientUpdateReqVO.java @@ -7,13 +7,13 @@ import lombok.ToString; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - OAuth2 客户端更新 Request VO") +@Schema(description = "管理后台 - OAuth2 客户端更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class OAuth2ClientUpdateReqVO extends OAuth2ClientBaseVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") @NotNull(message = "编号不能为空") private Long id; 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 3c6412ae0..745095403 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 @@ -6,29 +6,29 @@ import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; -@Schema(title = "管理后台 - 【开放接口】访问令牌 Response VO") +@Schema(description = "管理后台 - 【开放接口】访问令牌 Response VO") @Data @NoArgsConstructor @AllArgsConstructor public class OAuth2OpenAccessTokenRespVO { - @Schema(title = "访问令牌", required = true, example = "tudou") + @Schema(description = "访问令牌", required = true, example = "tudou") @JsonProperty("access_token") private String accessToken; - @Schema(title = "刷新令牌", required = true, example = "nice") + @Schema(description = "刷新令牌", required = true, example = "nice") @JsonProperty("refresh_token") private String refreshToken; - @Schema(title = "令牌类型", required = true, example = "bearer") + @Schema(description = "令牌类型", required = true, example = "bearer") @JsonProperty("token_type") private String tokenType; - @Schema(title = "过期时间", required = true, example = "42430", description = "单位：秒") + @Schema(description = "过期时间,单位：秒", required = true, example = "42430") @JsonProperty("expires_in") private Long expiresIn; - @Schema(title = "授权范围", example = "user_info", description = "如果多个授权范围，使用空格分隔") + @Schema(description = "授权范围,如果多个授权范围，使用空格分隔", example = "user_info") private String scope; } 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 73a89817f..984f87916 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 @@ -8,7 +8,7 @@ import lombok.NoArgsConstructor; import java.util.List; -@Schema(title = "管理后台 - 授权页的信息 Response VO") +@Schema(description = "管理后台 - 授权页的信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor @@ -19,7 +19,7 @@ public class OAuth2OpenAuthorizeInfoRespVO { */ private Client client; - @Schema(title = "scope 的选中信息", required = true, description = "使用 List 保证有序性，Key 是 scope，Value 为是否选中") + @Schema(description = "scope 的选中信息,使用 List 保证有序性，Key 是 scope，Value 为是否选中", required = true) private List> scopes; @Data @@ -27,10 +27,10 @@ public class OAuth2OpenAuthorizeInfoRespVO { @AllArgsConstructor public static class Client { - @Schema(title = "应用名", required = true, example = "土豆") + @Schema(description = "应用名", required = true, example = "土豆") private String name; - @Schema(title = "应用图标", required = true, example = "https://www.iocoder.cn/xx.png") + @Schema(description = "应用图标", required = true, example = "https://www.iocoder.cn/xx.png") private String logo; } 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 3cf843f4f..d2dc8eb46 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 @@ -8,33 +8,33 @@ import lombok.NoArgsConstructor; import java.util.List; -@Schema(title = "管理后台 - 【开放接口】校验令牌 Response VO") +@Schema(description = "管理后台 - 【开放接口】校验令牌 Response VO") @Data @NoArgsConstructor @AllArgsConstructor public class OAuth2OpenCheckTokenRespVO { - @Schema(title = "用户编号", required = true, example = "666") + @Schema(description = "用户编号", required = true, example = "666") @JsonProperty("user_id") private Long userId; - @Schema(title = "用户类型", required = true, example = "2", description = "参见 UserTypeEnum 枚举") + @Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2") @JsonProperty("user_type") private Integer userType; - @Schema(title = "租户编号", required = true, example = "1024") + @Schema(description = "租户编号", required = true, example = "1024") @JsonProperty("tenant_id") private Long tenantId; - @Schema(title = "客户端编号", required = true, example = "car") + @Schema(description = "客户端编号", required = true, example = "car") @JsonProperty("client_id") private String clientId; - @Schema(title = "授权范围", required = true, example = "user_info") + @Schema(description = "授权范围", required = true, example = "user_info") private List scopes; - @Schema(title = "访问令牌", required = true, example = "tudou") + @Schema(description = "访问令牌", required = true, example = "tudou") @JsonProperty("access_token") private String accessToken; - @Schema(title = "过期时间", required = true, example = "1593092157", description = "时间戳 / 1000，即单位：秒") + @Schema(description = "过期时间,时间戳 / 1000，即单位：秒", required = true, example = "1593092157") private Long exp; } 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 7bd1fa5d3..1a54fdcb6 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 @@ -5,18 +5,18 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; -@Schema(title = "管理后台 - 访问令牌分页 Request VO") +@Schema(description = "管理后台 - 访问令牌分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class OAuth2AccessTokenPageReqVO extends PageParam { - @Schema(title = "用户编号", required = true, example = "666") + @Schema(description = "用户编号", required = true, example = "666") private Long userId; - @Schema(title = "用户类型", required = true, example = "2", description = "参见 UserTypeEnum 枚举") + @Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2") private Integer userType; - @Schema(title = "客户端编号", required = true, example = "2") + @Schema(description = "客户端编号", required = true, example = "2") private String clientId; } 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 b7b258ca2..125e37f46 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 @@ -7,34 +7,34 @@ import lombok.NoArgsConstructor; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 访问令牌 Response VO") +@Schema(description = "管理后台 - 访问令牌 Response VO") @Data @NoArgsConstructor @AllArgsConstructor public class OAuth2AccessTokenRespVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") private Long id; - @Schema(title = "访问令牌", required = true, example = "tudou") + @Schema(description = "访问令牌", required = true, example = "tudou") private String accessToken; - @Schema(title = "刷新令牌", required = true, example = "nice") + @Schema(description = "刷新令牌", required = true, example = "nice") private String refreshToken; - @Schema(title = "用户编号", required = true, example = "666") + @Schema(description = "用户编号", required = true, example = "666") private Long userId; - @Schema(title = "用户类型", required = true, example = "2", description = "参见 UserTypeEnum 枚举") + @Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2") private Integer userType; - @Schema(title = "客户端编号", required = true, example = "2") + @Schema(description = "客户端编号", required = true, example = "2") private String clientId; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; - @Schema(title = "过期时间", required = true) + @Schema(description = "过期时间", required = true) private LocalDateTime expiresTime; } 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 ab561607b..0a1002f7c 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 @@ -7,30 +7,30 @@ import lombok.NoArgsConstructor; import java.util.List; -@Schema(title = "管理后台 - OAuth2 获得用户基本信息 Response VO") +@Schema(description = "管理后台 - OAuth2 获得用户基本信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor public class OAuth2UserInfoRespVO { - @Schema(title = "用户编号", required = true, example = "1") + @Schema(description = "用户编号", required = true, example = "1") private Long id; - @Schema(title = "用户账号", required = true, example = "芋艿") + @Schema(description = "用户账号", required = true, example = "芋艿") private String username; - @Schema(title = "用户昵称", required = true, example = "芋道") + @Schema(description = "用户昵称", required = true, example = "芋道") private String nickname; - @Schema(title = "用户邮箱", example = "yudao@iocoder.cn") + @Schema(description = "用户邮箱", example = "yudao@iocoder.cn") private String email; - @Schema(title = "手机号码", example = "15601691300") + @Schema(description = "手机号码", example = "15601691300") private String mobile; - @Schema(title = "用户性别", example = "1", description = "参见 SexEnum 枚举类") + @Schema(description = "用户性别,参见 SexEnum 枚举类", example = "1") private Integer sex; - @Schema(title = "用户头像", example = "https://www.iocoder.cn/xxx.png") + @Schema(description = "用户头像", example = "https://www.iocoder.cn/xxx.png") private String avatar; /** @@ -43,26 +43,26 @@ public class OAuth2UserInfoRespVO { */ private List posts; - @Schema(title = "部门") + @Schema(description = "部门") @Data public static class Dept { - @Schema(title = "部门编号", required = true, example = "1") + @Schema(description = "部门编号", required = true, example = "1") private Long id; - @Schema(title = "部门名称", required = true, example = "研发部") + @Schema(description = "部门名称", required = true, example = "研发部") private String name; } - @Schema(title = "岗位") + @Schema(description = "岗位") @Data public static class Post { - @Schema(title = "岗位编号", required = true, example = "1") + @Schema(description = "岗位编号", required = true, example = "1") private Long id; - @Schema(title = "岗位名称", required = true, example = "开发") + @Schema(description = "岗位名称", required = true, example = "开发") private String name; } 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 5d7c9c267..739b12d6b 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 @@ -9,26 +9,26 @@ import org.hibernate.validator.constraints.Length; import javax.validation.constraints.Email; import javax.validation.constraints.Size; -@Schema(title = "管理后台 - OAuth2 更新用户基本信息 Request VO") +@Schema(description = "管理后台 - OAuth2 更新用户基本信息 Request VO") @Data @NoArgsConstructor @AllArgsConstructor public class OAuth2UserUpdateReqVO { - @Schema(title = "用户昵称", required = true, example = "芋艿") + @Schema(description = "用户昵称", required = true, example = "芋艿") @Size(max = 30, message = "用户昵称长度不能超过 30 个字符") private String nickname; - @Schema(title = "用户邮箱", example = "yudao@iocoder.cn") + @Schema(description = "用户邮箱", example = "yudao@iocoder.cn") @Email(message = "邮箱格式不正确") @Size(max = 50, message = "邮箱长度不能超过 50 个字符") private String email; - @Schema(title = "手机号码", example = "15601691300") + @Schema(description = "手机号码", example = "15601691300") @Length(min = 11, max = 11, message = "手机号长度必须 11 位") private String mobile; - @Schema(title = "用户性别", example = "1", description = "参见 SexEnum 枚举类") + @Schema(description = "用户性别,参见 SexEnum 枚举类", example = "1") private Integer sex; } 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 a316ad577..3b89c7515 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 @@ -14,46 +14,46 @@ import javax.validation.constraints.Size; @Data public class MenuBaseVO { - @Schema(title = "菜单名称", required = true, example = "芋道") + @Schema(description = "菜单名称", required = true, example = "芋道") @NotBlank(message = "菜单名称不能为空") @Size(max = 50, message = "菜单名称长度不能超过50个字符") private String name; - @Schema(title = "权限标识", example = "sys:menu:add", description = "仅菜单类型为按钮时，才需要传递") + @Schema(description = "权限标识,仅菜单类型为按钮时，才需要传递", example = "sys:menu:add") @Size(max = 100) private String permission; - @Schema(title = "类型", required = true, example = "1", description = "参见 MenuTypeEnum 枚举类") + @Schema(description = "类型,参见 MenuTypeEnum 枚举类", required = true, example = "1") @NotNull(message = "菜单类型不能为空") private Integer type; - @Schema(title = "显示顺序不能为空", required = true, example = "1024") + @Schema(description = "显示顺序不能为空", required = true, example = "1024") @NotNull(message = "显示顺序不能为空") private Integer sort; - @Schema(title = "父菜单 ID", required = true, example = "1024") + @Schema(description = "父菜单 ID", required = true, example = "1024") @NotNull(message = "父菜单 ID 不能为空") private Long parentId; - @Schema(title = "路由地址", example = "post", description = "仅菜单类型为菜单或者目录时，才需要传") + @Schema(description = "路由地址,仅菜单类型为菜单或者目录时，才需要传", example = "post") @Size(max = 200, message = "路由地址不能超过200个字符") private String path; - @Schema(title = "菜单图标", example = "/menu/list", description = "仅菜单类型为菜单或者目录时，才需要传") + @Schema(description = "菜单图标,仅菜单类型为菜单或者目录时，才需要传", example = "/menu/list") private String icon; - @Schema(title = "组件路径", example = "system/post/index", description = "仅菜单类型为菜单时，才需要传") + @Schema(description = "组件路径,仅菜单类型为菜单时，才需要传", example = "system/post/index") @Size(max = 200, message = "组件路径不能超过255个字符") private String component; - @Schema(title = "状态", required = true, example = "1", description = "见 CommonStatusEnum 枚举") + @Schema(description = "状态,见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; - @Schema(title = "是否可见", example = "false") + @Schema(description = "是否可见", example = "false") private Boolean visible; - @Schema(title = "是否缓存", example = "false") + @Schema(description = "是否缓存", example = "false") private Boolean keepAlive; } 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 3930c8116..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 @@ -3,7 +3,7 @@ package cn.iocoder.yudao.module.system.controller.admin.permission.vo.menu; import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; -@Schema(title = "管理后台 - 菜单创建 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 0f1410878..ce6cf5dbd 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 @@ -3,14 +3,14 @@ package cn.iocoder.yudao.module.system.controller.admin.permission.vo.menu; import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; -@Schema(title = "管理后台 - 菜单列表 Request VO") +@Schema(description = "管理后台 - 菜单列表 Request VO") @Data public class MenuListReqVO { - @Schema(title = "菜单名称", example = "芋道", description = "模糊匹配") + @Schema(description = "菜单名称,模糊匹配", example = "芋道") private String name; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") 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/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 0d5e9b2e1..f85532639 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 @@ -8,20 +8,20 @@ import lombok.NoArgsConstructor; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 菜单信息 Response VO") +@Schema(description = "管理后台 - 菜单信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor @EqualsAndHashCode(callSuper = true) public class MenuRespVO extends MenuBaseVO { - @Schema(title = "菜单编号", required = true, example = "1024") + @Schema(description = "菜单编号", required = true, example = "1024") private Long id; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1") private Integer status; - @Schema(title = "创建时间", required = true, example = "时间戳格式") + @Schema(description = "创建时间", required = true, example = "时间戳格式") private LocalDateTime createTime; } 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 53a10ed2b..bc8665ec1 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 @@ -7,22 +7,22 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 菜单精简信息 Response VO") +@Schema(description = "管理后台 - 菜单精简信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor public class MenuSimpleRespVO { - @Schema(title = "菜单编号", required = true, example = "1024") + @Schema(description = "菜单编号", required = true, example = "1024") private Long id; - @Schema(title = "菜单名称", required = true, example = "芋道") + @Schema(description = "菜单名称", required = true, example = "芋道") private String name; - @Schema(title = "父菜单 ID", required = true, example = "1024") + @Schema(description = "父菜单 ID", required = true, example = "1024") private Long parentId; - @Schema(title = "类型", required = true, example = "1", description = "参见 MenuTypeEnum 枚举类") + @Schema(description = "类型,参见 MenuTypeEnum 枚举类", required = true, example = "1") private Integer type; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuUpdateReqVO.java index 01783beff..9346be045 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuUpdateReqVO.java @@ -5,12 +5,12 @@ import lombok.*; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 菜单更新 Request VO") +@Schema(description = "管理后台 - 菜单更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class MenuUpdateReqVO extends MenuBaseVO { - @Schema(title = "菜单编号", required = true, example = "1024") + @Schema(description = "菜单编号", required = true, example = "1024") @NotNull(message = "菜单编号不能为空") private Long id; 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 9d3c126df..3d6449c99 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 @@ -7,20 +7,20 @@ import javax.validation.constraints.NotNull; import java.util.Collections; import java.util.Set; -@Schema(title = "管理后台 - 赋予角色数据权限 Request VO") +@Schema(description = "管理后台 - 赋予角色数据权限 Request VO") @Data public class PermissionAssignRoleDataScopeReqVO { - @Schema(title = "角色编号", required = true, example = "1") + @Schema(description = "角色编号", required = true, example = "1") @NotNull(message = "角色编号不能为空") private Long roleId; - @Schema(title = "数据范围", required = true, example = "1", description = "参见 DataScopeEnum 枚举类") + @Schema(description = "数据范围,参见 DataScopeEnum 枚举类", required = true, example = "1") @NotNull(message = "数据范围不能为空") // TODO 这里要多一个枚举校验 private Integer dataScope; - @Schema(title = "部门编号列表", example = "1,3,5", description = "只有范围类型为 DEPT_CUSTOM 时，该字段才需要") + @Schema(description = "部门编号列表,只有范围类型为 DEPT_CUSTOM 时，该字段才需要", example = "1,3,5") private Set dataScopeDeptIds = Collections.emptySet(); // 兜底 } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignRoleMenuReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignRoleMenuReqVO.java index 70a33591d..393ab47b2 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignRoleMenuReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignRoleMenuReqVO.java @@ -7,15 +7,15 @@ import javax.validation.constraints.NotNull; import java.util.Collections; import java.util.Set; -@Schema(title = "管理后台 - 赋予角色菜单 Request VO") +@Schema(description = "管理后台 - 赋予角色菜单 Request VO") @Data public class PermissionAssignRoleMenuReqVO { - @Schema(title = "角色编号", required = true, example = "1") + @Schema(description = "角色编号", required = true, example = "1") @NotNull(message = "角色编号不能为空") private Long roleId; - @Schema(title = "菜单编号列表", example = "1,3,5") + @Schema(description = "菜单编号列表", example = "1,3,5") private Set menuIds = Collections.emptySet(); // 兜底 } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignUserRoleReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignUserRoleReqVO.java index bcb4d46bf..74971401f 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignUserRoleReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignUserRoleReqVO.java @@ -7,15 +7,15 @@ import javax.validation.constraints.NotNull; import java.util.Collections; import java.util.Set; -@Schema(title = "管理后台 - 赋予用户角色 Request VO") +@Schema(description = "管理后台 - 赋予用户角色 Request VO") @Data public class PermissionAssignUserRoleReqVO { - @Schema(title = "用户编号", required = true, example = "1") + @Schema(description = "用户编号", required = true, example = "1") @NotNull(message = "用户编号不能为空") private Long userId; - @Schema(title = "角色编号列表", example = "1,3,5") + @Schema(description = "角色编号列表", example = "1,3,5") private Set roleIds = Collections.emptySet(); // 兜底 } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleBaseVO.java index ee320c01b..84acfad92 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleBaseVO.java @@ -14,21 +14,21 @@ import javax.validation.constraints.Size; @Data public class RoleBaseVO { - @Schema(title = "角色名称", required = true, example = "管理员") + @Schema(description = "角色名称", required = true, example = "管理员") @NotBlank(message = "角色名称不能为空") @Size(max = 30, message = "角色名称长度不能超过30个字符") private String name; @NotBlank(message = "角色标志不能为空") @Size(max = 100, message = "角色标志长度不能超过100个字符") - @Schema(title = "角色编码", required = true, example = "ADMIN") + @Schema(description = "角色编码", required = true, example = "ADMIN") private String code; - @Schema(title = "显示顺序不能为空", required = true, example = "1024") + @Schema(description = "显示顺序不能为空", required = true, example = "1024") @NotNull(message = "显示顺序不能为空") private Integer sort; - @Schema(title = "备注", example = "我是一个角色") + @Schema(description = "备注", example = "我是一个角色") private String remark; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleCreateReqVO.java index 0f21c3c2f..ab4523f15 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleCreateReqVO.java @@ -4,7 +4,7 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.Data; import lombok.EqualsAndHashCode; -@Schema(title = "管理后台 - 角色创建 Request VO") +@Schema(description = "管理后台 - 角色创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class RoleCreateReqVO extends RoleBaseVO { 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 a16deff7a..f13e91f33 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 @@ -8,20 +8,20 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 角色分页 Request VO") +@Schema(description = "管理后台 - 角色分页 Request VO") @Data public class RoleExportReqVO { - @Schema(title = "角色名称", example = "芋道", description = "模糊匹配") + @Schema(description = "角色名称,模糊匹配", example = "芋道") private String name; - @Schema(title = "角色标识", example = "yudao", description = "模糊匹配") + @Schema(description = "角色标识,模糊匹配", example = "yudao") private String code; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; - @Schema(title = "开始时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") + @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[] createTime; 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 b37cdb485..cc0f0040d 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 @@ -10,21 +10,21 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 角色分页 Request VO") +@Schema(description = "管理后台 - 角色分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class RolePageReqVO extends PageParam { - @Schema(title = "角色名称", example = "芋道", description = "模糊匹配") + @Schema(description = "角色名称,模糊匹配", example = "芋道") private String name; - @Schema(title = "角色标识", example = "yudao", description = "模糊匹配") + @Schema(description = "角色标识,模糊匹配", example = "yudao") private String code; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; - @Schema(title = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") + @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[] createTime; 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 654eff898..b4090f40e 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 @@ -9,29 +9,29 @@ import lombok.NoArgsConstructor; import java.time.LocalDateTime; import java.util.Set; -@Schema(title = "管理后台 - 角色信息 Response VO") +@Schema(description = "管理后台 - 角色信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor @EqualsAndHashCode(callSuper = true) public class RoleRespVO extends RoleBaseVO { - @Schema(title = "角色编号", required = true, example = "1") + @Schema(description = "角色编号", required = true, example = "1") private Long id; - @Schema(title = "数据范围", required = true, example = "1", description = "参见 DataScopeEnum 枚举类") + @Schema(description = "数据范围,参见 DataScopeEnum 枚举类", required = true, example = "1") private Integer dataScope; - @Schema(title = "数据范围(指定部门数组)", example = "1") + @Schema(description = "数据范围(指定部门数组)", example = "1") private Set dataScopeDeptIds; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1") private Integer status; - @Schema(title = "角色类型", required = true, example = "1", description = "参见 RoleTypeEnum 枚举类") + @Schema(description = "角色类型,参见 RoleTypeEnum 枚举类", required = true, example = "1") private Integer type; - @Schema(title = "创建时间", required = true, example = "时间戳格式") + @Schema(description = "创建时间", required = true, example = "时间戳格式") private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleSimpleRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleSimpleRespVO.java index a7fced888..d0404da61 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleSimpleRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleSimpleRespVO.java @@ -5,16 +5,16 @@ import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; -@Schema(title = "管理后台 - 角色精简信息 Response VO") +@Schema(description = "管理后台 - 角色精简信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor public class RoleSimpleRespVO { - @Schema(title = "角色编号", required = true, example = "1024") + @Schema(description = "角色编号", required = true, example = "1024") private Long id; - @Schema(title = "角色名称", required = true, example = "芋道") + @Schema(description = "角色名称", required = true, example = "芋道") private String name; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleUpdateReqVO.java index 5c02ff2d9..367fcf943 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleUpdateReqVO.java @@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 角色更新 Request VO") +@Schema(description = "管理后台 - 角色更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class RoleUpdateReqVO extends RoleBaseVO { - @Schema(title = "角色编号", required = true, example = "1024") + @Schema(description = "角色编号", required = true, example = "1024") @NotNull(message = "角色编号不能为空") private Long id; 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 ed4a72604..5f51b5757 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 @@ -7,15 +7,15 @@ import lombok.Data; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 角色更新状态 Request VO") +@Schema(description = "管理后台 - 角色更新状态 Request VO") @Data public class RoleUpdateStatusReqVO { - @Schema(title = "角色编号", required = true, example = "1024") + @Schema(description = "角色编号", required = true, example = "1024") @NotNull(message = "角色编号不能为空") private Long id; - @Schema(title = "状态", required = true, example = "1", description = "见 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 f7539f944..408e952de 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 @@ -13,19 +13,19 @@ import java.util.List; @Data public class SensitiveWordBaseVO { - @Schema(title = "敏感词", required = true, example = "敏感词") + @Schema(description = "敏感词", required = true, example = "敏感词") @NotNull(message = "敏感词不能为空") private String name; - @Schema(title = "标签", required = true, example = "短信,评论") + @Schema(description = "标签", required = true, example = "短信,评论") @NotNull(message = "标签不能为空") private List tags; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; - @Schema(title = "描述", example = "污言秽语") + @Schema(description = "描述", example = "污言秽语") private String description; } 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 bc833d276..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 @@ -5,7 +5,7 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 敏感词创建 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/sensitiveword/vo/SensitiveWordExportReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordExportReqVO.java index 7df2b7aa7..f5f3c4442 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordExportReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordExportReqVO.java @@ -8,21 +8,21 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 敏感词 Excel 导出 Request VO", description = "参数和 SensitiveWordPageReqVO 是一致的") +@Schema(description = "管理后台 - 敏感词 Excel 导出 Request VO,参数和 SensitiveWordPageReqVO 是一致的") @Data public class SensitiveWordExportReqVO { - @Schema(title = "敏感词", example = "敏感词") + @Schema(description = "敏感词", example = "敏感词") private String name; - @Schema(title = "标签", example = "短信,评论") + @Schema(description = "标签", example = "短信,评论") private String tag; - @Schema(title = "状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordPageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordPageReqVO.java index f913b9270..173162194 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordPageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordPageReqVO.java @@ -11,23 +11,23 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 敏感词分页 Request VO") +@Schema(description = "管理后台 - 敏感词分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class SensitiveWordPageReqVO extends PageParam { - @Schema(title = "敏感词", example = "敏感词") + @Schema(description = "敏感词", example = "敏感词") private String name; - @Schema(title = "标签", example = "短信,评论") + @Schema(description = "标签", example = "短信,评论") private String tag; - @Schema(title = "状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordRespVO.java index f97333f58..28849b408 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 敏感词 Response VO") +@Schema(description = "管理后台 - 敏感词 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class SensitiveWordRespVO extends SensitiveWordBaseVO { - @Schema(title = "编号", required = true, example = "1") + @Schema(description = "编号", required = true, example = "1") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordUpdateReqVO.java index 2dc0ad37b..58828115e 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordUpdateReqVO.java @@ -7,13 +7,13 @@ import lombok.ToString; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 敏感词更新 Request VO") +@Schema(description = "管理后台 - 敏感词更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class SensitiveWordUpdateReqVO extends SensitiveWordBaseVO { - @Schema(title = "编号", required = true, example = "1") + @Schema(description = "编号", required = true, example = "1") @NotNull(message = "编号不能为空") private Long id; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelBaseVO.java index c63d4545e..6c97f06de 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelBaseVO.java @@ -12,25 +12,25 @@ import javax.validation.constraints.NotNull; @Data public class SmsChannelBaseVO { - @Schema(title = "短信签名", required = true, example = "芋道源码") + @Schema(description = "短信签名", required = true, example = "芋道源码") @NotNull(message = "短信签名不能为空") private String signature; - @Schema(title = "启用状态", required = true, example = "1") + @Schema(description = "启用状态", required = true, example = "1") @NotNull(message = "启用状态不能为空") private Integer status; - @Schema(title = "备注", example = "好吃！") + @Schema(description = "备注", example = "好吃！") private String remark; - @Schema(title = "短信 API 的账号", required = true, example = "yudao") + @Schema(description = "短信 API 的账号", required = true, example = "yudao") @NotNull(message = "短信 API 的账号不能为空") private String apiKey; - @Schema(title = "短信 API 的密钥", example = "yuanma") + @Schema(description = "短信 API 的密钥", example = "yuanma") private String apiSecret; - @Schema(title = "短信发送回调 URL", example = "http://www.iocoder.cn") + @Schema(description = "短信发送回调 URL", example = "http://www.iocoder.cn") @URL(message = "回调 URL 格式不正确") private String callbackUrl; 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 b8940af40..31671a572 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 @@ -7,13 +7,13 @@ import lombok.ToString; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 短信渠道创建 Request VO") +@Schema(description = "管理后台 - 短信渠道创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class SmsChannelCreateReqVO extends SmsChannelBaseVO { - @Schema(title = "渠道编码", required = true, example = "YUN_PIAN", description = "参见 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 9b79a3170..a0c5baaf6 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 @@ -11,20 +11,20 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 短信渠道分页 Request VO") +@Schema(description = "管理后台 - 短信渠道分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class SmsChannelPageReqVO extends PageParam { - @Schema(title = "任务状态", example = "1") + @Schema(description = "任务状态", example = "1") private Integer status; - @Schema(title = "短信签名", example = "芋道源码", description = "模糊匹配") + @Schema(description = "短信签名,模糊匹配", example = "芋道源码") private String signature; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } 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 04b8d95e1..27b09d60b 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 @@ -7,19 +7,19 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 短信渠道 Response VO") +@Schema(description = "管理后台 - 短信渠道 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class SmsChannelRespVO extends SmsChannelBaseVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") private Long id; - @Schema(title = "渠道编码", required = true, example = "YUN_PIAN", description = "参见 SmsChannelEnum 枚举类") + @Schema(description = "渠道编码,参见 SmsChannelEnum 枚举类", required = true, example = "YUN_PIAN") private String code; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } 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 57c4c3fb9..b9a3f46c0 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 @@ -5,19 +5,19 @@ import lombok.Data; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 短信渠道精简 Response VO") +@Schema(description = "管理后台 - 短信渠道精简 Response VO") @Data public class SmsChannelSimpleRespVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") @NotNull(message = "编号不能为空") private Long id; - @Schema(title = "短信签名", required = true, example = "芋道源码") + @Schema(description = "短信签名", required = true, example = "芋道源码") @NotNull(message = "短信签名不能为空") private String signature; - @Schema(title = "渠道编码", required = true, example = "YUN_PIAN", description = "参见 SmsChannelEnum 枚举类") + @Schema(description = "渠道编码,参见 SmsChannelEnum 枚举类", required = true, example = "YUN_PIAN") 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/SmsChannelUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelUpdateReqVO.java index 0d4606821..3379649f1 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelUpdateReqVO.java @@ -7,13 +7,13 @@ import lombok.ToString; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 短信渠道更新 Request VO") +@Schema(description = "管理后台 - 短信渠道更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class SmsChannelUpdateReqVO extends SmsChannelBaseVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") @NotNull(message = "编号不能为空") private Long id; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/log/SmsLogExportReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/log/SmsLogExportReqVO.java index 57093888d..739e630eb 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/log/SmsLogExportReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/log/SmsLogExportReqVO.java @@ -8,31 +8,31 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 短信日志 Excel 导出 Request VO", description = "参数和 SmsLogPageReqVO 是一致的") +@Schema(description = "管理后台 - 短信日志 Excel 导出 Request VO,参数和 SmsLogPageReqVO 是一致的") @Data public class SmsLogExportReqVO { - @Schema(title = "短信渠道编号", example = "10") + @Schema(description = "短信渠道编号", example = "10") private Long channelId; - @Schema(title = "模板编号", example = "20") + @Schema(description = "模板编号", example = "20") private Long templateId; - @Schema(title = "手机号", example = "15601691300") + @Schema(description = "手机号", example = "15601691300") private String mobile; - @Schema(title = "发送状态", example = "1") + @Schema(description = "发送状态", example = "1") private Integer sendStatus; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "开始发送时间") + @Schema(description = "开始发送时间") private LocalDateTime[] sendTime; - @Schema(title = "接收状态", example = "0") + @Schema(description = "接收状态", example = "0") private Integer receiveStatus; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "开始接收时间") + @Schema(description = "开始接收时间") private LocalDateTime[] receiveTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/log/SmsLogPageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/log/SmsLogPageReqVO.java index ce00897dd..0da70bd12 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/log/SmsLogPageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/log/SmsLogPageReqVO.java @@ -11,33 +11,33 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 短信日志分页 Request VO") +@Schema(description = "管理后台 - 短信日志分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class SmsLogPageReqVO extends PageParam { - @Schema(title = "短信渠道编号", example = "10") + @Schema(description = "短信渠道编号", example = "10") private Long channelId; - @Schema(title = "模板编号", example = "20") + @Schema(description = "模板编号", example = "20") private Long templateId; - @Schema(title = "手机号", example = "15601691300") + @Schema(description = "手机号", example = "15601691300") private String mobile; - @Schema(title = "发送状态", example = "1", description = "参见 SmsSendStatusEnum 枚举类") + @Schema(description = "发送状态,参见 SmsSendStatusEnum 枚举类", example = "1") private Integer sendStatus; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "发送时间") + @Schema(description = "发送时间") private LocalDateTime[] sendTime; - @Schema(title = "接收状态", example = "0", description = "参见 SmsReceiveStatusEnum 枚举类") + @Schema(description = "接收状态,参见 SmsReceiveStatusEnum 枚举类", example = "0") private Integer receiveStatus; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "接收时间") + @Schema(description = "接收时间") private LocalDateTime[] receiveTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/log/SmsLogRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/log/SmsLogRespVO.java index 98ec37f94..2780b5de1 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/log/SmsLogRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/log/SmsLogRespVO.java @@ -6,83 +6,83 @@ import lombok.Data; import java.time.LocalDateTime; import java.util.Map; -@Schema(title = "管理后台 - 短信日志 Response VO") +@Schema(description = "管理后台 - 短信日志 Response VO") @Data public class SmsLogRespVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") private Long id; - @Schema(title = "短信渠道编号", required = true, example = "10") + @Schema(description = "短信渠道编号", required = true, example = "10") private Long channelId; - @Schema(title = "短信渠道编码", required = true, example = "ALIYUN") + @Schema(description = "短信渠道编码", required = true, example = "ALIYUN") private String channelCode; - @Schema(title = "模板编号", required = true, example = "20") + @Schema(description = "模板编号", required = true, example = "20") private Long templateId; - @Schema(title = "模板编码", required = true, example = "test-01") + @Schema(description = "模板编码", required = true, example = "test-01") private String templateCode; - @Schema(title = "短信类型", required = true, example = "1") + @Schema(description = "短信类型", required = true, example = "1") private Integer templateType; - @Schema(title = "短信内容", required = true, example = "你好，你的验证码是 1024") + @Schema(description = "短信内容", required = true, example = "你好，你的验证码是 1024") private String templateContent; - @Schema(title = "短信参数", required = true, example = "name,code") + @Schema(description = "短信参数", required = true, example = "name,code") private Map templateParams; - @Schema(title = "短信 API 的模板编号", required = true, example = "SMS_207945135") + @Schema(description = "短信 API 的模板编号", required = true, example = "SMS_207945135") private String apiTemplateId; - @Schema(title = "手机号", required = true, example = "15601691300") + @Schema(description = "手机号", required = true, example = "15601691300") private String mobile; - @Schema(title = "用户编号", example = "10") + @Schema(description = "用户编号", example = "10") private Long userId; - @Schema(title = "用户类型", example = "1") + @Schema(description = "用户类型", example = "1") private Integer userType; - @Schema(title = "发送状态", required = true, example = "1") + @Schema(description = "发送状态", required = true, example = "1") private Integer sendStatus; - @Schema(title = "发送时间") + @Schema(description = "发送时间") private LocalDateTime sendTime; - @Schema(title = "发送结果的编码", example = "0") + @Schema(description = "发送结果的编码", example = "0") private Integer sendCode; - @Schema(title = "发送结果的提示", example = "成功") + @Schema(description = "发送结果的提示", example = "成功") private String sendMsg; - @Schema(title = "短信 API 发送结果的编码", example = "SUCCESS") + @Schema(description = "短信 API 发送结果的编码", example = "SUCCESS") private String apiSendCode; - @Schema(title = "短信 API 发送失败的提示", example = "成功") + @Schema(description = "短信 API 发送失败的提示", example = "成功") private String apiSendMsg; - @Schema(title = "短信 API 发送返回的唯一请求 ID", example = "3837C6D3-B96F-428C-BBB2-86135D4B5B99") + @Schema(description = "短信 API 发送返回的唯一请求 ID", example = "3837C6D3-B96F-428C-BBB2-86135D4B5B99") private String apiRequestId; - @Schema(title = "短信 API 发送返回的序号", example = "62923244790") + @Schema(description = "短信 API 发送返回的序号", example = "62923244790") private String apiSerialNo; - @Schema(title = "接收状态", required = true, example = "0") + @Schema(description = "接收状态", required = true, example = "0") private Integer receiveStatus; - @Schema(title = "接收时间") + @Schema(description = "接收时间") private LocalDateTime receiveTime; - @Schema(title = "API 接收结果的编码", example = "DELIVRD") + @Schema(description = "API 接收结果的编码", example = "DELIVRD") private String apiReceiveCode; - @Schema(title = "API 接收结果的说明", example = "用户接收成功") + @Schema(description = "API 接收结果的说明", example = "用户接收成功") private String apiReceiveMsg; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } 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 664d52948..dc33b45c0 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 @@ -11,34 +11,34 @@ import javax.validation.constraints.NotNull; @Data public class SmsTemplateBaseVO { - @Schema(title = "短信类型", required = true, example = "1", description = "参见 SmsTemplateTypeEnum 枚举类") + @Schema(description = "短信类型,参见 SmsTemplateTypeEnum 枚举类", required = true, example = "1") @NotNull(message = "短信类型不能为空") private Integer type; - @Schema(title = "开启状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "开启状态,参见 CommonStatusEnum 枚举类", required = true, example = "1") @NotNull(message = "开启状态不能为空") private Integer status; - @Schema(title = "模板编码", required = true, example = "test_01") + @Schema(description = "模板编码", required = true, example = "test_01") @NotNull(message = "模板编码不能为空") private String code; - @Schema(title = "模板名称", required = true, example = "yudao") + @Schema(description = "模板名称", required = true, example = "yudao") @NotNull(message = "模板名称不能为空") private String name; - @Schema(title = "模板内容", required = true, example = "你好，{name}。你长的太{like}啦！") + @Schema(description = "模板内容", required = true, example = "你好，{name}。你长的太{like}啦！") @NotNull(message = "模板内容不能为空") private String content; - @Schema(title = "备注", example = "哈哈哈") + @Schema(description = "备注", example = "哈哈哈") private String remark; - @Schema(title = "短信 API 的模板编号", required = true, example = "4383920") + @Schema(description = "短信 API 的模板编号", required = true, example = "4383920") @NotNull(message = "短信 API 的模板编号不能为空") private String apiTemplateId; - @Schema(title = "短信渠道编号", required = true, example = "10") + @Schema(description = "短信渠道编号", required = true, example = "10") @NotNull(message = "短信渠道编号不能为空") private Long channelId; 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 9546b83e7..737a16a45 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 @@ -4,7 +4,7 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 短信模板创建 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/template/SmsTemplateExportReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateExportReqVO.java index 0f84463af..93d157340 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateExportReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateExportReqVO.java @@ -8,30 +8,30 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 短信模板 Excel 导出 Request VO", description = "参数和 SmsTemplatePageReqVO 是一致的") +@Schema(description = "管理后台 - 短信模板 Excel 导出 Request VO,参数和 SmsTemplatePageReqVO 是一致的") @Data public class SmsTemplateExportReqVO { - @Schema(title = "短信签名", example = "1") + @Schema(description = "短信签名", example = "1") private Integer type; - @Schema(title = "开启状态", example = "1") + @Schema(description = "开启状态", example = "1") private Integer status; - @Schema(title = "模板编码", example = "test_01", description = "模糊匹配") + @Schema(description = "模板编码,模糊匹配", example = "test_01") private String code; - @Schema(title = "模板内容", example = "你好，{name}。你长的太{like}啦！", description = "模糊匹配") + @Schema(description = "模板内容,模糊匹配", example = "你好，{name}。你长的太{like}啦！") private String content; - @Schema(title = "短信 API 的模板编号", example = "4383920", description = "模糊匹配") + @Schema(description = "短信 API 的模板编号,模糊匹配", example = "4383920") private String apiTemplateId; - @Schema(title = "短信渠道编号", example = "10") + @Schema(description = "短信渠道编号", example = "10") private Long channelId; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplatePageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplatePageReqVO.java index 3cb26d228..89ae459f5 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplatePageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplatePageReqVO.java @@ -11,32 +11,32 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 短信模板分页 Request VO") +@Schema(description = "管理后台 - 短信模板分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class SmsTemplatePageReqVO extends PageParam { - @Schema(title = "短信签名", example = "1") + @Schema(description = "短信签名", example = "1") private Integer type; - @Schema(title = "开启状态", example = "1") + @Schema(description = "开启状态", example = "1") private Integer status; - @Schema(title = "模板编码", example = "test_01", description = "模糊匹配") + @Schema(description = "模板编码,模糊匹配", example = "test_01") private String code; - @Schema(title = "模板内容", example = "你好，{name}。你长的太{like}啦！", description = "模糊匹配") + @Schema(description = "模板内容,模糊匹配", example = "你好，{name}。你长的太{like}啦！") private String content; - @Schema(title = "短信 API 的模板编号", example = "4383920", description = "模糊匹配") + @Schema(description = "短信 API 的模板编号,模糊匹配", example = "4383920") private String apiTemplateId; - @Schema(title = "短信渠道编号", example = "10") + @Schema(description = "短信渠道编号", example = "10") private Long channelId; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateRespVO.java index 853056b16..e1874ce67 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateRespVO.java @@ -8,22 +8,22 @@ import lombok.ToString; import java.time.LocalDateTime; import java.util.List; -@Schema(title = "管理后台 - 短信模板 Response VO") +@Schema(description = "管理后台 - 短信模板 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class SmsTemplateRespVO extends SmsTemplateBaseVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") private Long id; - @Schema(title = "短信渠道编码", required = true, example = "ALIYUN") + @Schema(description = "短信渠道编码", required = true, example = "ALIYUN") private String channelCode; - @Schema(title = "参数数组", example = "name,code") + @Schema(description = "参数数组", example = "name,code") private List params; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateSendReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateSendReqVO.java index f8ca2a0e0..11561fae9 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateSendReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateSendReqVO.java @@ -6,19 +6,19 @@ import lombok.Data; import javax.validation.constraints.NotNull; import java.util.Map; -@Schema(title = "管理后台 - 短信模板的发送 Request VO") +@Schema(description = "管理后台 - 短信模板的发送 Request VO") @Data public class SmsTemplateSendReqVO { - @Schema(title = "手机号", required = true, example = "15601691300") + @Schema(description = "手机号", required = true, example = "15601691300") @NotNull(message = "手机号不能为空") private String mobile; - @Schema(title = "模板编码", required = true, example = "test_01") + @Schema(description = "模板编码", required = true, example = "test_01") @NotNull(message = "模板编码不能为空") private String templateCode; - @Schema(title = "模板参数") + @Schema(description = "模板参数") private Map templateParams; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateUpdateReqVO.java index 44531e799..6cfcdfe5f 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateUpdateReqVO.java @@ -7,13 +7,13 @@ import lombok.ToString; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 短信模板更新 Request VO") +@Schema(description = "管理后台 - 短信模板更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class SmsTemplateUpdateReqVO extends SmsTemplateBaseVO { - @Schema(title = "编号", required = true, example = "1024") + @Schema(description = "编号", required = true, example = "1024") @NotNull(message = "编号不能为空") private Long id; 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 54d52e1f0..c4d36e986 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 @@ -11,23 +11,23 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 社交绑定 Request VO，使用 code 授权码") +@Schema(description = "管理后台 - 社交绑定 Request VO，使用 code 授权码") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class SocialUserBindReqVO { - @Schema(title = "社交平台的类型", required = true, example = "10", description = "参见 UserSocialTypeEnum 枚举值") + @Schema(description = "社交平台的类型,参见 UserSocialTypeEnum 枚举值", required = true, example = "10") @InEnum(SocialTypeEnum.class) @NotNull(message = "社交平台的类型不能为空") private Integer type; - @Schema(title = "授权码", required = true, example = "1024") + @Schema(description = "授权码", required = true, example = "1024") @NotEmpty(message = "授权码不能为空") private String code; - @Schema(title = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") + @Schema(description = "state", required = true, example = "9b2ffbc1-7425-4155-9894-9d5c08541d62") @NotEmpty(message = "state 不能为空") private String state; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/socail/vo/SocialUserUnbindReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/socail/vo/SocialUserUnbindReqVO.java index 933e06d9b..aa293ca5c 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/socail/vo/SocialUserUnbindReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/socail/vo/SocialUserUnbindReqVO.java @@ -11,19 +11,19 @@ import lombok.NoArgsConstructor; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 取消社交绑定 Request VO") +@Schema(description = "管理后台 - 取消社交绑定 Request VO") @Data @NoArgsConstructor @AllArgsConstructor @Builder public class SocialUserUnbindReqVO { - @Schema(title = "社交平台的类型", required = true, example = "10", description = "参见 UserSocialTypeEnum 枚举值") + @Schema(description = "社交平台的类型,参见 UserSocialTypeEnum 枚举值", required = true, example = "10") @InEnum(SocialTypeEnum.class) @NotNull(message = "社交平台的类型不能为空") private Integer type; - @Schema(title = "社交用户的 openid", required = true, example = "IPRmJ0wvBptiPIlGEZiPewGwiEiE") + @Schema(description = "社交用户的 openid", required = true, example = "IPRmJ0wvBptiPIlGEZiPewGwiEiE") @NotEmpty(message = "社交用户的 openid 不能为空") private String openid; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageBaseVO.java index d4ff85926..53adc072f 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageBaseVO.java @@ -13,18 +13,18 @@ import java.util.Set; @Data public class TenantPackageBaseVO { - @Schema(title = "套餐名", required = true, example = "VIP") + @Schema(description = "套餐名", required = true, example = "VIP") @NotNull(message = "套餐名不能为空") private String name; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举") + @Schema(description = "状态,参见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") private Integer status; - @Schema(title = "备注", example = "好") + @Schema(description = "备注", example = "好") private String remark; - @Schema(title = "关联的菜单编号", required = true) + @Schema(description = "关联的菜单编号", required = true) @NotNull(message = "关联的菜单编号不能为空") private Set menuIds; 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 46f544fa6..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 @@ -5,7 +5,7 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; -@Schema(title = "管理后台 - 租户套餐创建 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/TenantPackagePageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackagePageReqVO.java index 984dafb39..525a5da73 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackagePageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackagePageReqVO.java @@ -11,22 +11,22 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 租户套餐分页 Request VO") +@Schema(description = "管理后台 - 租户套餐分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class TenantPackagePageReqVO extends PageParam { - @Schema(title = "套餐名", example = "VIP") + @Schema(description = "套餐名", example = "VIP") private String name; - @Schema(title = "状态", example = "1") + @Schema(description = "状态", example = "1") private Integer status; - @Schema(title = "备注", example = "好") + @Schema(description = "备注", example = "好") private String remark; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageRespVO.java index e1734cd7b..f1a0d2f46 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageRespVO.java @@ -7,16 +7,16 @@ import lombok.ToString; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 租户套餐 Response VO") +@Schema(description = "管理后台 - 租户套餐 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class TenantPackageRespVO extends TenantPackageBaseVO { - @Schema(title = "套餐编号", required = true, example = "1024") + @Schema(description = "套餐编号", required = true, example = "1024") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageSimpleRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageSimpleRespVO.java index 112495807..feeff1fe8 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageSimpleRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageSimpleRespVO.java @@ -5,15 +5,15 @@ import lombok.Data; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 租户套餐精简 Response VO") +@Schema(description = "管理后台 - 租户套餐精简 Response VO") @Data public class TenantPackageSimpleRespVO { - @Schema(title = "套餐编号", required = true, example = "1024") + @Schema(description = "套餐编号", required = true, example = "1024") @NotNull(message = "套餐编号不能为空") private Long id; - @Schema(title = "套餐名", required = true, example = "VIP") + @Schema(description = "套餐名", required = true, example = "VIP") @NotNull(message = "套餐名不能为空") private String name; 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 4e4a9cdfc..a91f2fb3d 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 @@ -4,13 +4,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 租户套餐更新 Request VO") +@Schema(description = "管理后台 - 租户套餐更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class TenantPackageUpdateReqVO extends TenantPackageBaseVO { - @Schema(title = "套餐编号", required = true, example = "1024") + @Schema(description = "套餐编号", required = true, example = "1024") @NotNull(message = "套餐编号不能为空") private Long id; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantBaseVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantBaseVO.java index 4a1570135..4673e2990 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantBaseVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantBaseVO.java @@ -13,33 +13,33 @@ import java.time.LocalDateTime; @Data public class TenantBaseVO { - @Schema(title = "租户名", required = true, example = "芋道") + @Schema(description = "租户名", required = true, example = "芋道") @NotNull(message = "租户名不能为空") private String name; - @Schema(title = "联系人", required = true, example = "芋艿") + @Schema(description = "联系人", required = true, example = "芋艿") @NotNull(message = "联系人不能为空") private String contactName; - @Schema(title = "联系手机", example = "15601691300") + @Schema(description = "联系手机", example = "15601691300") private String contactMobile; - @Schema(title = "租户状态", required = true, example = "1") + @Schema(description = "租户状态", required = true, example = "1") @NotNull(message = "租户状态") private Integer status; - @Schema(title = "绑定域名", example = "https://www.iocoder.cn") + @Schema(description = "绑定域名", example = "https://www.iocoder.cn") private String domain; - @Schema(title = "租户套餐编号", required = true, example = "1024") + @Schema(description = "租户套餐编号", required = true, example = "1024") @NotNull(message = "租户套餐编号不能为空") private Long packageId; - @Schema(title = "过期时间", required = true) + @Schema(description = "过期时间", required = true) @NotNull(message = "过期时间不能为空") private LocalDateTime expireTime; - @Schema(title = "账号数量", required = true, example = "1024") + @Schema(description = "账号数量", required = true, example = "1024") @NotNull(message = "账号数量不能为空") private Integer accountCount; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantCreateReqVO.java index 209643cea..8db44c2c1 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantCreateReqVO.java @@ -9,19 +9,19 @@ import javax.validation.constraints.NotEmpty; import javax.validation.constraints.Pattern; import javax.validation.constraints.Size; -@Schema(title = "管理后台 - 租户创建 Request VO") +@Schema(description = "管理后台 - 租户创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class TenantCreateReqVO extends TenantBaseVO { - @Schema(title = "用户账号", required = true, example = "yudao") + @Schema(description = "用户账号", required = true, example = "yudao") @NotBlank(message = "用户账号不能为空") @Pattern(regexp = "^[a-zA-Z0-9]{4,30}$", message = "用户账号由 数字、字母 组成") @Size(min = 4, max = 30, message = "用户账号长度为 4-30 个字符") private String username; - @Schema(title = "密码", required = true, example = "123456") + @Schema(description = "密码", required = true, example = "123456") @NotEmpty(message = "密码不能为空") @Length(min = 4, max = 16, message = "密码长度为 4-16 位") private String password; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantExportReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantExportReqVO.java index 92e365912..706337276 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantExportReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantExportReqVO.java @@ -8,24 +8,24 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 租户 Excel 导出 Request VO", description = "参数和 TenantPageReqVO 是一致的") +@Schema(description = "管理后台 - 租户 Excel 导出 Request VO,参数和 TenantPageReqVO 是一致的") @Data public class TenantExportReqVO { - @Schema(title = "租户名", example = "芋道") + @Schema(description = "租户名", example = "芋道") private String name; - @Schema(title = "联系人", example = "芋艿") + @Schema(description = "联系人", example = "芋艿") private String contactName; - @Schema(title = "联系手机", example = "15601691300") + @Schema(description = "联系手机", example = "15601691300") private String contactMobile; - @Schema(title = "租户状态（0正常 1停用）", example = "1") + @Schema(description = "租户状态（0正常 1停用）", example = "1") private Integer status; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantPageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantPageReqVO.java index 501d75a77..512a4a761 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantPageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantPageReqVO.java @@ -11,26 +11,26 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 租户分页 Request VO") +@Schema(description = "管理后台 - 租户分页 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class TenantPageReqVO extends PageParam { - @Schema(title = "租户名", example = "芋道") + @Schema(description = "租户名", example = "芋道") private String name; - @Schema(title = "联系人", example = "芋艿") + @Schema(description = "联系人", example = "芋艿") private String contactName; - @Schema(title = "联系手机", example = "15601691300") + @Schema(description = "联系手机", example = "15601691300") private String contactMobile; - @Schema(title = "租户状态（0正常 1停用）", example = "1") + @Schema(description = "租户状态（0正常 1停用）", example = "1") private Integer status; @DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND) - @Schema(title = "创建时间") + @Schema(description = "创建时间") private LocalDateTime[] createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantRespVO.java index bbd3932c9..10e1aa552 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantRespVO.java @@ -5,16 +5,16 @@ import lombok.*; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 租户 Response VO") +@Schema(description = "管理后台 - 租户 Response VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class TenantRespVO extends TenantBaseVO { - @Schema(title = "租户编号", required = true, example = "1024") + @Schema(description = "租户编号", required = true, example = "1024") private Long id; - @Schema(title = "创建时间", required = true) + @Schema(description = "创建时间", required = true) private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantUpdateReqVO.java index dd8be9659..1969fe302 100755 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/tenant/TenantUpdateReqVO.java @@ -4,13 +4,13 @@ import io.swagger.v3.oas.annotations.media.Schema; import lombok.*; import javax.validation.constraints.*; -@Schema(title = "管理后台 - 租户更新 Request VO") +@Schema(description = "管理后台 - 租户更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class TenantUpdateReqVO extends TenantBaseVO { - @Schema(title = "租户编号", required = true, example = "1024") + @Schema(description = "租户编号", required = true, example = "1024") @NotNull(message = "租户编号不能为空") private Long id; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/profile/UserProfileRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/profile/UserProfileRespVO.java index 4a0dd9b9d..9e8298f45 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/profile/UserProfileRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/profile/UserProfileRespVO.java @@ -15,22 +15,22 @@ import java.util.List; @EqualsAndHashCode(callSuper = true) @NoArgsConstructor @AllArgsConstructor -@Schema(title = "管理后台 - 用户个人中心信息 Response VO") +@Schema(description = "管理后台 - 用户个人中心信息 Response VO") public class UserProfileRespVO extends UserBaseVO { - @Schema(title = "用户编号", required = true, example = "1") + @Schema(description = "用户编号", required = true, example = "1") private Long id; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1") private Integer status; - @Schema(title = "最后登录 IP", required = true, example = "192.168.1.1") + @Schema(description = "最后登录 IP", required = true, example = "192.168.1.1") private String loginIp; - @Schema(title = "最后登录时间", required = true, example = "时间戳格式") + @Schema(description = "最后登录时间", required = true, example = "时间戳格式") private LocalDateTime loginDate; - @Schema(title = "创建时间", required = true, example = "时间戳格式") + @Schema(description = "创建时间", required = true, example = "时间戳格式") private LocalDateTime createTime; /** @@ -52,50 +52,50 @@ public class UserProfileRespVO extends UserBaseVO { */ private List socialUsers; - @Schema(title = "角色") + @Schema(description = "角色") @Data public static class Role { - @Schema(title = "角色编号", required = true, example = "1") + @Schema(description = "角色编号", required = true, example = "1") private Long id; - @Schema(title = "角色名称", required = true, example = "普通角色") + @Schema(description = "角色名称", required = true, example = "普通角色") private String name; } - @Schema(title = "部门") + @Schema(description = "部门") @Data public static class Dept { - @Schema(title = "部门编号", required = true, example = "1") + @Schema(description = "部门编号", required = true, example = "1") private Long id; - @Schema(title = "部门名称", required = true, example = "研发部") + @Schema(description = "部门名称", required = true, example = "研发部") private String name; } - @Schema(title = "岗位") + @Schema(description = "岗位") @Data public static class Post { - @Schema(title = "岗位编号", required = true, example = "1") + @Schema(description = "岗位编号", required = true, example = "1") private Long id; - @Schema(title = "岗位名称", required = true, example = "开发") + @Schema(description = "岗位名称", required = true, example = "开发") private String name; } - @Schema(title = "社交用户") + @Schema(description = "社交用户") @Data public static class SocialUser { - @Schema(title = "社交平台的类型", required = true, example = "10", description = "参见 SocialTypeEnum 枚举类") + @Schema(description = "社交平台的类型,参见 SocialTypeEnum 枚举类", required = true, example = "10") private Integer type; - @Schema(title = "社交用户的 openid", required = true, example = "IPRmJ0wvBptiPIlGEZiPewGwiEiE") + @Schema(description = "社交用户的 openid", required = true, example = "IPRmJ0wvBptiPIlGEZiPewGwiEiE") private String openid; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/profile/UserProfileUpdatePasswordReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/profile/UserProfileUpdatePasswordReqVO.java index 94684ce6c..d784537cf 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/profile/UserProfileUpdatePasswordReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/profile/UserProfileUpdatePasswordReqVO.java @@ -6,16 +6,16 @@ import org.hibernate.validator.constraints.Length; import javax.validation.constraints.NotEmpty; -@Schema(title = "管理后台 - 用户个人中心更新密码 Request VO") +@Schema(description = "管理后台 - 用户个人中心更新密码 Request VO") @Data public class UserProfileUpdatePasswordReqVO { - @Schema(title = "旧密码", required = true, example = "123456") + @Schema(description = "旧密码", required = true, example = "123456") @NotEmpty(message = "旧密码不能为空") @Length(min = 4, max = 16, message = "密码长度为 4-16 位") private String oldPassword; - @Schema(title = "新密码", required = true, example = "654321") + @Schema(description = "新密码", required = true, example = "654321") @NotEmpty(message = "新密码不能为空") @Length(min = 4, max = 16, message = "密码长度为 4-16 位") private String newPassword; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/profile/UserProfileUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/profile/UserProfileUpdateReqVO.java index e9696add5..727f28178 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/profile/UserProfileUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/profile/UserProfileUpdateReqVO.java @@ -7,23 +7,23 @@ import javax.validation.constraints.Email; import javax.validation.constraints.Size; -@Schema(title = "管理后台 - 用户个人信息更新 Request VO") +@Schema(description = "管理后台 - 用户个人信息更新 Request VO") @Data public class UserProfileUpdateReqVO { - @Schema(title = "用户昵称", required = true, example = "芋艿") + @Schema(description = "用户昵称", required = true, example = "芋艿") @Size(max = 30, message = "用户昵称长度不能超过 30 个字符") private String nickname; - @Schema(title = "用户邮箱", example = "yudao@iocoder.cn") + @Schema(description = "用户邮箱", example = "yudao@iocoder.cn") @Email(message = "邮箱格式不正确") @Size(max = 50, message = "邮箱长度不能超过 50 个字符") private String email; - @Schema(title = "手机号码", example = "15601691300") + @Schema(description = "手机号码", example = "15601691300") private String mobile; - @Schema(title = "用户性别", example = "1", description = "参见 SexEnum 枚举类") + @Schema(description = "用户性别-参见 SexEnum 枚举类", example = "1") private Integer sex; } 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 ea9fff93b..93467b2ab 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 @@ -17,38 +17,38 @@ import java.util.Set; @Data public class UserBaseVO { - @Schema(title = "用户账号", required = true, example = "yudao") + @Schema(description = "用户账号", required = true, example = "yudao") @NotBlank(message = "用户账号不能为空") @Pattern(regexp = "^[a-zA-Z0-9]{4,30}$", message = "用户账号由 数字、字母 组成") @Size(min = 4, max = 30, message = "用户账号长度为 4-30 个字符") private String username; - @Schema(title = "用户昵称", required = true, example = "芋艿") + @Schema(description = "用户昵称", required = true, example = "芋艿") @Size(max = 30, message = "用户昵称长度不能超过30个字符") private String nickname; - @Schema(title = "备注", example = "我是一个用户") + @Schema(description = "备注", example = "我是一个用户") private String remark; - @Schema(title = "部门ID", example = "我是一个用户") + @Schema(description = "部门ID", example = "我是一个用户") private Long deptId; - @Schema(title = "岗位编号数组", example = "1") + @Schema(description = "岗位编号数组", example = "1") private Set postIds; - @Schema(title = "用户邮箱", example = "yudao@iocoder.cn") + @Schema(description = "用户邮箱", example = "yudao@iocoder.cn") @Email(message = "邮箱格式不正确") @Size(max = 50, message = "邮箱长度不能超过 50 个字符") private String email; - @Schema(title = "手机号码", example = "15601691300") + @Schema(description = "手机号码", example = "15601691300") @Mobile private String mobile; - @Schema(title = "用户性别", example = "1", description = "参见 SexEnum 枚举类") + @Schema(description = "用户性别,参见 SexEnum 枚举类", example = "1") private Integer sex; - @Schema(title = "用户头像", example = "https://www.iocoder.cn/xxx.png") + @Schema(description = "用户头像", example = "https://www.iocoder.cn/xxx.png") private String avatar; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserCreateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserCreateReqVO.java index 940ad80a3..1a80ac2d0 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserCreateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserCreateReqVO.java @@ -7,12 +7,12 @@ import org.hibernate.validator.constraints.Length; import javax.validation.constraints.NotEmpty; -@Schema(title = "管理后台 - 用户创建 Request VO") +@Schema(description = "管理后台 - 用户创建 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class UserCreateReqVO extends UserBaseVO { - @Schema(title = "密码", required = true, example = "123456") + @Schema(description = "密码", required = true, example = "123456") @NotEmpty(message = "密码不能为空") @Length(min = 4, max = 16, message = "密码长度为 4-16 位") private String password; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserExportReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserExportReqVO.java index 356db6444..5d9464b79 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserExportReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserExportReqVO.java @@ -10,26 +10,26 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 用户导出 Request VO", description = "参数和 UserPageReqVO 是一致的") +@Schema(description = "管理后台 - 用户导出 Request VO,参数和 UserPageReqVO 是一致的") @Data @NoArgsConstructor @AllArgsConstructor public class UserExportReqVO { - @Schema(title = "用户账号", example = "yudao", description = "模糊匹配") + @Schema(description = "用户账号,模糊匹配", example = "yudao") private String username; - @Schema(title = "手机号码", example = "yudao", description = "模糊匹配") + @Schema(description = "手机号码,模糊匹配", example = "yudao") private String mobile; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; - @Schema(title = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") + @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[] createTime; - @Schema(title = "部门编号", example = "1024", description = "同时筛选子部门") + @Schema(description = "部门编号,同时筛选子部门", example = "1024") private Long deptId; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserImportRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserImportRespVO.java index 36ffa2f71..c0dcd09aa 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserImportRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserImportRespVO.java @@ -7,18 +7,18 @@ import lombok.Data; import java.util.List; import java.util.Map; -@Schema(title = "管理后台 - 用户导入 Response VO") +@Schema(description = "管理后台 - 用户导入 Response VO") @Data @Builder public class UserImportRespVO { - @Schema(title = "创建成功的用户名数组", required = true) + @Schema(description = "创建成功的用户名数组", required = true) private List createUsernames; - @Schema(title = "更新成功的用户名数组", required = true) + @Schema(description = "更新成功的用户名数组", required = true) private List updateUsernames; - @Schema(title = "导入失败的用户集合", required = true, description = "key 为用户名，value 为失败原因") + @Schema(description = "导入失败的用户集合,key 为用户名，value 为失败原因", required = true) private Map failureUsernames; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserPageItemRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserPageItemRespVO.java index 21f72b090..52ae7b7ea 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserPageItemRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserPageItemRespVO.java @@ -6,7 +6,7 @@ import lombok.Data; import lombok.EqualsAndHashCode; import lombok.NoArgsConstructor; -@Schema(title = "管理后台 - 用户分页时的信息 Response VO", description = "相比用户基本信息来说，会多部门信息") +@Schema(description = "管理后台 - 用户分页时的信息 Response VO,相比用户基本信息来说，会多部门信息") @Data @NoArgsConstructor @AllArgsConstructor @@ -18,14 +18,14 @@ public class UserPageItemRespVO extends UserRespVO { */ private Dept dept; - @Schema(title = "部门") + @Schema(description = "部门") @Data public static class Dept { - @Schema(title = "部门编号", required = true, example = "1") + @Schema(description = "部门编号", required = true, example = "1") private Long id; - @Schema(title = "部门名称", required = true, example = "研发部") + @Schema(description = "部门名称", required = true, example = "研发部") private String name; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserPageReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserPageReqVO.java index 193a74807..4e6a42541 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserPageReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserPageReqVO.java @@ -12,27 +12,27 @@ import java.time.LocalDateTime; import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND; -@Schema(title = "管理后台 - 用户分页 Request VO") +@Schema(description = "管理后台 - 用户分页 Request VO") @Data @NoArgsConstructor @AllArgsConstructor @EqualsAndHashCode(callSuper = true) public class UserPageReqVO extends PageParam { - @Schema(title = "用户账号", example = "yudao", description = "模糊匹配") + @Schema(description = "用户账号,模糊匹配", example = "yudao") private String username; - @Schema(title = "手机号码", example = "yudao", description = "模糊匹配") + @Schema(description = "手机号码,模糊匹配", example = "yudao") private String mobile; - @Schema(title = "展示状态", example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1") private Integer status; - @Schema(title = "创建时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]") + @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[] createTime; - @Schema(title = "部门编号", example = "1024", description = "同时筛选子部门") + @Schema(description = "部门编号,同时筛选子部门", example = "1024") private Long deptId; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserRespVO.java index 68208729c..93a53b74e 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserRespVO.java @@ -6,26 +6,26 @@ import lombok.*; import java.time.LocalDateTime; -@Schema(title = "管理后台 - 用户信息 Response VO") +@Schema(description = "管理后台 - 用户信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor @EqualsAndHashCode(callSuper = true) public class UserRespVO extends UserBaseVO { - @Schema(title = "用户编号", required = true, example = "1") + @Schema(description = "用户编号", required = true, example = "1") private Long id; - @Schema(title = "状态", required = true, example = "1", description = "参见 CommonStatusEnum 枚举类") + @Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1") private Integer status; - @Schema(title = "最后登录 IP", required = true, example = "192.168.1.1") + @Schema(description = "最后登录 IP", required = true, example = "192.168.1.1") private String loginIp; - @Schema(title = "最后登录时间", required = true, example = "时间戳格式") + @Schema(description = "最后登录时间", required = true, example = "时间戳格式") private LocalDateTime loginDate; - @Schema(title = "创建时间", required = true, example = "时间戳格式") + @Schema(description = "创建时间", required = true, example = "时间戳格式") private LocalDateTime createTime; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserSimpleRespVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserSimpleRespVO.java index 0a2daaf6f..61460c065 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserSimpleRespVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserSimpleRespVO.java @@ -5,16 +5,16 @@ import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; -@Schema(title = "用户精简信息 Response VO") +@Schema(description = "用户精简信息 Response VO") @Data @NoArgsConstructor @AllArgsConstructor public class UserSimpleRespVO { - @Schema(title = "用户编号", required = true, example = "1024") + @Schema(description = "用户编号", required = true, example = "1024") private Long id; - @Schema(title = "用户昵称", required = true, example = "芋道") + @Schema(description = "用户昵称", required = true, example = "芋道") private String nickname; } diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserUpdatePasswordReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserUpdatePasswordReqVO.java index 44e5eb3f7..786fca8ca 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserUpdatePasswordReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserUpdatePasswordReqVO.java @@ -7,15 +7,15 @@ import org.hibernate.validator.constraints.Length; import javax.validation.constraints.NotEmpty; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 用户更新密码 Request VO") +@Schema(description = "管理后台 - 用户更新密码 Request VO") @Data public class UserUpdatePasswordReqVO { - @Schema(title = "用户编号", required = true, example = "1024") + @Schema(description = "用户编号", required = true, example = "1024") @NotNull(message = "用户编号不能为空") private Long id; - @Schema(title = "密码", required = true, example = "123456") + @Schema(description = "密码", required = true, example = "123456") @NotEmpty(message = "密码不能为空") @Length(min = 4, max = 16, message = "密码长度为 4-16 位") private String password; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserUpdateReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserUpdateReqVO.java index f5d4cc92f..d11a6e493 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserUpdateReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserUpdateReqVO.java @@ -6,12 +6,12 @@ import lombok.EqualsAndHashCode; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 用户更新 Request VO") +@Schema(description = "管理后台 - 用户更新 Request VO") @Data @EqualsAndHashCode(callSuper = true) public class UserUpdateReqVO extends UserBaseVO { - @Schema(title = "用户编号", required = true, example = "1024") + @Schema(description = "用户编号", required = true, example = "1024") @NotNull(message = "用户编号不能为空") private Long id; diff --git a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserUpdateStatusReqVO.java b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserUpdateStatusReqVO.java index 11b9afd2f..0f8e21d0c 100644 --- a/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserUpdateStatusReqVO.java +++ b/yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserUpdateStatusReqVO.java @@ -5,15 +5,15 @@ import lombok.Data; import javax.validation.constraints.NotNull; -@Schema(title = "管理后台 - 用户更新状态 Request VO") +@Schema(description = "管理后台 - 用户更新状态 Request VO") @Data public class UserUpdateStatusReqVO { - @Schema(title = "用户编号", required = true, example = "1024") + @Schema(description = "用户编号", required = true, example = "1024") @NotNull(message = "角色编号不能为空") private Long id; - @Schema(title = "状态", required = true, example = "1", description = "见 CommonStatusEnum 枚举") + @Schema(description = "状态,见 CommonStatusEnum 枚举", required = true, example = "1") @NotNull(message = "状态不能为空") // @InEnum(value = CommonStatusEnum.class, message = "修改状态必须是 {value}") private Integer status; diff --git a/yudao-server/src/main/java/cn/iocoder/yudao/module/shop/controller/app/vo/AppShopOrderCreateRespVO.java b/yudao-server/src/main/java/cn/iocoder/yudao/module/shop/controller/app/vo/AppShopOrderCreateRespVO.java index 6879beab4..0a8c30b36 100644 --- a/yudao-server/src/main/java/cn/iocoder/yudao/module/shop/controller/app/vo/AppShopOrderCreateRespVO.java +++ b/yudao-server/src/main/java/cn/iocoder/yudao/module/shop/controller/app/vo/AppShopOrderCreateRespVO.java @@ -5,16 +5,16 @@ import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Data; -@Schema(title = "用户 APP - 商城订单创建 Response VO") +@Schema(description = "用户 APP - 商城订单创建 Response VO") @Data @Builder @AllArgsConstructor public class AppShopOrderCreateRespVO { - @Schema(title = "商城订单编号", required = true, example = "1024") + @Schema(description = "商城订单编号", required = true, example = "1024") private Long id; - @Schema(title = "支付订单编号", required = true, example = "2048") + @Schema(description = "支付订单编号", required = true, example = "2048") private Long payOrderId; } diff --git a/yudao-server/src/main/resources/application.yaml b/yudao-server/src/main/resources/application.yaml index 7918d443c..583a58563 100644 --- a/yudao-server/src/main/resources/application.yaml +++ b/yudao-server/src/main/resources/application.yaml @@ -34,6 +34,10 @@ spring: redis: time-to-live: 1h # 设置过期时间为 1 小时 +springdoc: + swagger-ui: + path: /swagger-ui + # 工作流 Flowable 配置 flowable: # 1. false: 默认值，Flowable 启动时，对比数据库表中保存的版本，如果不匹配。将抛出异常 diff --git a/yudao-ui-admin-vue3/src/views/infra/swagger/index.vue b/yudao-ui-admin-vue3/src/views/infra/swagger/index.vue index 574e9ddd2..5d4697c1a 100644 --- a/yudao-ui-admin-vue3/src/views/infra/swagger/index.vue +++ b/yudao-ui-admin-vue3/src/views/infra/swagger/index.vue @@ -8,5 +8,5 @@ import { ref } from 'vue' import { IFrame } from '@/components/IFrame' const BASE_URL = import.meta.env.VITE_BASE_URL -const src = ref(BASE_URL + '/swagger-ui') +const src = ref(BASE_URL + '/doc.html')