Skip to content

Commit 9c83bf8

Browse files
lincg-bytedanceAime
andcommitted
feat: document compound field group update and WBS view flags
- 验证并对齐“按组更新复合字段值”接口实现,补充 UpdateCompoundFieldValueReq/Resp 及 WorkItemService 接口的 Javadoc,说明 OpenAPI 路径、支持的 action 类型以及按组更新语义 - 为获取工作流详情(WBS)的 WbsViewReq 请求对象和 Builder 新增文档注释,明确 need_union_deliverable 与 need_schedule_table_agg 两个查询参数的含义和行为,对齐官方 WBS 能力说明 - 通过 `mvn clean package` 本地构建,确认新增注释不会影响编译与打包 Co-Authored-By: Aime <aime@bytedance.com> Change-Id: If579bcf767cb2d4fde1ea629aecaed6c7d0c387a
1 parent 626aad1 commit 9c83bf8

File tree

4 files changed

+43
-3
lines changed

4 files changed

+43
-3
lines changed

src/main/java/com/lark/project/service/workitem/WorkItemService.java

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,10 +99,22 @@ public interface WorkItemService {
9999
// 更新实际工时
100100
public UpdateWorkingHourRecordResp updateWorkingHourRecord(UpdateWorkingHourRecordReq req, RequestOptions reqOptions) throws Exception;
101101

102-
// 获取工作流详情(wbs)
102+
/**
103+
* 获取工作流详情(WBS)。
104+
*
105+
* <p>对应 OpenAPI:{@code GET /open_api/:project_key/work_item/:work_item_type_key/:work_item_id/wbs_view}。</p>
106+
*
107+
* <p>请求中可通过 {@code need_union_deliverable} 和 {@code need_schedule_table_agg}
108+
* 参数控制返回是否包含融合交付物以及计划表自定义列聚合字段。</p>
109+
*/
103110
public WbsViewResp wbsView(WbsViewReq req, RequestOptions reqOptions) throws Exception;
104111

105-
//增量更新复合字段
106-
UpdateCompoundFieldValueResp updateCompoundFieldValue(UpdateCompoundFieldValueReq req, RequestOptions reqOptions) throws Exception;
112+
/**
113+
* 按组更新复合字段值。
114+
*
115+
* <p>对应 OpenAPI:{@code POST /open_api/work_item/field_value/update_compound_field},
116+
* 支持对指定工作项的复合字段按组执行删除(delete)、更新(update)或添加(add)操作。</p>
117+
*/
118+
public UpdateCompoundFieldValueResp updateCompoundFieldValue(UpdateCompoundFieldValueReq req, RequestOptions reqOptions) throws Exception;
107119

108120
}

src/main/java/com/lark/project/service/workitem/builder/UpdateCompoundFieldValueReq.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66

77
import java.util.List;
88

9+
/**
10+
* 按组更新复合字段值的请求对象。
11+
*
12+
* <p>对应 OpenAPI:{@code POST /open_api/work_item/field_value/update_compound_field},
13+
* 用于对指定工作项的复合字段按组执行删除(delete)、更新(update)或添加(add)操作。</p>
14+
*/
915
public class UpdateCompoundFieldValueReq {
1016
@Body
1117
private UpdateCompoundFieldValueReqBody body;

src/main/java/com/lark/project/service/workitem/builder/UpdateCompoundFieldValueResp.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,11 @@
22

33
import com.lark.project.core.response.BaseResponse;
44

5+
/**
6+
* 按组更新复合字段值的响应对象。
7+
*
8+
* <p>对应 OpenAPI:{@code POST /open_api/work_item/field_value/update_compound_field},
9+
* 返回请求是否执行成功以及错误码信息。</p>
10+
*/
511
public class UpdateCompoundFieldValueResp extends BaseResponse {
612
}

src/main/java/com/lark/project/service/workitem/builder/WbsViewReq.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@
2222
import com.lark.project.core.annotation.Query;
2323
import com.lark.project.service.workitem.model.Expand;
2424

25+
/**
26+
* 获取工作流详情(WBS)的请求对象。
27+
*
28+
* <p>对应 OpenAPI:{@code GET /open_api/:project_key/work_item/:work_item_type_key/:work_item_id/wbs_view}。</p>
29+
*/
2530
public class WbsViewReq {
2631
@Path
2732
@SerializedName("project_key")
@@ -129,11 +134,22 @@ public Builder workItemID(Long workItemID) {
129134
return this;
130135
}
131136

137+
/**
138+
* 是否融合需要交付物。
139+
*
140+
* <p>对应查询参数 {@code need_union_deliverable},含义与请求体
141+
* {@link Expand#getNeedUnionDeliverable()} 一致。</p>
142+
*/
132143
public Builder needUnionDeliverable(Boolean needUnionDeliverable) {
133144
this.needUnionDeliverable = needUnionDeliverable;
134145
return this;
135146
}
136147

148+
/**
149+
* 扩展查询:是否需要计划表自定义列聚合字段。
150+
*
151+
* <p>对应查询参数 {@code need_schedule_table_agg}。</p>
152+
*/
137153
public Builder needScheduleTableAgg(Boolean needScheduleTableAgg) {
138154
this.needScheduleTableAgg = needScheduleTableAgg;
139155
return this;

0 commit comments

Comments
 (0)