- 移除 TodoItem 中的 priority、created_at 和 updated_at 字段 - 强制每个任务都必须有唯一 id,且由用户负责生成 - 修改合并模式逻辑,merge=true 下保留未提及的旧任务 - 支持已完成和已取消任务重新激活(状态改回 pending 或 in_progress) - 禁止 in_progress 状态退回到 pending,必须标记为 completed 或 cancelled - 优化状态转换校验,允许特定状态间合法切换 - 简化任务变更消息,移除详细的新增/更新/移除统计 - 更新文档和示例,明确 id 必须由用户生成和使用 - 修复和补充测试,增强状态转换和合并模式验证 - 调整任务时间戳生成逻辑,统一使用当前时间及索引 - 该变更提供更合理的任务状态机械及管理模式,提升稳定性和易用性
81 lines
3.2 KiB
Markdown
81 lines
3.2 KiB
Markdown
# okr +progress-list
|
||
|
||
> **前置条件:** 先阅读 [`lark-shared/SKILL.md`](../../lark-shared/SKILL.md) 了解认证、全局参数和安全规则。
|
||
|
||
获取目标(Objective)或关键结果(Key Result)的所有进展记录列表。
|
||
|
||
## 推荐命令
|
||
|
||
```bash
|
||
# 获取目标的所有进展记录
|
||
lark-cli okr +progress-list \
|
||
--target-id 1234567890123456789 \
|
||
--target-type objective
|
||
|
||
# 获取关键结果的所有进展记录
|
||
lark-cli okr +progress-list \
|
||
--target-id 9876543210987654321 \
|
||
--target-type key_result
|
||
```
|
||
|
||
## 参数
|
||
|
||
| 参数 | 必填 | 默认值 | 说明 |
|
||
|-------------------------|----|--------------------|--------------------------------------------------|
|
||
| `--target-id` | 是 | — | 目标 ID 或关键结果 ID(int64 类型,正整数) |
|
||
| `--target-type` | 是 | — | 目标类型:`objective` \| `key_result` |
|
||
| `--user-id-type` | 否 | `open_id` | 用户 ID 类型:`open_id` \| `union_id` \| `user_id` |
|
||
| `--department-id-type` | 否 | `open_department_id` | 部门 ID 类型:`department_id` \| `open_department_id` |
|
||
| `--dry-run` | 否 | — | 预览 API 调用而不实际执行。 |
|
||
| `--format` | 否 | `json` | 输出格式。 |
|
||
|
||
## 工作流程
|
||
|
||
1. 使用 `+cycle-list` 和 `+cycle-detail` 获取目标或关键结果的 ID。
|
||
2. 执行 `lark-cli okr +progress-list --target-id "..." --target-type objective`。
|
||
3. 获取该目标或关键结果下的所有进展记录列表。
|
||
|
||
## 输出
|
||
|
||
返回 JSON:
|
||
|
||
```json
|
||
{
|
||
"progress": [
|
||
{
|
||
"progress_id": "1234567890123456789",
|
||
"modify_time": "2025-01-15 10:30:00",
|
||
"content": "{...}",
|
||
"progress_rate": {
|
||
"percent": 80.0,
|
||
"status": "done"
|
||
}
|
||
}
|
||
],
|
||
"total": 1
|
||
}
|
||
```
|
||
|
||
其中:
|
||
|
||
- `progress` — 进展记录数组
|
||
- `content` 字段是 JSON 字符串,为 OKR ContentBlock 富文本格式。请参考 [lark-okr-contentblock.md](lark-okr-contentblock.md) 了解详细信息。
|
||
- `progress_rate.status` 返回可读字符串:`normal`(正常)、`overdue`(逾期)、`done`(已完成)。
|
||
|
||
## 与 +progress-get 的区别
|
||
|
||
| 命令 | 用途 | API 版本 |
|
||
|------------------|------------------------------------|----------|
|
||
| `+progress-list` | 获取某个目标/关键结果的所有进展记录 | v2 |
|
||
| `+progress-get` | 根据进展记录 ID 获取单条记录 | v1 |
|
||
|
||
`+progress-list` 返回的 `progress_list` 数组中每条记录的结构与 `+progress-get` 返回的 `progress` 结构相同。
|
||
|
||
## 参考
|
||
|
||
- [lark-okr](../SKILL.md) -- 所有 OKR 命令(shortcut 和 API 接口)
|
||
- [ContentBlock 格式](lark-okr-contentblock.md) -- 进展内容使用的富文本格式
|
||
- [lark-okr-progress-get](lark-okr-progress-get.md) -- 根据 ID 获取单条进展记录
|
||
- [lark-okr-progress-create](lark-okr-progress-create.md) -- 创建进展记录
|
||
- [lark-shared](../../lark-shared/SKILL.md) -- 认证和全局参数
|