Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(api/story): change ID type from Multi[int] to Multi[int64] #64

Merged
merged 10 commits into from
Mar 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 22 additions & 22 deletions api_story.go
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ func (s *StoryService) GetStories(
}

type GetStoriesRequest struct {
ID *Multi[int] `url:"id,omitempty"` // ID 支持多ID查询,多个ID用逗号分隔
ID *Multi[int64] `url:"id,omitempty"` // ID 支持多ID查询,多个ID用逗号分隔
Name *string `url:"name,omitempty"` // 标题 支持模糊匹配
Priority *string `url:"priority,omitempty"` // 优先级
PriorityLabel *PriorityLabel `url:"priority_label,omitempty"` // 优先级。推荐使用这个字段
Expand Down Expand Up @@ -644,7 +644,7 @@ func (s *StoryService) GetStoriesCount(
}

type GetStoriesCountRequest struct {
ID *Multi[int] `url:"id,omitempty"` // ID 支持多ID查询,多个ID用逗号分隔
ID *Multi[int64] `url:"id,omitempty"` // ID 支持多ID查询,多个ID用逗号分隔
Name *string `url:"name,omitempty"` // 标题 支持模糊匹配
Priority *string `url:"priority,omitempty"` // 优先级。
PriorityLabel *PriorityLabel `url:"priority_label,omitempty"` // 优先级。推荐使用这个字段
Expand Down Expand Up @@ -925,7 +925,7 @@ func (s *StoryService) GetStoryCategories(

type GetStoryCategoriesRequest struct {
WorkspaceID *int `url:"workspace_id,omitempty"` // [必须]项目ID
ID *Multi[int] `url:"id,omitempty"` // ID 支持多ID查询,多个ID用逗号分隔
ID *Multi[int64] `url:"id,omitempty"` // ID 支持多ID查询,多个ID用逗号分隔
Name *string `url:"name,omitempty"` // 需求分类名称 支持模糊匹配
Description *string `url:"description,omitempty"` // 需求分类描述
ParentID *int `url:"parent_id,omitempty"` // 父分类ID
Expand Down Expand Up @@ -954,13 +954,13 @@ type StoryCategory struct {
// -----------------------------------------------------------------------------

type GetStoryCategoriesCountRequest struct {
WorkspaceID *int `url:"workspace_id,omitempty"` // [必须]项目ID
ID *Multi[int] `url:"id,omitempty"` // ID 支持多ID查询,多个ID用逗号分隔
Name *string `url:"name,omitempty"` // 需求分类名称 支持模糊匹配
Description *string `url:"description,omitempty"` // 需求分类描述
ParentID *int `url:"parent_id,omitempty"` // 父分类ID
Created *string `url:"created,omitempty"` // 创建时间 支持时间查询
Modified *string `url:"modified,omitempty"` // 最后修改时间 支持时间查询
WorkspaceID *int `url:"workspace_id,omitempty"` // [必须]项目ID
ID *Multi[int64] `url:"id,omitempty"` // ID 支持多ID查询,多个ID用逗号分隔
Name *string `url:"name,omitempty"` // 需求分类名称 支持模糊匹配
Description *string `url:"description,omitempty"` // 需求分类描述
ParentID *int `url:"parent_id,omitempty"` // 父分类ID
Created *string `url:"created,omitempty"` // 创建时间 支持时间查询
Modified *string `url:"modified,omitempty"` // 最后修改时间 支持时间查询
}

// GetStoryCategoriesCount 获取需求分类数量
Expand Down Expand Up @@ -988,8 +988,8 @@ func (s *StoryService) GetStoryCategoriesCount(
// -----------------------------------------------------------------------------

type GetStoriesCountByCategoriesRequest struct {
WorkspaceID *int `url:"workspace_id,omitempty"` // [必须]项目ID
CategoryID *Multi[int] `url:"category_id,omitempty"` // 需求分类 支持多ID。比如 id1,id2,id3
WorkspaceID *int `url:"workspace_id,omitempty"` // [必须]项目ID
CategoryID *Multi[int64] `url:"category_id,omitempty"` // 需求分类 支持多ID。比如 id1,id2,id3
}

type StoriesCountByCategory struct {
Expand Down Expand Up @@ -1078,8 +1078,8 @@ const (
)

type GetStoryChangesRequest struct {
ID *Multi[int] `url:"id,omitempty"`
StoryID *Multi[int] `url:"story_id,omitempty"` // 需求id 支持多ID查询
ID *Multi[int64] `url:"id,omitempty"`
StoryID *Multi[int64] `url:"story_id,omitempty"` // 需求id 支持多ID查询
WorkspaceID *int `url:"workspace_id,omitempty"` // [必须]项目ID
Creator *string `url:"creator,omitempty"` // 创建人(操作人)
Created *string `url:"created,omitempty"` // 创建时间(变更时间) 支持时间查询
Expand Down Expand Up @@ -1226,7 +1226,7 @@ func (s *StoryService) UpdateStory(
}

type UpdateStoryRequest struct {
ID *int `json:"id"` // 必须
ID *int64 `json:"id"` // 必须
WorkspaceID *int `json:"workspace_id"` // 必须
Name *string `json:"name,omitempty"` // 标题
Priority *string `json:"priority,omitempty"` // 优先级。
Expand All @@ -1249,7 +1249,7 @@ type UpdateStoryRequest struct {
EffortCompleted *string `json:"effort_completed,omitempty"` // 完成工时
Remain *float64 `json:"remain,omitempty"` // 剩余工时
Exceed *float64 `json:"exceed,omitempty"` // 超出工时
CategoryID *int `json:"category_id,omitempty"` // 需求分类ID
CategoryID *int64 `json:"category_id,omitempty"` // 需求分类ID
ReleaseID *int `json:"release_id,omitempty"` // 发布计划ID
Source *string `json:"source,omitempty"` // 来源
Type *string `json:"type,omitempty"` // 类型
Expand Down Expand Up @@ -1550,8 +1550,8 @@ func (s *StoryService) GetStoryTemplateFields(
}

type GetStoryTemplateFieldsRequest struct {
WorkspaceID *int `url:"workspace_id,omitempty"` // [必须]项目ID
TemplateID *int `url:"template_id,omitempty"` // [必须]模板ID
WorkspaceID *int `url:"workspace_id,omitempty"` // [必须]项目ID
TemplateID *int64 `url:"template_id,omitempty"` // [必须]模板ID
}

type StoryTemplateField struct {
Expand Down Expand Up @@ -1639,8 +1639,8 @@ func (s *StoryService) GetStoryRelatedBugs(
}

type GetStoryRelatedBugsRequest struct {
WorkspaceID *int `url:"workspace_id,omitempty"`
StoryID *Multi[int] `url:"story_id,omitempty"`
WorkspaceID *int `url:"workspace_id,omitempty"`
StoryID *Multi[int64] `url:"story_id,omitempty"`
}

type StoryRelatedBug struct {
Expand Down Expand Up @@ -1694,8 +1694,8 @@ func (s *StoryService) GetConvertStoryIDsToQueryToken(
}

type GetConvertStoryIDsToQueryTokenRequest struct {
WorkspaceID *int `json:"workspace_id,omitempty"` // 项目ID
StoryIDs *Multi[int] `json:"ids,omitempty"` // 需求ID
WorkspaceID *int `json:"workspace_id,omitempty"` // 项目ID
StoryIDs *Multi[int64] `json:"ids,omitempty"` // 需求ID
}

type GetConvertStoryIDsToQueryTokenResponse struct {
Expand Down
14 changes: 7 additions & 7 deletions api_story_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ func TestStoryService_GetStoryCategories(t *testing.T) {

categories, _, err := client.StoryService.GetStoryCategories(ctx, &GetStoryCategoriesRequest{
WorkspaceID: Ptr(11112222),
ID: NewMulti(1111111111111, 1111111111112),
ID: NewMulti[int64](1111111111111, 1111111111112),
Name: Ptr("test name"),
Description: Ptr("test description"),
ParentID: Ptr(1111111111111),
Expand Down Expand Up @@ -72,7 +72,7 @@ func TestStoryService_GetStoryCategoriesCount(t *testing.T) {

count, _, err := client.StoryService.GetStoryCategoriesCount(ctx, &GetStoryCategoriesCountRequest{
WorkspaceID: Ptr(11112222),
ID: NewMulti(1111111111111, 1111111111112),
ID: NewMulti[int64](1111111111111, 1111111111112),
Name: Ptr("test name"),
Description: Ptr("test description"),
ParentID: Ptr(1111111111111),
Expand All @@ -96,7 +96,7 @@ func TestStoryService_GetStoriesCountByCategories(t *testing.T) {

counts, _, err := client.StoryService.GetStoriesCountByCategories(ctx, &GetStoriesCountByCategoriesRequest{
WorkspaceID: Ptr(11112222),
CategoryID: NewMulti(1111112222001000103, 1111112222001000108),
CategoryID: NewMulti[int64](1111112222001000103, 1111112222001000108),
})
assert.NoError(t, err)
assert.True(t, len(counts) > 0)
Expand All @@ -118,7 +118,7 @@ func TestStoryService_GetStoryChanges(t *testing.T) {
}))

storyChanges, _, err := client.StoryService.GetStoryChanges(ctx, &GetStoryChangesRequest{
StoryID: NewMulti(1111112222001000103, 1111112222001000108),
StoryID: NewMulti[int64](1111112222001000103, 1111112222001000108),
WorkspaceID: Ptr(11112222),
})
assert.NoError(t, err)
Expand Down Expand Up @@ -192,7 +192,7 @@ func TestStoryService_GetStoryRelatedBugs(t *testing.T) {

relatedBugs, _, err := client.StoryService.GetStoryRelatedBugs(ctx, &GetStoryRelatedBugsRequest{
WorkspaceID: Ptr(11112222),
StoryID: NewMulti(33334444, 55556666),
StoryID: NewMulti[int64](33334444, 55556666),
})
assert.NoError(t, err)
assert.True(t, len(relatedBugs) > 0)
Expand Down Expand Up @@ -240,7 +240,7 @@ func TestStoryService_GetStoryTemplateFields(t *testing.T) {

fields, _, err := client.StoryService.GetStoryTemplateFields(ctx, &GetStoryTemplateFieldsRequest{
WorkspaceID: Ptr(11112222),
TemplateID: Ptr(1111111111111),
TemplateID: Ptr(int64(1111111111111)),
})
assert.NoError(t, err)
assert.True(t, len(fields) > 0)
Expand Down Expand Up @@ -311,7 +311,7 @@ func TestStoryService_GetConvertStoryIDsToQueryToken(t *testing.T) {

response, _, err := client.StoryService.GetConvertStoryIDsToQueryToken(ctx, &GetConvertStoryIDsToQueryTokenRequest{
WorkspaceID: Ptr(11112222),
StoryIDs: NewMulti(33334444, 55556666),
StoryIDs: NewMulti[int64](33334444, 55556666),
})
assert.NoError(t, err)
assert.Equal(t, "11111111111", response.QueryToken)
Expand Down
2 changes: 1 addition & 1 deletion features.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ API 文档:https://open.tapd.cn/document/api-doc/API%E6%96%87%E6%A1%A3/
- [x] 获取需求模板列表
- [x] 获取需求模板字段
- [ ] 更新需求分类
- [x] 获取回收站下的需求
- [ ] 获取回收站下的需求
- [x] 获取需求关联的缺陷
- [ ] 解除需求缺陷关联关系
- [ ] 更新父需求
Expand Down
Loading