Skip to content

features.md

Latest commit

 

History

History
294 lines (234 loc) · 7.25 KB

features.md

File metadata and controls

294 lines (234 loc) · 7.25 KB
Raw

Feature Coverage

This file tracks TAPD CLI feature coverage.

The SDK coverage ledger lives in the TAPD SDK repository: github.com/go-tapd/tapd/features.md.

Note

This file is command-oriented. A checked item means the CLI exposes a user-facing command, not merely that the SDK implements the API.

When adding a command, confirm the matching typed API already exists in github.com/go-tapd/tapd before wiring it into the CLI.

开发说明：

1、CLI 命令应优先复用 go-tapd/tapd SDK 的 typed service、request 和 response，不在 CLI 内手写 HTTP 请求。
2、列表和详情类命令默认支持 table 输出，并支持 --format json。
3、需要项目上下文的命令统一使用 --workspace-id / -w。
4、只读命令优先于写操作命令；写操作命令应先明确 flag 契约、必填字段和输出形态。
5、SDK features.md 中标注为 “AI 实现，未人工验证” 的接口，接入 CLI 前应额外谨慎。

基础能力

  • tapd login
  • tapd login --auth-method pat
  • tapd login --auth-method basic
  • tapd login --workspace-id <id> 登录时验证项目访问权限
  • tapd auth status
  • tapd auth logout
  • --config <path> 指定配置文件
  • --base-url <url> 覆盖 TAPD API 地址
  • --format table|json
  • tapd api <endpoint> 原始 TAPD API 调用兜底能力
  • Shell completion 文档与安装说明

研发协作 API

需求

  • tapd story create
  • tapd story view
  • tapd story list
  • tapd story count
  • tapd story update
  • tapd story batch-update
  • tapd story categories
  • tapd story categories count
  • tapd story changes
  • tapd story changes count
  • tapd story fields
  • tapd story field-labels
  • tapd story templates
  • tapd story template-fields
  • tapd story removed
  • tapd story related-bugs
  • tapd story related-test-cases
  • tapd story by-view
  • tapd story convert-ids

缺陷

  • tapd bug create
  • tapd bug copy
  • tapd bug view
  • tapd bug list
  • tapd bug count
  • tapd bug update
  • tapd bug batch-update
  • tapd bug changes
  • tapd bug changes count
  • tapd bug fields
  • tapd bug custom-field-settings
  • tapd bug field-labels
  • tapd bug templates
  • tapd bug template-fields
  • tapd bug removed
  • tapd bug related-stories
  • tapd bug links
  • tapd bug link
  • tapd bug unlink
  • tapd bug update-system-options
  • tapd bug by-view
  • tapd bug convert-ids
  • 缺陷说明：docs/bug.md

迭代

  • tapd iteration create
  • tapd iteration view
  • tapd iteration list
  • tapd iteration count
  • tapd iteration update
  • tapd iteration changes
  • tapd iteration fields
  • tapd iteration workitem-types
  • tapd iteration templates
  • tapd iteration template-fields
  • tapd iteration lock
  • tapd iteration unlock

任务

  • tapd task create
  • tapd task view
  • tapd task list
  • tapd task count
  • tapd task update
  • tapd task batch-update
  • tapd task changes
  • tapd task changes count
  • tapd task fields
  • tapd task removed
  • tapd task by-view SDK 暂未实现

测试

  • tapd test-case create
  • tapd test-case list
  • tapd test-case count
  • tapd test-case update
  • tapd test-case categories
  • tapd test-case fields
  • tapd test-case results
  • tapd test-plan create
  • tapd test-plan list
  • tapd test-plan count
  • tapd test-plan update
  • tapd test-plan progress
  • tapd test-plan result
  • tapd test-plan related-bugs
  • tapd test-plan related-stories
  • 测试说明：docs/test.md

发布

  • tapd release create
  • tapd release view
  • tapd release list
  • tapd release count
  • tapd release update
  • tapd launch-form create
  • tapd launch-form list
  • tapd launch-form count
  • tapd launch-form fields
  • tapd launch-form templates
  • tapd launch-form logs

源码

  • tapd source commit add
  • tapd source commit list
  • tapd source commit objects

Wiki

  • tapd wiki create
  • tapd wiki list
  • tapd wiki count
  • tapd wiki update
  • tapd wiki drawio
  • tapd wiki followers
  • tapd wiki followers count
  • tapd wiki permissions
  • tapd wiki tags
  • tapd wiki tags count
  • tapd wiki attachments count

看板

  • tapd board card create
  • tapd board card list
  • tapd board card update
  • tapd board columns

评论

  • tapd comment create
  • tapd comment list
  • tapd comment count
  • tapd comment update

报表

  • tapd report list

附件

  • tapd attachment upload
  • tapd attachment upload-image-base64
  • tapd attachment list
  • tapd attachment download-url
  • tapd attachment image-url
  • tapd attachment document-url

度量

  • tapd measure life-times

工时

  • tapd timesheet create
  • tapd timesheet list
  • tapd timesheet count
  • tapd timesheet update
  • tapd timesheet delete

项目

  • tapd workspace view
  • tapd workspace users
  • tapd workspace roles
  • tapd workspace sub-workspaces
  • tapd workspace company-workspaces
  • tapd workspace participant-workspaces
  • tapd workspace add-member
  • tapd workspace update
  • tapd workspace custom-fields
  • tapd workspace documents
  • tapd workspace short-id convert
  • tapd workspace member-activity-log
  • tapd workspace calendar set-custom
  • tapd workspace calendar enable
  • tapd workspace calendar view-custom
  • tapd workspace calendar settings

工作流

  • tapd workflow last-steps

配置

  • tapd setting workspace

标签

  • tapd label create
  • tapd label list
  • tapd label count
  • tapd label update

用户

  • tapd user roles

Webhook

  • tapd webhook serve
  • tapd webhook validate
  • tapd webhook inspect
  • Webhook 说明：docs/webhook.md

轻协作 API

SDK 当前对轻协作 API 覆盖较少。除评论可通过通用 CommentService 的 mini_items 类型接入外，其余条目暂未发现对应 typed service。

工作项

  • tapd lite workitem create
  • tapd lite workitem list
  • tapd lite workitem count
  • tapd lite workitem update

空间

  • tapd lite space view
  • tapd lite space create
  • tapd lite space members
  • tapd lite space add-member

评论

  • tapd lite comment create
  • tapd lite comment list
  • tapd lite comment count
  • tapd lite comment update
  • 轻协作评论说明：docs/lite.md

附件

  • tapd lite attachment upload
  • tapd lite attachment list
  • tapd lite attachment download-url

应用集成-工蜂

  • tapd lite git branch link
  • tapd lite git branch unlink
  • tapd lite git branch workitems
  • tapd lite git commit add
  • tapd lite git commit objects