oneos-v5/backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: 修改剩余部分 swagger 注解

Browse Source
This commit is contained in:
gaibu
2023-02-04 23:59:25 +08:00
parent 6f3e026f4c
commit 8986299fea
115 changed files with 367 additions and 392 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/auth/vo/AuthMenuRespVO.java
View File

@@ -25,13 +25,13 @@ public class AuthMenuRespVO {
@Schema(description = "菜单名称", required = true, example = "芋道")
private String name;
@Schema(description = "路由地址", example = "post", notes = "仅菜单类型为菜单或者目录时，才需要传")
@Schema(description = "路由地址，仅菜单类型为菜单或者目录时，才需要传", example = "post")
private String path;
@Schema(description = "组件路径", example = "system/post/index", notes = "仅菜单类型为菜单时，才需要传")
@Schema(description = "组件路径，仅菜单类型为菜单时，才需要传", example = "system/post/index")
private String component;
@Schema(description = "菜单图标", example = "/menu/list", notes = "仅菜单类型为菜单或者目录时，才需要传")
@Schema(description = "菜单图标，仅菜单类型为菜单或者目录时，才需要传", example = "/menu/list")
private String icon;
@Schema(description = "是否可见", required = true, example = "false")

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptListReqVO.java
View File

@@ -8,10 +8,10 @@ import lombok.Data;
@Data
public class DeptListReqVO {
@Schema(description = "部门名称", example = "芋道", notes = "模糊匹配")
@Schema(description = "部门名称,模糊匹配", example = "芋道")
private String name;
@Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
}

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dept/vo/dept/DeptRespVO.java
View File

@@ -15,7 +15,7 @@ public class DeptRespVO extends DeptBaseVO {
@Schema(description = "部门编号", required = true, example = "1024")
private Long id;
@Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1")
private Integer status;
@Schema(description = "创建时间", required = true, example = "时间戳格式")

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/data/DictDataBaseVO.java
View File

@@ -35,12 +35,12 @@ public class DictDataBaseVO {
@Size(max = 100, message = "字典类型长度不能超过100个字符")
private String dictType;
@Schema(description = "状态", required = true, example = "1", notes = "见 CommonStatusEnum 枚举")
@Schema(description = "状态,见 CommonStatusEnum 枚举", required = true, example = "1")
@NotNull(message = "状态不能为空")
// @InEnum(value = CommonStatusEnum.class, message = "修改状态必须是 {value}")
private Integer status;
@Schema(description = "颜色类型", example = "default", notes = "default、primary、success、info、warning、danger")
@Schema(description = "颜色类型,default、primary、success、info、warning、danger", example = "default")
private String colorType;
@Schema(description = "css 样式", example = "btn-visible")
private String cssClass;

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeBaseVO.java
View File

@@ -19,7 +19,7 @@ public class DictTypeBaseVO {
@Size(max = 100, message = "字典类型名称长度不能超过100个字符")
private String name;
@Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态，参见 CommonStatusEnum 枚举类", required = true, example = "1")
@NotNull(message = "状态不能为空")
private Integer status;

6
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypeExportReqVO.java
View File

@@ -13,13 +13,13 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_
@Data
public class DictTypeExportReqVO {
@Schema(description = "字典类型名称", example = "芋道", notes = "模糊匹配")
@Schema(description = "字典类型名称，模糊匹配", example = "芋道")
private String name;
@Schema(description = "字典类型", example = "sys_common_sex", notes = "模糊匹配")
@Schema(description = "字典类型，模糊匹配", example = "sys_common_sex")
private String type;
@Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态，参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)

6
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/dict/vo/type/DictTypePageReqVO.java
View File

@@ -17,14 +17,14 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_
@EqualsAndHashCode(callSuper = true)
public class DictTypePageReqVO extends PageParam {
@Schema(description = "字典类型名称", example = "芋道", notes = "模糊匹配")
@Schema(description = "字典类型名称，模糊匹配", example = "芋道")
private String name;
@Schema(description = "字典类型", example = "sys_common_sex", notes = "模糊匹配")
@Schema(description = "字典类型，模糊匹配", example = "sys_common_sex")
@Size(max = 100, message = "字典类型类型长度不能超过100个字符")
private String type;
@Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态，参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/account/MailAccountCreateReqVO.java
View File

@@ -1,11 +1,11 @@
package cn.iocoder.yudao.module.system.controller.admin.mail.vo.account;
import io.swagger.annotations.ApiModel;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@ApiModel("管理后台 - 邮箱账号创建 Request VO")
@Schema(description = "管理后台 - 邮箱账号创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogBaseVO.java
View File

@@ -20,7 +20,7 @@ public class MailLogBaseVO {
@Schema(description = "用户编号", example = "30883")
private Long userId;
@Schema(description = "用户类型", example = "2", notes = "参见 UserTypeEnum 枚举")
@Schema(description = "用户类型,参见 UserTypeEnum 枚举", example = "2" )
private Byte userType;
@Schema(description = "接收邮箱地址", required = true, example = "76854@qq.com")
@@ -58,7 +58,7 @@ public class MailLogBaseVO {
@NotNull(message = "邮件参数不能为空")
private Map<String, Object> templateParams;
@Schema(description = "发送状态", required = true, example = "1", notes = "参见 MailSendStatusEnum 枚举")
@Schema(description = "发送状态，参见 MailSendStatusEnum 枚举", required = true, example = "1" )
@NotNull(message = "发送状态不能为空")
private Byte sendStatus;

6
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/log/MailLogPageReqVO.java
View File

@@ -21,10 +21,10 @@ public class MailLogPageReqVO extends PageParam {
@Schema(description = "用户编号", example = "30883")
private Long userId;
@Schema(description = "用户类型", example = "2", notes = "参见 UserTypeEnum 枚举")
@Schema(description = "用户类型，参见 UserTypeEnum 枚举", example = "2" )
private Integer userType;
@Schema(description = "接收邮箱地址", example = "76854@qq.com", notes = "模糊匹配")
@Schema(description = "接收邮箱地址，模糊匹配", example = "76854@qq.com" )
private String toMail;
@Schema(description = "邮箱账号编号", example = "18107")
@@ -33,7 +33,7 @@ public class MailLogPageReqVO extends PageParam {
@Schema(description = "模板编号", example = "5678")
private Long templateId;
@Schema(description = "发送状态", example = "1", notes = "参见 MailSendStatusEnum 枚举")
@Schema(description = "发送状态，参见 MailSendStatusEnum 枚举", example = "1" )
private Integer sendStatus;
@Schema(description = "发送时间")

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateBaseVO.java
View File

@@ -36,7 +36,7 @@ public class MailTemplateBaseVO {
@NotEmpty(message = "内容不能为空")
private String content;
@Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举")
@Schema(description = "状态，参见 CommonStatusEnum 枚举", required = true, example = "1" )
@NotNull(message = "状态不能为空")
private Integer status;

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplateCreateReqVO.java
View File

@@ -1,11 +1,11 @@
package cn.iocoder.yudao.module.system.controller.admin.mail.vo.template;
import io.swagger.annotations.ApiModel;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@ApiModel("管理后台 - 邮件模版创建 Request VO")
@Schema(description = "管理后台 - 邮件模版创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

6
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/mail/vo/template/MailTemplatePageReqVO.java
View File

@@ -18,13 +18,13 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_
@ToString(callSuper = true)
public class MailTemplatePageReqVO extends PageParam {
@Schema(description = "状态", example = "1", notes = "参见 CommonStatusEnum 枚举")
@Schema(description = "状态,参见 CommonStatusEnum 枚举", example = "1")
private Integer status;
@Schema(description = "标识", example = "code_1024", notes = "模糊匹配")
@Schema(description = "标识,模糊匹配", example = "code_1024")
private String code;
@Schema(description = "名称", example = "芋头", notes = "模糊匹配")
@Schema(description = "名称,模糊匹配", example = "芋头")
private String name;
@Schema(description = "账号编号", example = "2048")

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeBaseVO.java
View File

@@ -26,7 +26,7 @@ public class NoticeBaseVO {
@Schema(description = "公告内容", required = true, example = "半生编码")
private String content;
@Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态，参见 CommonStatusEnum 枚举类", required = true, example = "1")
private Integer status;
}

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticeCreateReqVO.java
View File

@@ -1,10 +1,10 @@
package cn.iocoder.yudao.module.system.controller.admin.notice.vo;
import io.swagger.annotations.ApiModel;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
@ApiModel("管理后台 - 通知公告创建 Request VO")
@Schema(description = "管理后台 - 通知公告创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class NoticeCreateReqVO extends NoticeBaseVO {

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notice/vo/NoticePageReqVO.java
View File

@@ -11,10 +11,10 @@ import lombok.EqualsAndHashCode;
@EqualsAndHashCode(callSuper = true)
public class NoticePageReqVO extends PageParam {
@Schema(description = "通知公告名称", example = "芋道", notes = "模糊匹配")
@Schema(description = "通知公告名称,模糊匹配", example = "芋道")
private String title;
@Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
}

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/NotifyMessageController.java
View File

@@ -63,7 +63,7 @@ public class NotifyMessageController {
@PutMapping("/update-read")
@Operation(summary = "标记站内信为已读")
@Parameter(name = "ids", description = "编号列表", required = true, example = "1024,2048", dataTypeClass = List.class)
@Parameter(name = "ids", description = "编号列表", required = true, example = "1024,2048")
public CommonResult<Boolean> updateNotifyMessageRead(@RequestParam("ids") List<Long> ids) {
notifyMessageService.updateNotifyMessageRead(ids, getLoginUserId(), UserTypeEnum.ADMIN.getValue());
return success(Boolean.TRUE);
@@ -78,7 +78,7 @@ public class NotifyMessageController {
@GetMapping("/get-unread-list")
@Operation(summary = "获取当前用户的最新站内信列表，默认 10 条")
@Parameter(name = "size", description = "10", defaultValue = "10")
@Parameter(name = "size", description = "10")
public CommonResult<List<NotifyMessageRespVO>> getUnreadNotifyMessageList(
@RequestParam(name = "size", defaultValue = "10") Integer size) {
List<NotifyMessageDO> list = notifyMessageService.getUnreadNotifyMessageList(

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/message/NotifyMessageBaseVO.java
View File

@@ -21,7 +21,7 @@ public class NotifyMessageBaseVO {
@NotNull(message = "用户编号不能为空")
private Long userId;
@Schema(description = "用户类型", required = true, example = "1", notes = "参见 UserTypeEnum 枚举")
@Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "1")
@NotNull(message = "用户类型不能为空")
private Byte userType;

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplateBaseVO.java
View File

@@ -23,7 +23,7 @@ public class NotifyTemplateBaseVO {
@NotNull(message = "模版编码不能为空")
private String code;
@Schema(description = "模版类型", required = true, example = "1", notes = "对应 system_notify_template_type 字典")
@Schema(description = "模版类型,对应 system_notify_template_type 字典", required = true, example = "1")
@NotNull(message = "模版类型不能为空")
private Integer type;
@@ -35,7 +35,7 @@ public class NotifyTemplateBaseVO {
@NotEmpty(message = "模版内容不能为空")
private String content;
@Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举")
@Schema(description = "状态,参见 CommonStatusEnum 枚举", required = true, example = "1")
@NotNull(message = "状态不能为空")
@InEnum(value = CommonStatusEnum.class, message = "状态必须是 {value}")
private Integer status;

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplateCreateReqVO.java
View File

@@ -1,11 +1,11 @@
package cn.iocoder.yudao.module.system.controller.admin.notify.vo.template;
import io.swagger.annotations.ApiModel;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@ApiModel("管理后台 - 站内信模版创建 Request VO")
@Schema(description = "管理后台 - 站内信模版创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/notify/vo/template/NotifyTemplatePageReqVO.java
View File

@@ -24,7 +24,7 @@ public class NotifyTemplatePageReqVO extends PageParam {
@Schema(description = "模版名称", example = "我是名称")
private String name;
@Schema(description = "状态", example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态,参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
@Schema(description = "创建时间")

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/OAuth2OpenController.java
View File

@@ -213,7 +213,7 @@ public class OAuth2OpenController {
@Parameter(name = "client_id", required = true, description = "客户端编号", example = "tudou"),
@Parameter(name = "scope", description = "授权范围", example = "userinfo.read"), // 使用 Map<String, Boolean> 格式，Spring MVC 暂时不支持这么接收参数
@Parameter(name = "redirect_uri", required = true, description = "重定向 URI", example = "https://www.iocoder.cn"),
@Parameter(name = "auto_approve", required = true, description = "用户是否接受", example = "true", dataTypeClass = Boolean.class),
@Parameter(name = "auto_approve", required = true, description = "用户是否接受", example = "true"),
@Parameter(name = "state", example = "1")
})
@OperateLog(enable = false) // 避免 Post 请求被记录操作日志

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientBaseVO.java
View File

@@ -38,7 +38,7 @@ public class OAuth2ClientBaseVO {
@Schema(description = "应用描述", example = "我是一个应用")
private String description;
@Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举")
@Schema(description = "状态,参见 CommonStatusEnum 枚举", required = true, example = "1")
@NotNull(message = "状态不能为空")
private Integer status;
@@ -55,7 +55,7 @@ public class OAuth2ClientBaseVO {
private List<@NotEmpty(message = "重定向的 URI 不能为空")
@URL(message = "重定向的 URI 格式不正确") String> redirectUris;
@Schema(description = "授权类型", required = true, example = "password", notes = "参见 OAuth2GrantTypeEnum 枚举")
@Schema(description = "授权类型,参见 OAuth2GrantTypeEnum 枚举", required = true, example = "password")
@NotNull(message = "授权类型不能为空")
private List<String> authorizedGrantTypes;

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientCreateReqVO.java
View File

@@ -1,7 +1,7 @@
package cn.iocoder.yudao.module.system.controller.admin.oauth2.vo.client;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import io.swagger.annotations.*;
@Schema(description = "管理后台 - OAuth2 客户端创建 Request VO")
@Data

6
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/client/OAuth2ClientPageReqVO.java
View File

@@ -1,7 +1,7 @@
package cn.iocoder.yudao.module.system.controller.admin.oauth2.vo.client;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import io.swagger.annotations.*;
import cn.iocoder.yudao.framework.common.pojo.PageParam;
@Schema(description = "管理后台 - OAuth2 客户端分页 Request VO")
@@ -10,10 +10,10 @@ import cn.iocoder.yudao.framework.common.pojo.PageParam;
@ToString(callSuper = true)
public class OAuth2ClientPageReqVO extends PageParam {
@Schema(description = "应用名", example = "土豆", notes = "模糊匹配")
@Schema(description = "应用名,模糊匹配", example = "土豆")
private String name;
@Schema(description = "状态", example = "1", notes = "参见 CommonStatusEnum 枚举")
@Schema(description = "状态,参见 CommonStatusEnum 枚举", example = "1")
private Integer status;
}

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenAccessTokenRespVO.java
View File

@@ -25,11 +25,11 @@ public class OAuth2OpenAccessTokenRespVO {
@JsonProperty("token_type")
private String tokenType;
@Schema(description = "过期时间", required = true, example = "42430", notes = "单位：秒")
@Schema(description = "过期时间,单位：秒", required = true, example = "42430")
@JsonProperty("expires_in")
private Long expiresIn;
@Schema(description = "授权范围", example = "user_info", notes = "如果多个授权范围，使用空格分隔")
@Schema(description = "授权范围,如果多个授权范围，使用空格分隔", example = "user_info")
private String scope;
}

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenAuthorizeInfoRespVO.java
View File

@@ -20,7 +20,7 @@ public class OAuth2OpenAuthorizeInfoRespVO {
*/
private Client client;
@Schema(description = "scope 的选中信息", required = true, notes = "使用 List 保证有序性，Key 是 scope，Value 为是否选中")
@Schema(description = "scope 的选中信息,使用 List 保证有序性，Key 是 scope，Value 为是否选中", required = true)
private List<KeyValue<String, Boolean>> scopes;
@Data

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/open/OAuth2OpenCheckTokenRespVO.java
View File

@@ -18,7 +18,7 @@ public class OAuth2OpenCheckTokenRespVO {
@Schema(description = "用户编号", required = true, example = "666")
@JsonProperty("user_id")
private Long userId;
@Schema(description = "用户类型", required = true, example = "2", notes = "参见 UserTypeEnum 枚举")
@Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2")
@JsonProperty("user_type")
private Integer userType;
@Schema(description = "租户编号", required = true, example = "1024")
@@ -34,7 +34,7 @@ public class OAuth2OpenCheckTokenRespVO {
@JsonProperty("access_token")
private String accessToken;
@Schema(description = "过期时间", required = true, example = "1593092157", notes = "时间戳 / 1000，即单位：秒")
@Schema(description = "过期时间,时间戳 / 1000，即单位：秒", required = true, example = "1593092157")
private Long exp;
}

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/token/OAuth2AccessTokenPageReqVO.java
View File

@@ -14,7 +14,7 @@ public class OAuth2AccessTokenPageReqVO extends PageParam {
@Schema(description = "用户编号", required = true, example = "666")
private Long userId;
@Schema(description = "用户类型", required = true, example = "2", notes = "参见 UserTypeEnum 枚举")
@Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2")
private Integer userType;
@Schema(description = "客户端编号", required = true, example = "2")

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/token/OAuth2AccessTokenRespVO.java
View File

@@ -26,7 +26,7 @@ public class OAuth2AccessTokenRespVO {
@Schema(description = "用户编号", required = true, example = "666")
private Long userId;
@Schema(description = "用户类型", required = true, example = "2", notes = "参见 UserTypeEnum 枚举")
@Schema(description = "用户类型,参见 UserTypeEnum 枚举", required = true, example = "2")
private Integer userType;
@Schema(description = "客户端编号", required = true, example = "2")

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/user/OAuth2UserInfoRespVO.java
View File

@@ -28,7 +28,7 @@ public class OAuth2UserInfoRespVO {
@Schema(description = "手机号码", example = "15601691300")
private String mobile;
@Schema(description = "用户性别", example = "1", notes = "参见 SexEnum 枚举类")
@Schema(description = "用户性别,参见 SexEnum 枚举类", example = "1")
private Integer sex;
@Schema(description = "用户头像", example = "https://www.iocoder.cn/xxx.png")

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/oauth2/vo/user/OAuth2UserUpdateReqVO.java
View File

@@ -29,7 +29,7 @@ public class OAuth2UserUpdateReqVO {
@Length(min = 11, max = 11, message = "手机号长度必须 11 位")
private String mobile;
@Schema(description = "用户性别", example = "1", notes = "参见 SexEnum 枚举类")
@Schema(description = "用户性别,参见 SexEnum 枚举类", example = "1")
private Integer sex;
}

12
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuBaseVO.java
View File

@@ -19,11 +19,11 @@ public class MenuBaseVO {
@Size(max = 50, message = "菜单名称长度不能超过50个字符")
private String name;
@Schema(description = "权限标识", example = "sys:menu:add", notes = "仅菜单类型为按钮时，才需要传递")
@Schema(description = "权限标识,仅菜单类型为按钮时，才需要传递", example = "sys:menu:add")
@Size(max = 100)
private String permission;
@Schema(description = "类型", required = true, example = "1", notes = "参见 MenuTypeEnum 枚举类")
@Schema(description = "类型,参见 MenuTypeEnum 枚举类", required = true, example = "1")
@NotNull(message = "菜单类型不能为空")
private Integer type;
@@ -35,18 +35,18 @@ public class MenuBaseVO {
@NotNull(message = "父菜单 ID 不能为空")
private Long parentId;
@Schema(description = "路由地址", example = "post", notes = "仅菜单类型为菜单或者目录时，才需要传")
@Schema(description = "路由地址,仅菜单类型为菜单或者目录时，才需要传", example = "post")
@Size(max = 200, message = "路由地址不能超过200个字符")
private String path;
@Schema(description = "菜单图标", example = "/menu/list", notes = "仅菜单类型为菜单或者目录时，才需要传")
@Schema(description = "菜单图标,仅菜单类型为菜单或者目录时，才需要传", example = "/menu/list")
private String icon;
@Schema(description = "组件路径", example = "system/post/index", notes = "仅菜单类型为菜单时，才需要传")
@Schema(description = "组件路径,仅菜单类型为菜单时，才需要传", example = "system/post/index")
@Size(max = 200, message = "组件路径不能超过255个字符")
private String component;
@Schema(description = "状态", required = true, example = "1", notes = "见 CommonStatusEnum 枚举")
@Schema(description = "状态,见 CommonStatusEnum 枚举", required = true, example = "1")
@NotNull(message = "状态不能为空")
private Integer status;

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuCreateReqVO.java
View File

@@ -1,9 +1,9 @@
package cn.iocoder.yudao.module.system.controller.admin.permission.vo.menu;
import io.swagger.annotations.ApiModel;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
@ApiModel("管理后台 - 菜单创建 Request VO")
@Schema(description = "管理后台 - 菜单创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
public class MenuCreateReqVO extends MenuBaseVO {

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuListReqVO.java
View File

@@ -8,10 +8,10 @@ import lombok.Data;
@Data
public class MenuListReqVO {
@Schema(description = "菜单名称", example = "芋道", notes = "模糊匹配")
@Schema(description = "菜单名称，模糊匹配", example = "芋道")
private String name;
@Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态，参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
}

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuRespVO.java
View File

@@ -19,7 +19,7 @@ public class MenuRespVO extends MenuBaseVO {
@Schema(description = "菜单编号", required = true, example = "1024")
private Long id;
@Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态，参见 CommonStatusEnum 枚举类", required = true, example = "1")
private Integer status;
@Schema(description = "创建时间", required = true, example = "时间戳格式")

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/menu/MenuSimpleRespVO.java
View File

@@ -23,7 +23,7 @@ public class MenuSimpleRespVO {
@Schema(description = "父菜单 ID", required = true, example = "1024")
private Long parentId;
@Schema(description = "类型", required = true, example = "1", notes = "参见 MenuTypeEnum 枚举类")
@Schema(description = "类型，参见 MenuTypeEnum 枚举类", required = true, example = "1")
private Integer type;
}

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/permission/PermissionAssignRoleDataScopeReqVO.java
View File

@@ -16,12 +16,12 @@ public class PermissionAssignRoleDataScopeReqVO {
@NotNull(message = "角色编号不能为空")
private Long roleId;
@Schema(description = "数据范围", required = true, example = "1", notes = "参见 DataScopeEnum 枚举类")
@Schema(description = "数据范围，参见 DataScopeEnum 枚举类", required = true, example = "1")
@NotNull(message = "数据范围不能为空")
// TODO 这里要多一个枚举校验
private Integer dataScope;
@Schema(description = "部门编号列表", example = "1,3,5", notes = "只有范围类型为 DEPT_CUSTOM 时，该字段才需要")
@Schema(description = "部门编号列表，只有范围类型为 DEPT_CUSTOM 时，该字段才需要", example = "1,3,5")
private Set<Long> dataScopeDeptIds = Collections.emptySet(); // 兜底
}

6
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleExportReqVO.java
View File

@@ -13,13 +13,13 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_
@Data
public class RoleExportReqVO {
@Schema(description = "角色名称", example = "芋道", notes = "模糊匹配")
@Schema(description = "角色名称，模糊匹配", example = "芋道")
private String name;
@Schema(description = "角色标识", example = "yudao", notes = "模糊匹配")
@Schema(description = "角色标识，模糊匹配", example = "yudao")
private String code;
@Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态，参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
@Schema(description = "开始时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]")

6
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RolePageReqVO.java
View File

@@ -16,13 +16,13 @@ import static cn.iocoder.yudao.framework.common.util.date.DateUtils.FORMAT_YEAR_
@EqualsAndHashCode(callSuper = true)
public class RolePageReqVO extends PageParam {
@Schema(description = "角色名称", example = "芋道", notes = "模糊匹配")
@Schema(description = "角色名称，模糊匹配", example = "芋道")
private String name;
@Schema(description = "角色标识", example = "yudao", notes = "模糊匹配")
@Schema(description = "角色标识，模糊匹配", example = "yudao")
private String code;
@Schema(description = "展示状态", example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "展示状态，参见 CommonStatusEnum 枚举类", example = "1")
private Integer status;
@Schema(description = "开始时间", example = "[2022-07-01 00:00:00,2022-07-01 23:59:59]")

6
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleRespVO.java
View File

@@ -20,16 +20,16 @@ public class RoleRespVO extends RoleBaseVO {
@Schema(description = "角色编号", required = true, example = "1")
private Long id;
@Schema(description = "数据范围", required = true, example = "1", notes = "参见 DataScopeEnum 枚举类")
@Schema(description = "数据范围，参见 DataScopeEnum 枚举类", required = true, example = "1")
private Integer dataScope;
@Schema(description = "数据范围(指定部门数组)", example = "1")
private Set<Long> dataScopeDeptIds;
@Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态，参见 CommonStatusEnum 枚举类", required = true, example = "1")
private Integer status;
@Schema(description = "角色类型", required = true, example = "1", notes = "参见 RoleTypeEnum 枚举类")
@Schema(description = "角色类型，参见 RoleTypeEnum 枚举类", required = true, example = "1")
private Integer type;
@Schema(description = "创建时间", required = true, example = "时间戳格式")

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/permission/vo/role/RoleUpdateStatusReqVO.java
View File

@@ -14,7 +14,7 @@ public class RoleUpdateStatusReqVO {
@NotNull(message = "角色编号不能为空")
private Long id;
@Schema(description = "状态", required = true, example = "1", notes = "见 CommonStatusEnum 枚举")
@Schema(description = "状态，见 CommonStatusEnum 枚举", required = true, example = "1")
@NotNull(message = "状态不能为空")
// @InEnum(value = CommonStatusEnum.class, message = "修改状态必须是 {value}")
private Integer status;

8
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordBaseVO.java
View File

@@ -7,9 +7,9 @@ import javax.validation.constraints.NotNull;
import java.util.List;
/**
* 敏感词 Base VO，提供给添加、修改、详细的子 VO 使用
* 如果子 VO 存在差异的字段，请不要添加到这里，影响 Swagger 文档生成
*/
* 敏感词 Base VO，提供给添加、修改、详细的子 VO 使用
* 如果子 VO 存在差异的字段，请不要添加到这里，影响 Swagger 文档生成
*/
@Data
public class SensitiveWordBaseVO {
@@ -21,7 +21,7 @@ public class SensitiveWordBaseVO {
@NotNull(message = "标签不能为空")
private List<String> tags;
@Schema(description = "状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "状态,参见 CommonStatusEnum 枚举类", required = true, example = "1")
@NotNull(message = "状态不能为空")
private Integer status;

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sensitiveword/vo/SensitiveWordCreateReqVO.java
View File

@@ -1,11 +1,11 @@
package cn.iocoder.yudao.module.system.controller.admin.sensitiveword.vo;
import io.swagger.annotations.ApiModel;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@ApiModel("管理后台 - 敏感词创建 Request VO")
@Schema(description = "管理后台 - 敏感词创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelCreateReqVO.java
View File

@@ -14,7 +14,7 @@ import javax.validation.constraints.NotNull;
@ToString(callSuper = true)
public class SmsChannelCreateReqVO extends SmsChannelBaseVO {
@Schema(description = "渠道编码", required = true, example = "YUN_PIAN", notes = "参见 SmsChannelEnum 枚举类")
@Schema(description = "渠道编码,参见 SmsChannelEnum 枚举类", required = true, example = "YUN_PIAN" )
@NotNull(message = "渠道编码不能为空")
private String code;

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelPageReqVO.java
View File

@@ -21,7 +21,7 @@ public class SmsChannelPageReqVO extends PageParam {
@Schema(description = "任务状态", example = "1")
private Integer status;
@Schema(description = "短信签名", example = "芋道源码", notes = "模糊匹配")
@Schema(description = "短信签名，模糊匹配", example = "芋道源码" )
private String signature;
@DateTimeFormat(pattern = FORMAT_YEAR_MONTH_DAY_HOUR_MINUTE_SECOND)

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelRespVO.java
View File

@@ -17,7 +17,7 @@ public class SmsChannelRespVO extends SmsChannelBaseVO {
@Schema(description = "编号", required = true, example = "1024")
private Long id;
@Schema(description = "渠道编码", required = true, example = "YUN_PIAN", notes = "参见 SmsChannelEnum 枚举类")
@Schema(description = "渠道编码，参见 SmsChannelEnum 枚举类", required = true, example = "YUN_PIAN" )
private String code;
@Schema(description = "创建时间", required = true)

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/channel/SmsChannelSimpleRespVO.java
View File

@@ -18,7 +18,7 @@ public class SmsChannelSimpleRespVO {
@NotNull(message = "短信签名不能为空")
private String signature;
@Schema(description = "渠道编码", required = true, example = "YUN_PIAN", notes = "参见 SmsChannelEnum 枚举类")
@Schema(description = "渠道编码，参见 SmsChannelEnum 枚举类", required = true, example = "YUN_PIAN" )
private String code;
}

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateBaseVO.java
View File

@@ -12,11 +12,11 @@ import javax.validation.constraints.NotNull;
@Data
public class SmsTemplateBaseVO {
@Schema(description = "短信类型", required = true, example = "1", notes = "参见 SmsTemplateTypeEnum 枚举类")
@Schema(description = "短信类型，参见 SmsTemplateTypeEnum 枚举类", required = true, example = "1" )
@NotNull(message = "短信类型不能为空")
private Integer type;
@Schema(description = "开启状态", required = true, example = "1", notes = "参见 CommonStatusEnum 枚举类")
@Schema(description = "开启状态，参见 CommonStatusEnum 枚举类", required = true, example = "1" )
@NotNull(message = "开启状态不能为空")
private Integer status;

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/sms/vo/template/SmsTemplateCreateReqVO.java
View File

@@ -1,11 +1,11 @@
package cn.iocoder.yudao.module.system.controller.admin.sms.vo.template;
import io.swagger.annotations.ApiModel;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@ApiModel("管理后台 - 短信模板创建 Request VO")
@Schema(description = "管理后台 - 短信模板创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/socail/vo/SocialUserBindReqVO.java
View File

@@ -19,7 +19,7 @@ import javax.validation.constraints.NotNull;
@Builder
public class SocialUserBindReqVO {
@Schema(description = "社交平台的类型", required = true, example = "10", notes = "参见 UserSocialTypeEnum 枚举值")
@Schema(description = "社交平台的类型,参见 UserSocialTypeEnum 枚举值", required = true, example = "10" )
@InEnum(SocialTypeEnum.class)
@NotNull(message = "社交平台的类型不能为空")
private Integer type;

4
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageCreateReqVO.java
View File

@@ -1,11 +1,11 @@
package cn.iocoder.yudao.module.system.controller.admin.tenant.vo.packages;
import io.swagger.annotations.ApiModel;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@ApiModel("管理后台 - 租户套餐创建 Request VO")
@Schema(description = "管理后台 - 租户套餐创建 Request VO")
@Data
@EqualsAndHashCode(callSuper = true)
@ToString(callSuper = true)

3
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/tenant/vo/packages/TenantPackageUpdateReqVO.java
View File

@@ -1,8 +1,7 @@
package cn.iocoder.yudao.module.system.controller.admin.tenant.vo.packages;
import io.swagger.v3.oas.annotations.media.Schema;
import lombok.*;
import java.util.*;
import io.swagger.annotations.*;
import javax.validation.constraints.*;
@Schema(description = "管理后台 - 租户套餐更新 Request VO")

2
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/vo/user/UserBaseVO.java
View File

@@ -45,7 +45,7 @@ public class UserBaseVO {
@Mobile
private String mobile;
@Schema(description = "用户性别", example = "1", notes = "参见 SexEnum 枚举类")
@Schema(description = "用户性别，参见 SexEnum 枚举类", example = "1")
private Integer sex;
@Schema(description = "用户头像", example = "https://www.iocoder.cn/xxx.png")