Prechádzať zdrojové kódy

补充数据表注释

zhangji 3 rokov pred
rodič
commit
88f029b503
9 zmenil súbory, kde vykonal 17 pridanie a 0 odobranie
  1. 2 0
      hsweb-system/hsweb-system-authorization/hsweb-system-authorization-api/src/main/java/org/hswebframework/web/system/authorization/api/entity/AuthorizationSettingEntity.java
  2. 1 0
      hsweb-system/hsweb-system-authorization/hsweb-system-authorization-api/src/main/java/org/hswebframework/web/system/authorization/api/entity/DimensionEntity.java
  3. 1 0
      hsweb-system/hsweb-system-authorization/hsweb-system-authorization-api/src/main/java/org/hswebframework/web/system/authorization/api/entity/DimensionTypeEntity.java
  4. 1 0
      hsweb-system/hsweb-system-authorization/hsweb-system-authorization-api/src/main/java/org/hswebframework/web/system/authorization/api/entity/DimensionUserEntity.java
  5. 1 0
      hsweb-system/hsweb-system-authorization/hsweb-system-authorization-api/src/main/java/org/hswebframework/web/system/authorization/api/entity/PermissionEntity.java
  6. 5 0
      hsweb-system/hsweb-system-authorization/hsweb-system-authorization-api/src/main/java/org/hswebframework/web/system/authorization/api/entity/UserEntity.java
  7. 2 0
      hsweb-system/hsweb-system-authorization/hsweb-system-authorization-oauth2/src/main/java/org/hswebframework/web/oauth2/entity/OAuth2ClientEntity.java
  8. 2 0
      hsweb-system/hsweb-system-dictionary/src/main/java/org/hswebframework/web/dictionary/entity/DictionaryEntity.java
  9. 2 0
      hsweb-system/hsweb-system-dictionary/src/main/java/org/hswebframework/web/dictionary/entity/DictionaryItemEntity.java

+ 2 - 0
hsweb-system/hsweb-system-authorization/hsweb-system-authorization-api/src/main/java/org/hswebframework/web/system/authorization/api/entity/AuthorizationSettingEntity.java

@@ -26,6 +26,7 @@ import java.util.stream.Collectors;
         @Index(name = "idx_sasi_dss", columnList = "dimension_type,dimension_target,state desc"),
         @Index(name = "idx_sasi_pdd", columnList = "permission,dimension_type,dimension_target",unique = true)
 })
+@Comment("授权信息")
 @Getter
 @Setter
 @EnableEntityEvent
