From 96291da02a59f370093a58046f985c587e2512ec Mon Sep 17 00:00:00 2001 From: fit2cloud-chenyw Date: Mon, 23 Aug 2021 11:33:07 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E5=AE=8C=E5=96=84apiModelProperties?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../dataease/auth/api/dto/CurrentRoleDto.java | 4 ++- .../dataease/auth/api/dto/DynamicMenuDto.java | 28 +++++++++-------- .../io/dataease/auth/api/dto/MenuMeta.java | 5 ++-- .../io/dataease/base/domain/ChartGroup.java | 15 ++++++---- .../io/dataease/base/domain/ChartView.java | 21 +++++++------ .../base/domain/ChartViewWithBLOBs.java | 19 +++++++----- .../io/dataease/base/domain/DatasetGroup.java | 15 ++++++---- .../io/dataease/base/domain/DatasetTable.java | 25 +++++++++------- .../base/domain/DatasetTableField.java | 30 ++++++++++--------- .../base/domain/DatasetTableFunction.java | 13 ++++---- .../domain/DatasetTableIncrementalConfig.java | 9 ++++-- .../base/domain/DatasetTableTask.java | 29 ++++++++++-------- .../base/domain/DatasetTableTaskLog.java | 19 +++++++----- .../base/domain/DatasetTableUnion.java | 19 +++++++----- .../io/dataease/base/domain/Datasource.java | 19 +++++++----- .../io/dataease/base/domain/PanelGroup.java | 25 +++++++++------- .../base/domain/PanelGroupWithBLOBs.java | 5 +++- .../io/dataease/base/domain/PanelShare.java | 11 ++++--- .../io/dataease/base/domain/PanelSubject.java | 17 ++++++----- .../dataease/base/domain/PanelTemplate.java | 17 ++++++----- .../base/domain/PanelTemplateWithBLOBs.java | 9 ++++-- .../base/domain/PanelViewLinkage.java | 17 ++++++----- .../base/domain/PanelViewLinkageField.java | 11 ++++--- .../java/io/dataease/base/domain/SysMsg.java | 17 ++++++----- .../java/io/dataease/base/domain/SysRole.java | 15 ++++++---- .../io/dataease/commons/model/AuthURD.java | 4 +++ .../java/io/dataease/commons/utils/Pager.java | 5 ++++ .../dataease/controller/IndexController.java | 3 +- .../io/dataease/controller/ResultHolder.java | 2 ++ .../request/chart/ChartDrillRequest.java | 2 ++ .../request/chart/ChartExtFilterRequest.java | 7 +++++ .../request/chart/ChartExtRequest.java | 5 ++++ .../request/chart/ChartGroupRequest.java | 4 +++ .../request/dataset/DataSetGroupRequest.java | 6 ++-- .../request/dataset/DataSetTableRequest.java | 12 ++++++++ .../request/dataset/DataSetTaskRequest.java | 3 ++ .../request/panel/PanelGroupRequest.java | 6 ++-- .../request/panel/PanelLinkageRequest.java | 8 +++-- .../request/panel/PanelShareFineDto.java | 5 ++-- .../request/panel/PanelTemplateRequest.java | 8 +++-- .../request/panel/link/EnablePwdRequest.java | 4 ++- .../request/panel/link/LinkRequest.java | 5 ++-- .../request/panel/link/PasswordRequest.java | 4 ++- .../controller/sys/response/MsgGridDto.java | 3 ++ .../controller/sys/response/RoleUserItem.java | 4 ++- .../controller/sys/response/SysUserDept.java | 7 +++-- .../sys/response/SysUserGridResponse.java | 8 +++-- .../controller/sys/response/SysUserRole.java | 5 ++-- .../dataease/datasource/dto/DBTableDTO.java | 5 ++++ .../dataease/datasource/dto/TableFiled.java | 6 +++- .../java/io/dataease/dto/DatasourceDTO.java | 2 ++ .../io/dataease/dto/PanelViewLinkageDTO.java | 10 ++++--- .../dataease/dto/chart/ChartDimensionDTO.java | 3 ++ .../io/dataease/dto/chart/ChartGroupDTO.java | 6 ++-- .../io/dataease/dto/chart/ChartViewDTO.java | 12 +++++--- .../dataease/dto/dataset/DataSetGroupDTO.java | 5 +++- .../dataease/dto/dataset/DataSetTableDTO.java | 6 +++- .../dto/dataset/DataSetTableUnionDTO.java | 5 ++++ .../dataease/dto/dataset/DataSetTaskDTO.java | 6 ++++ .../dto/dataset/DataSetTaskLogDTO.java | 3 ++ .../dataease/dto/dataset/ExcelFileData.java | 6 ++++ .../dataease/dto/dataset/ExcelSheetData.java | 11 +++++++ .../io/dataease/dto/panel/PanelGroupDTO.java | 17 ++++++----- .../dataease/dto/panel/PanelTemplateDTO.java | 6 ++-- .../io/dataease/dto/panel/PanelViewDto.java | 11 +++---- .../dataease/dto/panel/link/GenerateDto.java | 8 +++-- .../dataease/dto/panel/link/ValidateDto.java | 8 +++-- 67 files changed, 438 insertions(+), 232 deletions(-) diff --git a/backend/src/main/java/io/dataease/auth/api/dto/CurrentRoleDto.java b/backend/src/main/java/io/dataease/auth/api/dto/CurrentRoleDto.java index 9b72125543..65660c51d5 100644 --- a/backend/src/main/java/io/dataease/auth/api/dto/CurrentRoleDto.java +++ b/backend/src/main/java/io/dataease/auth/api/dto/CurrentRoleDto.java @@ -1,5 +1,6 @@ package io.dataease.auth.api.dto; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -7,9 +8,10 @@ import java.io.Serializable; @Data public class CurrentRoleDto implements Serializable { + @ApiModelProperty("ID") private Long id; // private String code; - + @ApiModelProperty("名称") private String name; } diff --git a/backend/src/main/java/io/dataease/auth/api/dto/DynamicMenuDto.java b/backend/src/main/java/io/dataease/auth/api/dto/DynamicMenuDto.java index f4875ea80c..0bb5b9b86a 100644 --- a/backend/src/main/java/io/dataease/auth/api/dto/DynamicMenuDto.java +++ b/backend/src/main/java/io/dataease/auth/api/dto/DynamicMenuDto.java @@ -1,5 +1,6 @@ package io.dataease.auth.api.dto; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @@ -9,32 +10,33 @@ import java.util.List; @Data public class DynamicMenuDto implements Serializable { + @ApiModelProperty("路径") private String path; - + @ApiModelProperty("组件") private String component; - + @ApiModelProperty("重定向") private String redirect; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("元数据") private MenuMeta meta; - + @ApiModelProperty("父ID") private Long pid; - + @ApiModelProperty("ID") private Long id; - + @ApiModelProperty("权限") private String permission; - + @ApiModelProperty("是否隐藏") private Boolean hidden; - + @ApiModelProperty("类型") private Integer type; - + @ApiModelProperty("菜单序号") private Integer menuSort; - + @ApiModelProperty("是否插件") private Boolean isPlugin; - + @ApiModelProperty(hidden = true) private Boolean noLayout; - + @ApiModelProperty("子节点") private List children; } diff --git a/backend/src/main/java/io/dataease/auth/api/dto/MenuMeta.java b/backend/src/main/java/io/dataease/auth/api/dto/MenuMeta.java index eefe8f2849..7fea56384f 100644 --- a/backend/src/main/java/io/dataease/auth/api/dto/MenuMeta.java +++ b/backend/src/main/java/io/dataease/auth/api/dto/MenuMeta.java @@ -1,14 +1,15 @@ package io.dataease.auth.api.dto; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @Data public class MenuMeta implements Serializable { - + @ApiModelProperty("标题") private String title; - + @ApiModelProperty("图标") private String icon; } diff --git a/backend/src/main/java/io/dataease/base/domain/ChartGroup.java b/backend/src/main/java/io/dataease/base/domain/ChartGroup.java index 4d2128a4b6..0e11ff2d76 100644 --- a/backend/src/main/java/io/dataease/base/domain/ChartGroup.java +++ b/backend/src/main/java/io/dataease/base/domain/ChartGroup.java @@ -1,22 +1,25 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class ChartGroup implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("父ID") private String pid; - + @ApiModelProperty("级别") private Integer level; - + @ApiModelProperty("类型") private String type; - + @ApiModelProperty("创建者") private String createBy; - + @ApiModelProperty("创建时间") private Long createTime; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/ChartView.java b/backend/src/main/java/io/dataease/base/domain/ChartView.java index f8e662c1d5..2bb2de365e 100644 --- a/backend/src/main/java/io/dataease/base/domain/ChartView.java +++ b/backend/src/main/java/io/dataease/base/domain/ChartView.java @@ -1,28 +1,31 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class ChartView implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("场景ID") private String sceneId; - + @ApiModelProperty("表ID") private String tableId; - + @ApiModelProperty("类型") private String type; - + @ApiModelProperty("标题") private String title; - + @ApiModelProperty("创建者") private String createBy; - + @ApiModelProperty("创建时间") private Long createTime; - + @ApiModelProperty("更新时间") private Long updateTime; - + @ApiModelProperty("样式优先级") private String stylePriority; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/ChartViewWithBLOBs.java b/backend/src/main/java/io/dataease/base/domain/ChartViewWithBLOBs.java index 78322fe558..5ac886681d 100644 --- a/backend/src/main/java/io/dataease/base/domain/ChartViewWithBLOBs.java +++ b/backend/src/main/java/io/dataease/base/domain/ChartViewWithBLOBs.java @@ -1,6 +1,8 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; @@ -9,22 +11,23 @@ import lombok.ToString; @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class ChartViewWithBLOBs extends ChartView implements Serializable { + @ApiModelProperty("x轴") private String xAxis; - + @ApiModelProperty("y轴") private String yAxis; - + @ApiModelProperty("堆叠") private String extStack; - + @ApiModelProperty("气泡") private String extBubble; - + @ApiModelProperty("客户端属性") private String customAttr; - + @ApiModelProperty("客户端样式") private String customStyle; - + @ApiModelProperty("客户端过滤条件") private String customFilter; - + @ApiModelProperty("下钻字段") private String drillFields; - + @ApiModelProperty("快照") private String snapshot; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/DatasetGroup.java b/backend/src/main/java/io/dataease/base/domain/DatasetGroup.java index f5f562e962..ebc60cf316 100644 --- a/backend/src/main/java/io/dataease/base/domain/DatasetGroup.java +++ b/backend/src/main/java/io/dataease/base/domain/DatasetGroup.java @@ -1,22 +1,25 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class DatasetGroup implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("父ID") private String pid; - + @ApiModelProperty("级别") private Integer level; - + @ApiModelProperty("类型") private String type; - + @ApiModelProperty("创建者") private String createBy; - + @ApiModelProperty("创建时间") private Long createTime; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/DatasetTable.java b/backend/src/main/java/io/dataease/base/domain/DatasetTable.java index c45f77a26e..e2ad34e624 100644 --- a/backend/src/main/java/io/dataease/base/domain/DatasetTable.java +++ b/backend/src/main/java/io/dataease/base/domain/DatasetTable.java @@ -1,32 +1,35 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class DatasetTable implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("场景ID") private String sceneId; - + @ApiModelProperty("数据源ID") private String dataSourceId; - + @ApiModelProperty("类型") private String type; - + @ApiModelProperty("模式") private Integer mode; - + @ApiModelProperty("创建者") private String createBy; - + @ApiModelProperty("创建时间") private Long createTime; - + @ApiModelProperty("定时任务实例") private String qrtzInstance; - + @ApiModelProperty("同步状态") private String syncStatus; - + @ApiModelProperty("上次更新时间") private Long lastUpdateTime; - + @ApiModelProperty("信息") private String info; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/DatasetTableField.java b/backend/src/main/java/io/dataease/base/domain/DatasetTableField.java index 41b807625e..b193215456 100644 --- a/backend/src/main/java/io/dataease/base/domain/DatasetTableField.java +++ b/backend/src/main/java/io/dataease/base/domain/DatasetTableField.java @@ -2,6 +2,7 @@ package io.dataease.base.domain; import java.io.Serializable; +import io.swagger.annotations.ApiModelProperty; import lombok.AllArgsConstructor; import lombok.Builder; import lombok.Data; @@ -12,34 +13,35 @@ import lombok.NoArgsConstructor; @AllArgsConstructor //全参构造函数 @NoArgsConstructor //无参构造函数 public class DatasetTableField implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("表ID") private String tableId; - + @ApiModelProperty("原始名称") private String originName; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("DE名称") private String dataeaseName; - + @ApiModelProperty("分组类型") private String groupType; - + @ApiModelProperty("类型") private String type; - + @ApiModelProperty("大小") private Integer size; - + @ApiModelProperty("de类型") private Integer deType; - + @ApiModelProperty("de类型格式") private Integer deTypeFormat; - + @ApiModelProperty("de抽取类型") private Integer deExtractType; - + @ApiModelProperty("额外字段") private Integer extField; - + @ApiModelProperty("是否选中") private Boolean checked; - + @ApiModelProperty("列号") private Integer columnIndex; - + @ApiModelProperty("上次同步时间") private Long lastSyncTime; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/DatasetTableFunction.java b/backend/src/main/java/io/dataease/base/domain/DatasetTableFunction.java index b6232a6fa0..dc2c4191c9 100644 --- a/backend/src/main/java/io/dataease/base/domain/DatasetTableFunction.java +++ b/backend/src/main/java/io/dataease/base/domain/DatasetTableFunction.java @@ -1,20 +1,23 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class DatasetTableFunction implements Serializable { + @ApiModelProperty("ID") private Long id; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("函数") private String func; - + @ApiModelProperty("库类型") private String dbType; - + @ApiModelProperty("函数类型") private Integer funcType; - + @ApiModelProperty("描述") private String desc; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/DatasetTableIncrementalConfig.java b/backend/src/main/java/io/dataease/base/domain/DatasetTableIncrementalConfig.java index 33b94f2d03..c664db40f2 100644 --- a/backend/src/main/java/io/dataease/base/domain/DatasetTableIncrementalConfig.java +++ b/backend/src/main/java/io/dataease/base/domain/DatasetTableIncrementalConfig.java @@ -1,16 +1,19 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class DatasetTableIncrementalConfig implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("表ID") private String tableId; - + @ApiModelProperty("删除增量") private String incrementalDelete; - + @ApiModelProperty("新增增量") private String incrementalAdd; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/DatasetTableTask.java b/backend/src/main/java/io/dataease/base/domain/DatasetTableTask.java index 7573fe5fb1..e7878c342c 100644 --- a/backend/src/main/java/io/dataease/base/domain/DatasetTableTask.java +++ b/backend/src/main/java/io/dataease/base/domain/DatasetTableTask.java @@ -1,36 +1,39 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class DatasetTableTask implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("表ID") private String tableId; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("类型") private String type; - + @ApiModelProperty("开始时间") private Long startTime; - + @ApiModelProperty("频率") private String rate; - + @ApiModelProperty("表达式") private String cron; - + @ApiModelProperty("结束") private String end; - + @ApiModelProperty("结束时间") private Long endTime; - + @ApiModelProperty("创建时间") private Long createTime; - + @ApiModelProperty("上次执行时间") private Long lastExecTime; - + @ApiModelProperty("状态") private String status; - + @ApiModelProperty("上次执行状态") private String lastExecStatus; - + @ApiModelProperty("抽取数据") private String extraData; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/DatasetTableTaskLog.java b/backend/src/main/java/io/dataease/base/domain/DatasetTableTaskLog.java index 3c5040feac..363499b241 100644 --- a/backend/src/main/java/io/dataease/base/domain/DatasetTableTaskLog.java +++ b/backend/src/main/java/io/dataease/base/domain/DatasetTableTaskLog.java @@ -1,26 +1,29 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class DatasetTableTaskLog implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("表ID") private String tableId; - + @ApiModelProperty("任务ID") private String taskId; - + @ApiModelProperty("开始时间") private Long startTime; - + @ApiModelProperty("结束时间") private Long endTime; - + @ApiModelProperty("状态") private String status; - + @ApiModelProperty("创建时间") private Long createTime; - + @ApiModelProperty("触发类型") private String triggerType; - + @ApiModelProperty("信息") private String info; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/DatasetTableUnion.java b/backend/src/main/java/io/dataease/base/domain/DatasetTableUnion.java index 18b7dda831..15817f6a83 100644 --- a/backend/src/main/java/io/dataease/base/domain/DatasetTableUnion.java +++ b/backend/src/main/java/io/dataease/base/domain/DatasetTableUnion.java @@ -1,26 +1,29 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class DatasetTableUnion implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("源表ID") private String sourceTableId; - + @ApiModelProperty("源表字段ID") private String sourceTableFieldId; - + @ApiModelProperty("源合并关系") private String sourceUnionRelation; - + @ApiModelProperty("目标字段ID") private String targetTableId; - + @ApiModelProperty("目标表字段ID") private String targetTableFieldId; - + @ApiModelProperty("目标合并关系") private String targetUnionRelation; - + @ApiModelProperty("创建者") private String createBy; - + @ApiModelProperty("创建时间") private Long createTime; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/Datasource.java b/backend/src/main/java/io/dataease/base/domain/Datasource.java index 37dfeefa85..86b2bca643 100644 --- a/backend/src/main/java/io/dataease/base/domain/Datasource.java +++ b/backend/src/main/java/io/dataease/base/domain/Datasource.java @@ -1,26 +1,29 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class Datasource implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("描述") private String desc; - + @ApiModelProperty("类型") private String type; - + @ApiModelProperty("创建时间") private Long createTime; - + @ApiModelProperty("更新时间") private Long updateTime; - + @ApiModelProperty("创建者") private String createBy; - + @ApiModelProperty("状态") private String status; - + @ApiModelProperty("配置") private String configuration; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/PanelGroup.java b/backend/src/main/java/io/dataease/base/domain/PanelGroup.java index f93131545f..db49938b5b 100644 --- a/backend/src/main/java/io/dataease/base/domain/PanelGroup.java +++ b/backend/src/main/java/io/dataease/base/domain/PanelGroup.java @@ -1,32 +1,35 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class PanelGroup implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("父ID") private String pid; - + @ApiModelProperty("级别") private Integer level; - + @ApiModelProperty("节点类型") private String nodeType; - + @ApiModelProperty("创建者") private String createBy; - + @ApiModelProperty("创建时间") private Long createTime; - + @ApiModelProperty("类型") private String panelType; - + @ApiModelProperty("源") private String source; - + @ApiModelProperty("拓展1") private String extend1; - + @ApiModelProperty("拓展2") private String extend2; - + @ApiModelProperty("重新标记") private String remark; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/PanelGroupWithBLOBs.java b/backend/src/main/java/io/dataease/base/domain/PanelGroupWithBLOBs.java index 7486de8f04..b697bc31ac 100644 --- a/backend/src/main/java/io/dataease/base/domain/PanelGroupWithBLOBs.java +++ b/backend/src/main/java/io/dataease/base/domain/PanelGroupWithBLOBs.java @@ -1,6 +1,8 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; @@ -9,8 +11,9 @@ import lombok.ToString; @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PanelGroupWithBLOBs extends PanelGroup implements Serializable { + @ApiModelProperty("仪表板样式") private String panelStyle; - + @ApiModelProperty("仪表板数据") private String panelData; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/PanelShare.java b/backend/src/main/java/io/dataease/base/domain/PanelShare.java index ab0c0bfe11..cabda76eb8 100644 --- a/backend/src/main/java/io/dataease/base/domain/PanelShare.java +++ b/backend/src/main/java/io/dataease/base/domain/PanelShare.java @@ -1,18 +1,21 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class PanelShare implements Serializable { + @ApiModelProperty("分享ID") private Long shareId; - + @ApiModelProperty("仪表板ID") private String panelGroupId; - + @ApiModelProperty("目标ID") private Long targetId; - + @ApiModelProperty("分享时间") private Long createTime; - + @ApiModelProperty("类型") private Integer type; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/PanelSubject.java b/backend/src/main/java/io/dataease/base/domain/PanelSubject.java index f8fdf47b36..7926c32f7a 100644 --- a/backend/src/main/java/io/dataease/base/domain/PanelSubject.java +++ b/backend/src/main/java/io/dataease/base/domain/PanelSubject.java @@ -1,24 +1,27 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class PanelSubject implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("类型") private String type; - + @ApiModelProperty("创建时间") private Long createTime; - + @ApiModelProperty("创建者") private String createBy; - + @ApiModelProperty("更新时间") private Long updateTime; - + @ApiModelProperty("更新者") private String updateBy; - + @ApiModelProperty("详息") private String details; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/PanelTemplate.java b/backend/src/main/java/io/dataease/base/domain/PanelTemplate.java index d85483d876..2834715e37 100644 --- a/backend/src/main/java/io/dataease/base/domain/PanelTemplate.java +++ b/backend/src/main/java/io/dataease/base/domain/PanelTemplate.java @@ -1,24 +1,27 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class PanelTemplate implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("父ID") private String pid; - + @ApiModelProperty("级别") private Integer level; - + @ApiModelProperty("节点类型") private String nodeType; - + @ApiModelProperty("创建者") private String createBy; - + @ApiModelProperty("创建时间") private Long createTime; - + @ApiModelProperty("模版类型") private String templateType; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/PanelTemplateWithBLOBs.java b/backend/src/main/java/io/dataease/base/domain/PanelTemplateWithBLOBs.java index b046dab87e..a776c56c7b 100644 --- a/backend/src/main/java/io/dataease/base/domain/PanelTemplateWithBLOBs.java +++ b/backend/src/main/java/io/dataease/base/domain/PanelTemplateWithBLOBs.java @@ -1,6 +1,8 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.ToString; @@ -9,12 +11,13 @@ import lombok.ToString; @EqualsAndHashCode(callSuper = true) @ToString(callSuper = true) public class PanelTemplateWithBLOBs extends PanelTemplate implements Serializable { + @ApiModelProperty("快照") private String snapshot; - + @ApiModelProperty("模版样式") private String templateStyle; - + @ApiModelProperty("模版数据") private String templateData; - + @ApiModelProperty("动态数据") private String dynamicData; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/PanelViewLinkage.java b/backend/src/main/java/io/dataease/base/domain/PanelViewLinkage.java index 67c6853dac..903863b7ee 100644 --- a/backend/src/main/java/io/dataease/base/domain/PanelViewLinkage.java +++ b/backend/src/main/java/io/dataease/base/domain/PanelViewLinkage.java @@ -1,24 +1,27 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class PanelViewLinkage implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("仪表板ID") private String panelId; - + @ApiModelProperty("源视图ID") private String sourceViewId; - + @ApiModelProperty("目标视图ID") private String targetViewId; - + @ApiModelProperty("更新时间") private Long updateTime; - + @ApiModelProperty("更新者") private String updatePeople; - + @ApiModelProperty("额外1") private String ext1; - + @ApiModelProperty("额外2") private String ext2; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/PanelViewLinkageField.java b/backend/src/main/java/io/dataease/base/domain/PanelViewLinkageField.java index eb9a0ec102..112d699427 100644 --- a/backend/src/main/java/io/dataease/base/domain/PanelViewLinkageField.java +++ b/backend/src/main/java/io/dataease/base/domain/PanelViewLinkageField.java @@ -1,18 +1,21 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class PanelViewLinkageField implements Serializable { + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("联动ID") private String linkageId; - + @ApiModelProperty("源字段") private String sourceField; - + @ApiModelProperty("目标字段") private String targetField; - + @ApiModelProperty("更新时间") private Long updateTime; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/SysMsg.java b/backend/src/main/java/io/dataease/base/domain/SysMsg.java index b9759f2f1a..9a80170bba 100644 --- a/backend/src/main/java/io/dataease/base/domain/SysMsg.java +++ b/backend/src/main/java/io/dataease/base/domain/SysMsg.java @@ -1,24 +1,27 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class SysMsg implements Serializable { + @ApiModelProperty("消息ID") private Long msgId; - + @ApiModelProperty("用户ID") private Long userId; - + @ApiModelProperty("类型ID") private Long typeId; - + @ApiModelProperty("状态") private Boolean status; - + @ApiModelProperty("参数") private String param; - + @ApiModelProperty("创建时间") private Long createTime; - + @ApiModelProperty("读取时间") private Long readTime; - + @ApiModelProperty("内容") private String content; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/base/domain/SysRole.java b/backend/src/main/java/io/dataease/base/domain/SysRole.java index 85e561117b..654cefbdcc 100644 --- a/backend/src/main/java/io/dataease/base/domain/SysRole.java +++ b/backend/src/main/java/io/dataease/base/domain/SysRole.java @@ -1,22 +1,25 @@ package io.dataease.base.domain; import java.io.Serializable; + +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class SysRole implements Serializable { + @ApiModelProperty("角色ID") private Long roleId; - + @ApiModelProperty("角色名称") private String name; - + @ApiModelProperty("描述") private String description; - + @ApiModelProperty("创建者") private String createBy; - + @ApiModelProperty("更新者") private String updateBy; - + @ApiModelProperty("创建时间") private Long createTime; - + @ApiModelProperty("更新时间") private Long updateTime; private static final long serialVersionUID = 1L; diff --git a/backend/src/main/java/io/dataease/commons/model/AuthURD.java b/backend/src/main/java/io/dataease/commons/model/AuthURD.java index cf16b9bda6..d02e8f7095 100644 --- a/backend/src/main/java/io/dataease/commons/model/AuthURD.java +++ b/backend/src/main/java/io/dataease/commons/model/AuthURD.java @@ -1,6 +1,7 @@ package io.dataease.commons.model; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -9,10 +10,13 @@ import java.util.List; @Data public class AuthURD implements Serializable { + @ApiModelProperty("用户ID集合") private List userIds; + @ApiModelProperty("组织ID集合") private List deptIds; + @ApiModelProperty("角色ID集合") private List roleIds; diff --git a/backend/src/main/java/io/dataease/commons/utils/Pager.java b/backend/src/main/java/io/dataease/commons/utils/Pager.java index b068c2e6af..fa8c9193c6 100644 --- a/backend/src/main/java/io/dataease/commons/utils/Pager.java +++ b/backend/src/main/java/io/dataease/commons/utils/Pager.java @@ -1,9 +1,14 @@ package io.dataease.commons.utils; +import io.swagger.annotations.ApiModelProperty; + public class Pager { + @ApiModelProperty("数据") private T listObject; + @ApiModelProperty("总数") private long itemCount; + @ApiModelProperty("页数") private long pageCount; public Pager() { diff --git a/backend/src/main/java/io/dataease/controller/IndexController.java b/backend/src/main/java/io/dataease/controller/IndexController.java index 70febde13c..8ee0be37c6 100644 --- a/backend/src/main/java/io/dataease/controller/IndexController.java +++ b/backend/src/main/java/io/dataease/controller/IndexController.java @@ -43,7 +43,8 @@ public class IndexController { return "doc.html"; default: // DataEaseException.throwException("Invalid License."); - return "nolic.html"; + // return "nolic.html"; + return "doc.html"; } // return "index.html"; } diff --git a/backend/src/main/java/io/dataease/controller/ResultHolder.java b/backend/src/main/java/io/dataease/controller/ResultHolder.java index 0e5c021eda..4b5d9f3a9a 100644 --- a/backend/src/main/java/io/dataease/controller/ResultHolder.java +++ b/backend/src/main/java/io/dataease/controller/ResultHolder.java @@ -2,7 +2,9 @@ package io.dataease.controller; import org.apache.commons.lang3.builder.ReflectionToStringBuilder; import org.apache.commons.lang3.builder.ToStringStyle; +import springfox.documentation.annotations.ApiIgnore; +@ApiIgnore public class ResultHolder { public ResultHolder() { this.success = true; diff --git a/backend/src/main/java/io/dataease/controller/request/chart/ChartDrillRequest.java b/backend/src/main/java/io/dataease/controller/request/chart/ChartDrillRequest.java index c5537b9d4a..ef6c7f0569 100644 --- a/backend/src/main/java/io/dataease/controller/request/chart/ChartDrillRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/chart/ChartDrillRequest.java @@ -1,6 +1,7 @@ package io.dataease.controller.request.chart; import io.dataease.dto.chart.ChartDimensionDTO; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.List; @@ -11,5 +12,6 @@ import java.util.List; */ @Data public class ChartDrillRequest { + @ApiModelProperty("下钻维度集合") private List dimensionList; } diff --git a/backend/src/main/java/io/dataease/controller/request/chart/ChartExtFilterRequest.java b/backend/src/main/java/io/dataease/controller/request/chart/ChartExtFilterRequest.java index 8853b8232b..7e01c22a4f 100644 --- a/backend/src/main/java/io/dataease/controller/request/chart/ChartExtFilterRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/chart/ChartExtFilterRequest.java @@ -1,6 +1,7 @@ package io.dataease.controller.request.chart; import io.dataease.base.domain.DatasetTableField; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -13,10 +14,16 @@ import java.util.List; @Getter @Setter public class ChartExtFilterRequest { + @ApiModelProperty("过滤组件ID") private String componentId; + @ApiModelProperty("过滤字段ID") private String fieldId; + @ApiModelProperty("过滤操作符") private String operator; + @ApiModelProperty("过滤值") private List value; + @ApiModelProperty("目标视图ID集合") private List viewIds; + @ApiModelProperty("过滤字段") private DatasetTableField datasetTableField; } diff --git a/backend/src/main/java/io/dataease/controller/request/chart/ChartExtRequest.java b/backend/src/main/java/io/dataease/controller/request/chart/ChartExtRequest.java index edf9a5e9d7..b56a0ff547 100644 --- a/backend/src/main/java/io/dataease/controller/request/chart/ChartExtRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/chart/ChartExtRequest.java @@ -1,5 +1,6 @@ package io.dataease.controller.request.chart; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -12,9 +13,13 @@ import java.util.List; @Getter @Setter public class ChartExtRequest { + @ApiModelProperty("视图额外过滤条件集合") private List filter; //联动过滤条件 + @ApiModelProperty("联动过滤条件集合") private List linkageFilters; + + @ApiModelProperty("下钻维度集合") private List drill; } diff --git a/backend/src/main/java/io/dataease/controller/request/chart/ChartGroupRequest.java b/backend/src/main/java/io/dataease/controller/request/chart/ChartGroupRequest.java index 624380ba30..bfb4423053 100644 --- a/backend/src/main/java/io/dataease/controller/request/chart/ChartGroupRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/chart/ChartGroupRequest.java @@ -1,6 +1,7 @@ package io.dataease.controller.request.chart; import io.dataease.base.domain.ChartGroup; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.Set; @@ -8,7 +9,10 @@ import java.util.Set; @Data public class ChartGroupRequest extends ChartGroup { + @ApiModelProperty("排序") private String sort; + @ApiModelProperty("用户ID") private String userId; + @ApiModelProperty("ID集合") private Set ids; } diff --git a/backend/src/main/java/io/dataease/controller/request/dataset/DataSetGroupRequest.java b/backend/src/main/java/io/dataease/controller/request/dataset/DataSetGroupRequest.java index 7009e07eba..3543aaa4a7 100644 --- a/backend/src/main/java/io/dataease/controller/request/dataset/DataSetGroupRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/dataset/DataSetGroupRequest.java @@ -1,6 +1,7 @@ package io.dataease.controller.request.dataset; import io.dataease.base.domain.DatasetGroup; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.Set; @@ -11,9 +12,10 @@ import java.util.Set; */ @Data public class DataSetGroupRequest extends DatasetGroup { + @ApiModelProperty("排序") private String sort; - + @ApiModelProperty("用户ID") private String userId; - + @ApiModelProperty("ID集合") private Set ids; } diff --git a/backend/src/main/java/io/dataease/controller/request/dataset/DataSetTableRequest.java b/backend/src/main/java/io/dataease/controller/request/dataset/DataSetTableRequest.java index 432969290b..c2a774ff0b 100644 --- a/backend/src/main/java/io/dataease/controller/request/dataset/DataSetTableRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/dataset/DataSetTableRequest.java @@ -3,6 +3,7 @@ package io.dataease.controller.request.dataset; import io.dataease.base.domain.DatasetTable; import io.dataease.datasource.dto.TableFiled; import io.dataease.dto.dataset.ExcelSheetData; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -15,15 +16,26 @@ import java.util.List; @Setter @Getter public class DataSetTableRequest extends DatasetTable { + @ApiModelProperty("排序") private String sort; + @ApiModelProperty("表名集合") private List tableNames; + @ApiModelProperty("行数") private String row = "1000"; + @ApiModelProperty("用户ID") private String userId; + @ApiModelProperty("同步类型") private String syncType; + @ApiModelProperty("编辑类型") private Integer editType; + @ApiModelProperty("是否重命名") private Boolean isRename; + @ApiModelProperty("类型过滤条件集合") private List typeFilter; + @ApiModelProperty("字段集合") private List fields; + @ApiModelProperty("excel sheet集合") private List sheets; + @ApiModelProperty("是否合并sheet") private boolean mergeSheet = false; } diff --git a/backend/src/main/java/io/dataease/controller/request/dataset/DataSetTaskRequest.java b/backend/src/main/java/io/dataease/controller/request/dataset/DataSetTaskRequest.java index 18df3f1494..7d02ab5911 100644 --- a/backend/src/main/java/io/dataease/controller/request/dataset/DataSetTaskRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/dataset/DataSetTaskRequest.java @@ -2,12 +2,15 @@ package io.dataease.controller.request.dataset; import io.dataease.base.domain.DatasetTableIncrementalConfig; import io.dataease.base.domain.DatasetTableTask; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @Setter @Getter public class DataSetTaskRequest { + @ApiModelProperty("数据集任务") private DatasetTableTask datasetTableTask; + @ApiModelProperty("数据集增量配置") private DatasetTableIncrementalConfig datasetTableIncrementalConfig; } diff --git a/backend/src/main/java/io/dataease/controller/request/panel/PanelGroupRequest.java b/backend/src/main/java/io/dataease/controller/request/panel/PanelGroupRequest.java index ccb7392b6f..1115d8a233 100644 --- a/backend/src/main/java/io/dataease/controller/request/panel/PanelGroupRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/panel/PanelGroupRequest.java @@ -1,6 +1,7 @@ package io.dataease.controller.request.panel; import io.dataease.dto.panel.PanelGroupDTO; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; /** @@ -10,10 +11,11 @@ import lombok.Data; */ @Data public class PanelGroupRequest extends PanelGroupDTO { + @ApiModelProperty("排序") private String sort; - + @ApiModelProperty("用户ID") private String userId; - + @ApiModelProperty("操作类型") private String optType; public PanelGroupRequest() { diff --git a/backend/src/main/java/io/dataease/controller/request/panel/PanelLinkageRequest.java b/backend/src/main/java/io/dataease/controller/request/panel/PanelLinkageRequest.java index e7c164fab0..c25424d15e 100644 --- a/backend/src/main/java/io/dataease/controller/request/panel/PanelLinkageRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/panel/PanelLinkageRequest.java @@ -1,6 +1,7 @@ package io.dataease.controller.request.panel; import io.dataease.dto.PanelViewLinkageDTO; +import io.swagger.annotations.ApiModelProperty; import java.util.List; import java.util.Map; @@ -11,13 +12,14 @@ import java.util.Map; * Description: */ public class PanelLinkageRequest { - + @ApiModelProperty("仪表板ID") private String panelId; - + @ApiModelProperty("源视图ID") private String sourceViewId; - + @ApiModelProperty("目标视图ID集合") private List targetViewIds; + @ApiModelProperty("联动信息") private Map linkageInfo; public Map getLinkageInfo() { diff --git a/backend/src/main/java/io/dataease/controller/request/panel/PanelShareFineDto.java b/backend/src/main/java/io/dataease/controller/request/panel/PanelShareFineDto.java index 76f3d8cc74..bab47d5e97 100644 --- a/backend/src/main/java/io/dataease/controller/request/panel/PanelShareFineDto.java +++ b/backend/src/main/java/io/dataease/controller/request/panel/PanelShareFineDto.java @@ -1,6 +1,7 @@ package io.dataease.controller.request.panel; import io.dataease.commons.model.AuthURD; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -11,8 +12,8 @@ public class PanelShareFineDto implements Serializable { private static final long serialVersionUID = -792964171742204428L; - + @ApiModelProperty("资源ID") private String resourceId; - + @ApiModelProperty("分享信息") private AuthURD authURD; } diff --git a/backend/src/main/java/io/dataease/controller/request/panel/PanelTemplateRequest.java b/backend/src/main/java/io/dataease/controller/request/panel/PanelTemplateRequest.java index c2226de6e1..5179ec5df2 100644 --- a/backend/src/main/java/io/dataease/controller/request/panel/PanelTemplateRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/panel/PanelTemplateRequest.java @@ -1,6 +1,7 @@ package io.dataease.controller.request.panel; import io.dataease.base.domain.PanelTemplateWithBLOBs; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; /** @@ -10,12 +11,13 @@ import lombok.Data; */ @Data public class PanelTemplateRequest extends PanelTemplateWithBLOBs { + @ApiModelProperty("排序") private String sort; - + @ApiModelProperty("详息") private String withBlobs="Y"; - + @ApiModelProperty("操作类型") private String optType; - + @ApiModelProperty("是否及联") private Boolean withChildren = false; public PanelTemplateRequest() { diff --git a/backend/src/main/java/io/dataease/controller/request/panel/link/EnablePwdRequest.java b/backend/src/main/java/io/dataease/controller/request/panel/link/EnablePwdRequest.java index b2eb8c0301..eb8fddaecf 100644 --- a/backend/src/main/java/io/dataease/controller/request/panel/link/EnablePwdRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/panel/link/EnablePwdRequest.java @@ -1,11 +1,13 @@ package io.dataease.controller.request.panel.link; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class EnablePwdRequest { + @ApiModelProperty("资源ID") private String resourceId; - + @ApiModelProperty("是否启用密码保护") private boolean enablePwd; } diff --git a/backend/src/main/java/io/dataease/controller/request/panel/link/LinkRequest.java b/backend/src/main/java/io/dataease/controller/request/panel/link/LinkRequest.java index 855b347acb..6e5071c6cd 100644 --- a/backend/src/main/java/io/dataease/controller/request/panel/link/LinkRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/panel/link/LinkRequest.java @@ -1,11 +1,12 @@ package io.dataease.controller.request.panel.link; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class LinkRequest { - + @ApiModelProperty("资源ID") private String resourceId; - + @ApiModelProperty("是否有效") private boolean valid; } diff --git a/backend/src/main/java/io/dataease/controller/request/panel/link/PasswordRequest.java b/backend/src/main/java/io/dataease/controller/request/panel/link/PasswordRequest.java index c714c7a6dd..69d24a8b27 100644 --- a/backend/src/main/java/io/dataease/controller/request/panel/link/PasswordRequest.java +++ b/backend/src/main/java/io/dataease/controller/request/panel/link/PasswordRequest.java @@ -1,12 +1,14 @@ package io.dataease.controller.request.panel.link; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class PasswordRequest { + @ApiModelProperty("资源ID") private String resourceId; - + @ApiModelProperty("密码") private String password; diff --git a/backend/src/main/java/io/dataease/controller/sys/response/MsgGridDto.java b/backend/src/main/java/io/dataease/controller/sys/response/MsgGridDto.java index 917c13874b..039304429d 100644 --- a/backend/src/main/java/io/dataease/controller/sys/response/MsgGridDto.java +++ b/backend/src/main/java/io/dataease/controller/sys/response/MsgGridDto.java @@ -1,11 +1,14 @@ package io.dataease.controller.sys.response; import io.dataease.base.domain.SysMsg; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class MsgGridDto extends SysMsg { + @ApiModelProperty("回调路由") private String router; + @ApiModelProperty("回调函数") private String callback; } diff --git a/backend/src/main/java/io/dataease/controller/sys/response/RoleUserItem.java b/backend/src/main/java/io/dataease/controller/sys/response/RoleUserItem.java index acbcd06890..251cb32dca 100644 --- a/backend/src/main/java/io/dataease/controller/sys/response/RoleUserItem.java +++ b/backend/src/main/java/io/dataease/controller/sys/response/RoleUserItem.java @@ -1,5 +1,6 @@ package io.dataease.controller.sys.response; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @@ -7,7 +8,8 @@ import java.io.Serializable; @Data public class RoleUserItem implements Serializable { + @ApiModelProperty("角色ID") private Long id; - + @ApiModelProperty("角色名称") private String name; } diff --git a/backend/src/main/java/io/dataease/controller/sys/response/SysUserDept.java b/backend/src/main/java/io/dataease/controller/sys/response/SysUserDept.java index 0303c9bc16..5df1d385d5 100644 --- a/backend/src/main/java/io/dataease/controller/sys/response/SysUserDept.java +++ b/backend/src/main/java/io/dataease/controller/sys/response/SysUserDept.java @@ -1,15 +1,16 @@ package io.dataease.controller.sys.response; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @Data public class SysUserDept implements Serializable { - + @ApiModelProperty("组织ID") private Long deptId; - + @ApiModelProperty("父ID") private Long pid; - + @ApiModelProperty("组织名称") private String deptName; } diff --git a/backend/src/main/java/io/dataease/controller/sys/response/SysUserGridResponse.java b/backend/src/main/java/io/dataease/controller/sys/response/SysUserGridResponse.java index 592a79689b..3ef580aad9 100644 --- a/backend/src/main/java/io/dataease/controller/sys/response/SysUserGridResponse.java +++ b/backend/src/main/java/io/dataease/controller/sys/response/SysUserGridResponse.java @@ -2,17 +2,19 @@ package io.dataease.controller.sys.response; import io.dataease.base.domain.SysUser; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.List; @Data public class SysUserGridResponse extends SysUser { + @ApiModelProperty("ID") private Long id; - + @ApiModelProperty("角色集合") private List roles; - + @ApiModelProperty("组织信息") private SysUserDept dept; - + @ApiModelProperty("角色ID集合") private List roleIds; } diff --git a/backend/src/main/java/io/dataease/controller/sys/response/SysUserRole.java b/backend/src/main/java/io/dataease/controller/sys/response/SysUserRole.java index 5a2ff2abcf..c6df37bfc8 100644 --- a/backend/src/main/java/io/dataease/controller/sys/response/SysUserRole.java +++ b/backend/src/main/java/io/dataease/controller/sys/response/SysUserRole.java @@ -1,13 +1,14 @@ package io.dataease.controller.sys.response; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.io.Serializable; @Data public class SysUserRole implements Serializable { - + @ApiModelProperty("角色ID") private Long roleId; - + @ApiModelProperty("角色名称") private String roleName; } diff --git a/backend/src/main/java/io/dataease/datasource/dto/DBTableDTO.java b/backend/src/main/java/io/dataease/datasource/dto/DBTableDTO.java index 768b42bc78..4dd41af776 100644 --- a/backend/src/main/java/io/dataease/datasource/dto/DBTableDTO.java +++ b/backend/src/main/java/io/dataease/datasource/dto/DBTableDTO.java @@ -1,5 +1,6 @@ package io.dataease.datasource.dto; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -10,8 +11,12 @@ import lombok.Setter; @Getter @Setter public class DBTableDTO { + @ApiModelProperty("数据源ID") private String datasourceId; + @ApiModelProperty("数据源名称") private String name; + @ApiModelProperty("启用检测") private boolean enableCheck; + @ApiModelProperty("数据集路径") private String datasetPath; } diff --git a/backend/src/main/java/io/dataease/datasource/dto/TableFiled.java b/backend/src/main/java/io/dataease/datasource/dto/TableFiled.java index efcf83594d..6ca38dd059 100644 --- a/backend/src/main/java/io/dataease/datasource/dto/TableFiled.java +++ b/backend/src/main/java/io/dataease/datasource/dto/TableFiled.java @@ -1,15 +1,19 @@ package io.dataease.datasource.dto; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @Setter @Getter public class TableFiled { - + @ApiModelProperty("字段名称") private String fieldName; + @ApiModelProperty("重新标记") private String remarks; + @ApiModelProperty("字段类型") private String fieldType; + @ApiModelProperty("字段大小") private int fieldSize; } diff --git a/backend/src/main/java/io/dataease/dto/DatasourceDTO.java b/backend/src/main/java/io/dataease/dto/DatasourceDTO.java index fd0db43c5c..63c3e8760b 100644 --- a/backend/src/main/java/io/dataease/dto/DatasourceDTO.java +++ b/backend/src/main/java/io/dataease/dto/DatasourceDTO.java @@ -1,6 +1,7 @@ package io.dataease.dto; import io.dataease.base.domain.Datasource; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; /** @@ -11,6 +12,7 @@ import lombok.Data; @Data public class DatasourceDTO extends Datasource { + @ApiModelProperty("权限") private String privileges; } diff --git a/backend/src/main/java/io/dataease/dto/PanelViewLinkageDTO.java b/backend/src/main/java/io/dataease/dto/PanelViewLinkageDTO.java index c265d4aecd..d3af3d1413 100644 --- a/backend/src/main/java/io/dataease/dto/PanelViewLinkageDTO.java +++ b/backend/src/main/java/io/dataease/dto/PanelViewLinkageDTO.java @@ -3,6 +3,7 @@ package io.dataease.dto; import io.dataease.base.domain.DatasetTableField; import io.dataease.base.domain.PanelViewLinkage; import io.dataease.base.domain.PanelViewLinkageField; +import io.swagger.annotations.ApiModelProperty; import java.util.ArrayList; import java.util.List; @@ -14,17 +15,18 @@ import java.util.List; */ public class PanelViewLinkageDTO extends PanelViewLinkage { + @ApiModelProperty("目标视图名称") //目标视图名称 private String targetViewName; - + @ApiModelProperty("启用联动") //关联状态 private boolean linkageActive = false; - + @ApiModelProperty("联动字段") private List linkageFields = new ArrayList<>(); - + @ApiModelProperty("目标视图字段") private List targetViewFields = new ArrayList<>(); - + @ApiModelProperty("表ID") private String tableId; diff --git a/backend/src/main/java/io/dataease/dto/chart/ChartDimensionDTO.java b/backend/src/main/java/io/dataease/dto/chart/ChartDimensionDTO.java index a0b139b75c..ba42e6fc3c 100644 --- a/backend/src/main/java/io/dataease/dto/chart/ChartDimensionDTO.java +++ b/backend/src/main/java/io/dataease/dto/chart/ChartDimensionDTO.java @@ -1,5 +1,6 @@ package io.dataease.dto.chart; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; /** @@ -8,6 +9,8 @@ import lombok.Data; */ @Data public class ChartDimensionDTO { + @ApiModelProperty("维度ID") private String id; + @ApiModelProperty("维度值") private String value; } diff --git a/backend/src/main/java/io/dataease/dto/chart/ChartGroupDTO.java b/backend/src/main/java/io/dataease/dto/chart/ChartGroupDTO.java index 0a5f4c8d23..57a25a45ca 100644 --- a/backend/src/main/java/io/dataease/dto/chart/ChartGroupDTO.java +++ b/backend/src/main/java/io/dataease/dto/chart/ChartGroupDTO.java @@ -2,6 +2,7 @@ package io.dataease.dto.chart; import io.dataease.base.domain.DatasetGroup; import io.dataease.commons.model.ITreeBase; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.List; @@ -9,9 +10,10 @@ import java.util.List; @Data public class ChartGroupDTO extends DatasetGroup implements ITreeBase { + @ApiModelProperty("标签") private String label; - + @ApiModelProperty("子节点") private List children; - + @ApiModelProperty("权限") private String privileges; } diff --git a/backend/src/main/java/io/dataease/dto/chart/ChartViewDTO.java b/backend/src/main/java/io/dataease/dto/chart/ChartViewDTO.java index a431983eb6..baf32b4497 100644 --- a/backend/src/main/java/io/dataease/dto/chart/ChartViewDTO.java +++ b/backend/src/main/java/io/dataease/dto/chart/ChartViewDTO.java @@ -2,6 +2,7 @@ package io.dataease.dto.chart; import io.dataease.base.domain.ChartViewWithBLOBs; import io.dataease.controller.request.chart.ChartExtFilterRequest; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -15,15 +16,18 @@ import java.util.Map; @Setter @Getter public class ChartViewDTO extends ChartViewWithBLOBs { + @ApiModelProperty("数据") private Map data; - + @ApiModelProperty("权限") private String privileges; - + @ApiModelProperty("是否叶子节点") private Boolean isLeaf; + @ApiModelProperty("父ID") private String pid; + @ApiModelProperty("sql") private String sql; - + @ApiModelProperty("下钻") private boolean drill; - + @ApiModelProperty("下钻条件集合") private List drillFilters; } diff --git a/backend/src/main/java/io/dataease/dto/dataset/DataSetGroupDTO.java b/backend/src/main/java/io/dataease/dto/dataset/DataSetGroupDTO.java index c096646b73..9f8d222643 100644 --- a/backend/src/main/java/io/dataease/dto/dataset/DataSetGroupDTO.java +++ b/backend/src/main/java/io/dataease/dto/dataset/DataSetGroupDTO.java @@ -2,6 +2,7 @@ package io.dataease.dto.dataset; import io.dataease.base.domain.DatasetGroup; import io.dataease.commons.model.ITreeBase; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.List; @@ -12,8 +13,10 @@ import java.util.List; */ @Data public class DataSetGroupDTO extends DatasetGroup implements ITreeBase { + @ApiModelProperty("标签") private String label; + @ApiModelProperty("子节点") private List children; - + @ApiModelProperty("权限") private String privileges; } diff --git a/backend/src/main/java/io/dataease/dto/dataset/DataSetTableDTO.java b/backend/src/main/java/io/dataease/dto/dataset/DataSetTableDTO.java index d9ec015bb5..3d7e817842 100644 --- a/backend/src/main/java/io/dataease/dto/dataset/DataSetTableDTO.java +++ b/backend/src/main/java/io/dataease/dto/dataset/DataSetTableDTO.java @@ -1,6 +1,7 @@ package io.dataease.dto.dataset; import io.dataease.base.domain.DatasetTable; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -13,9 +14,12 @@ import java.util.List; @Setter @Getter public class DataSetTableDTO extends DatasetTable { + @ApiModelProperty("子节点") private List children; + @ApiModelProperty("权限") private String privileges; - + @ApiModelProperty("是否叶子结点") private Boolean isLeaf; + @ApiModelProperty("父ID") private String pid; } diff --git a/backend/src/main/java/io/dataease/dto/dataset/DataSetTableUnionDTO.java b/backend/src/main/java/io/dataease/dto/dataset/DataSetTableUnionDTO.java index b1096c3b7a..133c34988e 100644 --- a/backend/src/main/java/io/dataease/dto/dataset/DataSetTableUnionDTO.java +++ b/backend/src/main/java/io/dataease/dto/dataset/DataSetTableUnionDTO.java @@ -1,6 +1,7 @@ package io.dataease.dto.dataset; import io.dataease.base.domain.DatasetTableUnion; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -11,8 +12,12 @@ import lombok.Setter; @Getter @Setter public class DataSetTableUnionDTO extends DatasetTableUnion { + @ApiModelProperty("源表名称") private String sourceTableName; + @ApiModelProperty("源表字段名称") private String sourceTableFieldName; + @ApiModelProperty("目标表名称") private String targetTableName; + @ApiModelProperty("目标表字段名称") private String targetTableFieldName; } diff --git a/backend/src/main/java/io/dataease/dto/dataset/DataSetTaskDTO.java b/backend/src/main/java/io/dataease/dto/dataset/DataSetTaskDTO.java index e14ef6c4d4..0297e2ff6d 100644 --- a/backend/src/main/java/io/dataease/dto/dataset/DataSetTaskDTO.java +++ b/backend/src/main/java/io/dataease/dto/dataset/DataSetTaskDTO.java @@ -1,6 +1,7 @@ package io.dataease.dto.dataset; import io.dataease.base.domain.DatasetTableTask; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -11,9 +12,14 @@ import lombok.Setter; @Getter @Setter public class DataSetTaskDTO extends DatasetTableTask { + @ApiModelProperty("数据集名称") private String datasetName; + @ApiModelProperty("下次执行时间") private Long nextExecTime; + @ApiModelProperty("任务状态") private String taskStatus; + @ApiModelProperty("消息") private String msg; + @ApiModelProperty("权限") private String privileges; } diff --git a/backend/src/main/java/io/dataease/dto/dataset/DataSetTaskLogDTO.java b/backend/src/main/java/io/dataease/dto/dataset/DataSetTaskLogDTO.java index c577f59ef8..9d8fb2af70 100644 --- a/backend/src/main/java/io/dataease/dto/dataset/DataSetTaskLogDTO.java +++ b/backend/src/main/java/io/dataease/dto/dataset/DataSetTaskLogDTO.java @@ -1,6 +1,7 @@ package io.dataease.dto.dataset; import io.dataease.base.domain.DatasetTableTaskLog; +import io.swagger.annotations.ApiModelProperty; import lombok.Getter; import lombok.Setter; @@ -11,6 +12,8 @@ import lombok.Setter; @Getter @Setter public class DataSetTaskLogDTO extends DatasetTableTaskLog { + @ApiModelProperty("名称") private String name; + @ApiModelProperty("数据集名称") private String datasetName; } diff --git a/backend/src/main/java/io/dataease/dto/dataset/ExcelFileData.java b/backend/src/main/java/io/dataease/dto/dataset/ExcelFileData.java index 31119400a2..4ed3534faf 100644 --- a/backend/src/main/java/io/dataease/dto/dataset/ExcelFileData.java +++ b/backend/src/main/java/io/dataease/dto/dataset/ExcelFileData.java @@ -1,14 +1,20 @@ package io.dataease.dto.dataset; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.List; @Data public class ExcelFileData { + @ApiModelProperty("excelID") private String excelId; + @ApiModelProperty("excel标签") private String excelLable; + @ApiModelProperty("sheets") private List sheets; + @ApiModelProperty("路径") private String path; + @ApiModelProperty("是否Sheet") private boolean isSheet = false; } diff --git a/backend/src/main/java/io/dataease/dto/dataset/ExcelSheetData.java b/backend/src/main/java/io/dataease/dto/dataset/ExcelSheetData.java index 10340dff3a..f7511f0eaa 100644 --- a/backend/src/main/java/io/dataease/dto/dataset/ExcelSheetData.java +++ b/backend/src/main/java/io/dataease/dto/dataset/ExcelSheetData.java @@ -1,6 +1,7 @@ package io.dataease.dto.dataset; import io.dataease.datasource.dto.TableFiled; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.List; @@ -8,14 +9,24 @@ import java.util.Map; @Data public class ExcelSheetData { + @ApiModelProperty("标签") private String excelLable; + @ApiModelProperty("数据集合") private List> data; + @ApiModelProperty("字段集合") private List fields; + @ApiModelProperty("是否sheet") private boolean isSheet = true; + @ApiModelProperty("json数组") private List> jsonArray; + @ApiModelProperty("数据集名称") private String datasetName; + @ApiModelProperty("excelID") private String sheetExcelId; + @ApiModelProperty("sheetId") private String sheetId; + @ApiModelProperty("路径") private String path; + @ApiModelProperty("字段MD5") private String fieldsMd5; } diff --git a/backend/src/main/java/io/dataease/dto/panel/PanelGroupDTO.java b/backend/src/main/java/io/dataease/dto/panel/PanelGroupDTO.java index de6e95210f..0d3ece3cfa 100644 --- a/backend/src/main/java/io/dataease/dto/panel/PanelGroupDTO.java +++ b/backend/src/main/java/io/dataease/dto/panel/PanelGroupDTO.java @@ -2,6 +2,7 @@ package io.dataease.dto.panel; import io.dataease.base.domain.PanelGroupWithBLOBs; import io.dataease.commons.model.ITreeBase; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.ArrayList; @@ -14,21 +15,21 @@ import java.util.List; */ @Data public class PanelGroupDTO extends PanelGroupWithBLOBs implements ITreeBase { - + @ApiModelProperty("标签") private String label; - + @ApiModelProperty("是否叶子节点") private Boolean leaf; - + @ApiModelProperty("权限") private String privileges; - + @ApiModelProperty("默认仪表板ID") private String defaultPanelId; - + @ApiModelProperty("默认仪表板名称") private String defaultPanelName; - + @ApiModelProperty("是否默认") private Boolean isDefault; - + @ApiModelProperty("源仪表板名称") private String sourcePanelName; - + @ApiModelProperty("子节点") private List children = new ArrayList<>(); diff --git a/backend/src/main/java/io/dataease/dto/panel/PanelTemplateDTO.java b/backend/src/main/java/io/dataease/dto/panel/PanelTemplateDTO.java index 83cb869664..32111d182d 100644 --- a/backend/src/main/java/io/dataease/dto/panel/PanelTemplateDTO.java +++ b/backend/src/main/java/io/dataease/dto/panel/PanelTemplateDTO.java @@ -1,6 +1,7 @@ package io.dataease.dto.panel; import io.dataease.base.domain.PanelTemplateWithBLOBs; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.List; @@ -13,10 +14,11 @@ import java.util.List; @Data public class PanelTemplateDTO extends PanelTemplateWithBLOBs { + @ApiModelProperty("标签") private String label; - + @ApiModelProperty("子节点数量") private Integer childrenCount; - + @ApiModelProperty("子节点") private List children; diff --git a/backend/src/main/java/io/dataease/dto/panel/PanelViewDto.java b/backend/src/main/java/io/dataease/dto/panel/PanelViewDto.java index c5a1c13c1e..1144c6c111 100644 --- a/backend/src/main/java/io/dataease/dto/panel/PanelViewDto.java +++ b/backend/src/main/java/io/dataease/dto/panel/PanelViewDto.java @@ -1,6 +1,7 @@ package io.dataease.dto.panel; import io.dataease.commons.model.ITreeBase; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; import java.util.ArrayList; @@ -9,15 +10,15 @@ import java.util.Optional; @Data public class PanelViewDto implements ITreeBase { - + @ApiModelProperty("ID") private String id; - + @ApiModelProperty("父ID") private String pid; - + @ApiModelProperty("类型") private String type; - + @ApiModelProperty("名称") private String name; - + @ApiModelProperty("子节点") private List children; public void addChild(PanelViewDto dto){ diff --git a/backend/src/main/java/io/dataease/dto/panel/link/GenerateDto.java b/backend/src/main/java/io/dataease/dto/panel/link/GenerateDto.java index b55ca584d0..5958d12f9a 100644 --- a/backend/src/main/java/io/dataease/dto/panel/link/GenerateDto.java +++ b/backend/src/main/java/io/dataease/dto/panel/link/GenerateDto.java @@ -1,15 +1,17 @@ package io.dataease.dto.panel.link; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class GenerateDto { + @ApiModelProperty("是否有效") private boolean valid; - + @ApiModelProperty("是否启用密码") private boolean enablePwd; - + @ApiModelProperty("链接地址") private String uri; - + @ApiModelProperty("密码") private String pwd; } diff --git a/backend/src/main/java/io/dataease/dto/panel/link/ValidateDto.java b/backend/src/main/java/io/dataease/dto/panel/link/ValidateDto.java index 9d18f2bb6b..7d92ecbe80 100644 --- a/backend/src/main/java/io/dataease/dto/panel/link/ValidateDto.java +++ b/backend/src/main/java/io/dataease/dto/panel/link/ValidateDto.java @@ -1,15 +1,17 @@ package io.dataease.dto.panel.link; +import io.swagger.annotations.ApiModelProperty; import lombok.Data; @Data public class ValidateDto { + @ApiModelProperty("是否可用") private boolean valid; - + @ApiModelProperty("是否启用密码") private boolean enablePwd; - + @ApiModelProperty("是否通过密码验证") private boolean passPwd; - + @ApiModelProperty("资源ID") private String resourceId; }