diff --git a/common/src/main/java/com/usthe/common/entity/manager/ParamDefine.java b/common/src/main/java/com/usthe/common/entity/manager/ParamDefine.java index 1bb2af3..ea7fe24 100644 --- a/common/src/main/java/com/usthe/common/entity/manager/ParamDefine.java +++ b/common/src/main/java/com/usthe/common/entity/manager/ParamDefine.java @@ -22,7 +22,9 @@ import static io.swagger.annotations.ApiModelProperty.AccessMode.READ_WRITE; /** * todo 字段默认值 + * Monitoring parameter definitions * 监控参数定义 + * * @author tomsun28 * @date 2021/11/13 21:49 */ @@ -32,57 +34,68 @@ import static io.swagger.annotations.ApiModelProperty.AccessMode.READ_WRITE; @Builder @AllArgsConstructor @NoArgsConstructor -@ApiModel(description = "参数结构定义实体") +@ApiModel(description = "en: Parameter structure definition entity,zh: 参数结构定义实体") public class ParamDefine { + /** + * Parameter Structure ID + */ @Id @GeneratedValue(strategy = GenerationType.IDENTITY) @ApiModelProperty(value = "参数结构ID", example = "87584674384", accessMode = READ_ONLY, position = 0) private Long id; /** + * Monitoring application type name * 监控应用类型名称 */ @ApiModelProperty(value = "监控类型", example = "TanCloud", accessMode = READ_WRITE, position = 1) private String app; /** + * Parameter field external display name * 参数字段对外显示名称 */ @ApiModelProperty(value = "参数字段显示名称", example = "端口", accessMode = READ_WRITE, position = 2) private String name; /** + * Parameter Field Identifier * 参数字段标识符 */ @ApiModelProperty(value = "参数字段标识符", example = "port", accessMode = READ_WRITE, position = 3) private String field; /** + * Field type, style (mostly map the input tag type attribute) * 字段类型,样式(大部分映射input标签type属性) */ @ApiModelProperty(value = "字段类型,样式(大部分映射input标签type属性)", example = "number", accessMode = READ_WRITE, position = 4) private String type; /** + * Is it mandatory true-required false-optional * 是否是必输项 true-必填 false-可选 */ @ApiModelProperty(value = "是否是必输项 true-必填 false-可选", example = "true", accessMode = READ_WRITE, position = 5) private boolean required = false; /** + * Parameter Default Value * 参数默认值 */ @ApiModelProperty(value = "参数默认值", example = "12", accessMode = READ_WRITE, position = 6) private String defaultValue; /** + * Parameter input box prompt information * 参数输入框提示信息 */ @ApiModelProperty(value = "参数输入框提示信息", example = "请输入密码", accessMode = READ_WRITE, position = 7) private String placeholder; /** + * When type is number, use range to represent the range eg: 0-233 * 当type为number时,用range表示范围 eg: 0-233 */ @ApiModelProperty(value = "当type为number时,用range区间表示范围", example = "[0,233]", accessMode = READ_WRITE, position = 6) @@ -90,6 +103,7 @@ public class ParamDefine { private String range; /** + * When type is text, use limit to indicate the limit size of the string. The maximum is 255 * 当type为text时,用limit表示字符串限制大小.最大255 */ @ApiModelProperty(value = "当type为text时,用limit表示字符串限制大小.最大255", example = "30", accessMode = READ_WRITE, position = 7) @@ -97,10 +111,11 @@ public class ParamDefine { private Short limit; /** + * When the type is radio radio box, checkbox checkbox, options represents a list of optional values * 当type为radio单选框,checkbox复选框时,options表示可选项值列表 * eg: { - * "key1":"value1", - * "key2":"value2" + * "key1":"value1", + * "key2":"value2" * } * key-值显示标签 * value-真正值 @@ -111,36 +126,42 @@ public class ParamDefine { private List