@@ -33,6 +34,7 @@ public class AuthorizationSettingEntity implements Entity {
     @Id
     @Column(length = 32)
     @GeneratedValue(generator = "md5")
+    @Schema(description = "ID")
     private String id;
 
     @Column(length = 32, nullable = false, updatable = false)

+ 1 - 0
hsweb-system/hsweb-system-authorization/hsweb-system-authorization-api/src/main/java/org/hswebframework/web/system/authorization/api/entity/DimensionEntity.java

@@ -25,6 +25,7 @@ import java.util.Map;
 @Table(name = "s_dimension", indexes = {
         @Index(name = "idx_dims_path", columnList = "path")
 })
+@Comment("权限纬度")
 @EnableEntityEvent
 public class DimensionEntity extends GenericTreeSortSupportEntity<String> {
 

+ 1 - 0
hsweb-system/hsweb-system-authorization/hsweb-system-authorization-api/src/main/java/org/hswebframework/web/system/authorization/api/entity/DimensionTypeEntity.java

@@ -15,6 +15,7 @@ import javax.validation.constraints.NotBlank;
 @Getter
 @Setter
 @Table(name = "s_dimension_type")
+@Comment("纬度类型")
 public class DimensionTypeEntity extends GenericEntity<String> implements DimensionType {
 
 

+ 1 - 0
hsweb-system/hsweb-system-authorization/hsweb-system-authorization-api/src/main/java/org/hswebframework/web/system/authorization/api/entity/DimensionUserEntity.java

@@ -27,6 +27,7 @@ import java.sql.JDBCType;
         @Index(name = "idx_dimsu_user_id", columnList = "user_id"),
 
 })
+@Comment("用户纬度关联表")
 @EnableEntityEvent
 public class DimensionUserEntity extends GenericEntity<String> {
 

+ 1 - 0
hsweb-system/hsweb-system-authorization/hsweb-system-authorization-api/src/main/java/org/hswebframework/web/system/authorization/api/entity/PermissionEntity.java

@@ -22,6 +22,7 @@ import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
 @Table(name = "s_permission")
+@Comment("权限信息")
 @Getter
 @Setter
 @Builder

+ 5 - 0
hsweb-system/hsweb-system-authorization/hsweb-system-authorization-api/src/main/java/org/hswebframework/web/system/authorization/api/entity/UserEntity.java

@@ -6,6 +6,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Getter;
 import lombok.Setter;
 import org.apache.commons.codec.digest.DigestUtils;
+import org.hswebframework.ezorm.rdb.mapping.annotation.Comment;
 import org.hswebframework.ezorm.rdb.mapping.annotation.DefaultValue;
 import org.hswebframework.web.api.crud.entity.GenericEntity;
 import org.hswebframework.web.api.crud.entity.RecordCreationEntity;
@@ -32,6 +33,7 @@ import javax.validation.constraints.NotBlank;
 @Table(name = "s_user",
         indexes = @Index(name = "user_username_idx", columnList = "username", unique = true)
 )
+@Comment("用户信息")
 public class UserEntity extends GenericEntity<String> implements RecordCreationEntity {
 
     @Column(length = 128, nullable = false)
@@ -54,6 +56,7 @@ public class UserEntity extends GenericEntity<String> implements RecordCreationE
     @Column(nullable = false)
     @ToString.Ignore(cover = false)
     @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
+    @Schema(description = "加密盐值")
     @Hidden
     private String salt;
 
@@ -67,11 +70,13 @@ public class UserEntity extends GenericEntity<String> implements RecordCreationE
     private Byte status;
 
     @Column(name = "creator_id", updatable = false)
+    @Schema(description = "创建者ID")
     @Hidden
     private String creatorId;
 
     @Column(name = "create_time", updatable = false)
     @DefaultValue(generator = "current_time")
+    @Schema(description = "创建时间")
     @Hidden
     private Long createTime;
 

+ 2 - 0
hsweb-system/hsweb-system-authorization/hsweb-system-authorization-oauth2/src/main/java/org/hswebframework/web/oauth2/entity/OAuth2ClientEntity.java

@@ -4,6 +4,7 @@ import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Getter;
 import lombok.Setter;
 import org.hswebframework.ezorm.rdb.mapping.annotation.ColumnType;
+import org.hswebframework.ezorm.rdb.mapping.annotation.Comment;
 import org.hswebframework.ezorm.rdb.mapping.annotation.DefaultValue;
 import org.hswebframework.ezorm.rdb.mapping.annotation.EnumCodec;
 import org.hswebframework.web.api.crud.entity.GenericEntity;
@@ -17,6 +18,7 @@ import javax.persistence.Table;
 import javax.validation.constraints.NotBlank;
 
 @Table(name = "s_oauth2_client")
+@Comment("OAuth2客户端")
 @Getter
 @Setter
 public class OAuth2ClientEntity extends GenericEntity<String> {

+ 2 - 0
hsweb-system/hsweb-system-dictionary/src/main/java/org/hswebframework/web/dictionary/entity/DictionaryEntity.java

@@ -20,6 +20,7 @@ package org.hswebframework.web.dictionary.entity;
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Getter;
 import lombok.Setter;
+import org.hswebframework.ezorm.rdb.mapping.annotation.Comment;
 import org.hswebframework.ezorm.rdb.mapping.annotation.DefaultValue;
 import org.hswebframework.web.api.crud.entity.GenericEntity;
 import org.hswebframework.web.api.crud.entity.RecordCreationEntity;
@@ -37,6 +38,7 @@ import java.util.List;
  * @author hsweb-generator-online
  */
 @Table(name = "s_dictionary")
+@Comment("数据字典")
 @Getter
 @Setter
 public class DictionaryEntity extends GenericEntity<String> implements RecordCreationEntity {

+ 2 - 0
hsweb-system/hsweb-system-dictionary/src/main/java/org/hswebframework/web/dictionary/entity/DictionaryItemEntity.java

@@ -20,6 +20,7 @@ import com.alibaba.fastjson.JSONObject;
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.Getter;
 import lombok.Setter;
+import org.hswebframework.ezorm.rdb.mapping.annotation.Comment;
 import org.hswebframework.ezorm.rdb.mapping.annotation.DefaultValue;
 import org.hswebframework.web.api.crud.entity.GenericTreeSortSupportEntity;
 import org.hswebframework.web.dict.EnumDict;
@@ -39,6 +40,7 @@ import java.util.List;
         @Index(name = "idx_dic_item_ordinal",columnList = "ordinal"),
         @Index(name = "idx_dic_item_path",columnList = "path")
 })
+@Comment("数据字典选项")
 public class DictionaryItemEntity extends GenericTreeSortSupportEntity<String> implements EnumDict<String> {
     //字典id
     @Column(name = "dict_id", length = 64, updatable = false, nullable = false)