接口注释

This commit is contained in:
shenshang 2023-06-25 17:03:03 +08:00
parent da563a9d78
commit 3ca81f6472
5 changed files with 16 additions and 1 deletions

View File

@ -1,6 +1,7 @@
package cn.axzo.workflow.core.service.dto;
import cn.axzo.workflow.core.common.enums.BpmFlowNodeType;
import io.swagger.annotations.ApiModelProperty;
import java.util.List;
@ -10,16 +11,23 @@ public class BpmJsonNode {
}
@ApiModelProperty(value = "节点ID", required = true)
private String id;
@ApiModelProperty(value = "父节点ID", required = true)
private String parentId;
/**
* {@link BpmFlowNodeType}
* */
@ApiModelProperty(value = "节点类型task/branch", required = true)
private String type; // task, branch,
@ApiModelProperty(value = "节点名称", required = true)
private String name;
@ApiModelProperty(value = "节点描述", required = true)
private String desc;
// private Map<> properties; //ext : Object; 会签/或签
@ApiModelProperty(value = "子节点信息", required = true)
private BpmJsonNode children;
@ApiModelProperty(value = "分支节点信息", required = true)
private List<BpmJsonNode> branches;

View File

@ -42,16 +42,19 @@ public class BpmModelCreateDTO {
/**
* MetaInfo 自定义数据可以放icon等任何
* */
@ApiModelProperty(value = "MetaInfo 自定义数据可以放icon等任何", example = "1")
private Object metaInfo;
/**
* 流程的Json 结构
*
* */
@ApiModelProperty(value = "流程的Json 结构", example = "1")
private BpmJsonNode node;
/**
* 租户Id
* */
@ApiModelProperty(value = "租户Id", example = "1")
private String tenantId;
}

View File

@ -1,5 +1,6 @@
package cn.axzo.workflow.core.service.dto.request.model;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
@ -9,6 +10,7 @@ import lombok.Data;
@Data
public class BpmModelUpdateDTO extends BpmModelCreateDTO{
@ApiModelProperty(value = "ID", required = true)
private Long id;
}

View File

@ -1,6 +1,7 @@
package cn.axzo.workflow.core.service.dto.response.model;
import cn.axzo.workflow.core.service.dto.BpmJsonNode;
import io.swagger.annotations.ApiModelProperty;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.ToString;
@ -14,6 +15,7 @@ public class BpmModelDetailVO extends BpmModelBaseVO{
* 流程的 Json 结构
*
* */
@ApiModelProperty(value = "流程的 Json 结构", required = true)
private BpmJsonNode bpmJson;
}

View File

@ -35,6 +35,6 @@ CREATE TABLE `system_dict_data` (
`create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`updater` varchar(64) CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci DEFAULT '' COMMENT '更新者',
`update_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
`deleted` bit(1) NOT NULL DEFAULT b'0' COMMENT '是否删除',
`deleted` bit(1) NOT NULL DEFAULT '0' COMMENT '是否删除',
PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1161 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci ROW_FORMAT=DYNAMIC COMMENT='字典数据表'