sino-bc-cli 1.8.9 → 1.8.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +124 -97
- package/dist/SKILL.md +83 -30
- package/dist/affordance/auth.md +27 -0
- package/dist/affordance/biz-line.md +11 -11
- package/dist/affordance/dashboard.md +73 -0
- package/dist/affordance/delivery.md +81 -0
- package/dist/affordance/document.md +69 -0
- package/dist/affordance/file.md +43 -0
- package/dist/affordance/im.md +66 -0
- package/dist/affordance/organization.md +45 -0
- package/dist/affordance/project-analysis.md +75 -0
- package/dist/affordance/project-stage.md +40 -0
- package/dist/affordance/project.md +199 -0
- package/dist/affordance/sso.md +1 -1
- package/dist/affordance/task.md +109 -0
- package/dist/affordance/tenant.md +15 -0
- package/dist/affordance/user.md +33 -0
- package/dist/api-doc/README.md +51 -0
- package/dist/api-doc/custom/cli-oauth.md +19 -0
- package/dist/api-doc/oapi/auth.md +57 -0
- package/dist/api-doc/oapi/biz-line-query.md +9 -1
- package/dist/api-doc/oapi/biz-line-strategy.md +500 -312
- package/dist/api-doc/oapi/dashboard.md +202 -0
- package/dist/api-doc/oapi/delivery.md +253 -0
- package/dist/api-doc/oapi/document.md +192 -0
- package/dist/api-doc/oapi/file.md +92 -0
- package/dist/api-doc/oapi/im.md +195 -0
- package/dist/api-doc/oapi/organization.md +86 -0
- package/dist/api-doc/oapi/project-analysis.md +252 -0
- package/dist/api-doc/oapi/project-stage.md +88 -0
- package/dist/api-doc/oapi/project.md +597 -0
- package/dist/api-doc/oapi/sso.md +5 -1
- package/dist/api-doc/oapi/task.md +361 -0
- package/dist/api-doc/oapi/tenant.md +17 -0
- package/dist/api-doc/oapi/user.md +73 -0
- package/dist/generated/api-catalog.json +23976 -143
- package/dist/index.js +1 -1
- package/dist/skills/default/sino-bc-shared/SKILL.md +18 -7
- package/dist/skills/default/sino-bc-shared/references/config-and-env.md +10 -7
- package/dist/skills/default/sino-bc-shared/references/output-contract.md +52 -7
- package/dist/skills/default/sino-bc-shared/references/write-approval.md +4 -4
- package/dist/skills/oapi/sino-bc-auth/SKILL.md +34 -0
- package/dist/skills/oapi/sino-bc-biz-line/SKILL.md +45 -40
- package/dist/skills/oapi/sino-bc-biz-line/references/common-mistakes.md +10 -0
- package/dist/skills/{custom → oapi}/sino-bc-biz-line/references/enums.md +7 -1
- package/dist/skills/oapi/sino-bc-dashboard/SKILL.md +48 -0
- package/dist/skills/oapi/sino-bc-delivery/SKILL.md +53 -0
- package/dist/skills/oapi/sino-bc-document/SKILL.md +51 -0
- package/dist/skills/oapi/sino-bc-file/SKILL.md +46 -0
- package/dist/skills/oapi/sino-bc-im/SKILL.md +49 -0
- package/dist/skills/oapi/sino-bc-organization/SKILL.md +44 -0
- package/dist/skills/oapi/sino-bc-project/SKILL.md +69 -0
- package/dist/skills/oapi/sino-bc-project-analysis/SKILL.md +48 -0
- package/dist/skills/oapi/sino-bc-project-analysis/references/analysis-workflow.md +17 -0
- package/dist/skills/oapi/sino-bc-project-analysis/references/filters-and-metrics.md +32 -0
- package/dist/skills/oapi/sino-bc-project-stage/SKILL.md +47 -0
- package/dist/skills/oapi/sino-bc-sso/SKILL.md +15 -17
- package/dist/skills/oapi/sino-bc-task/SKILL.md +57 -0
- package/dist/skills/oapi/sino-bc-task/references/state-machine.md +18 -0
- package/dist/skills/oapi/sino-bc-tenant/SKILL.md +32 -0
- package/dist/skills/oapi/sino-bc-user/SKILL.md +48 -0
- package/package.json +4 -5
- package/dist/api-doc/custom/README.md +0 -92
- package/dist/skills/custom/sino-bc-biz-line/references/common-mistakes.md +0 -8
- package/dist/skills/oapi/sino-bc-biz-line/references/long-tail-api.md +0 -18
- package/dist/skills/oapi/sino-bc-sso/references/long-tail-api.md +0 -9
|
@@ -0,0 +1,199 @@
|
|
|
1
|
+
# project 命令何时用
|
|
2
|
+
|
|
3
|
+
字段口径在 `src/api-doc/`,这里只写 WHEN / 别用 / 示例。
|
|
4
|
+
|
|
5
|
+
## +page-by-project
|
|
6
|
+
|
|
7
|
+
- **WHEN**:按项目查询最新操作日志(分页倒序)
|
|
8
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
9
|
+
- **示例**:`sino-bc-cli project +page-by-project --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
10
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
11
|
+
|
|
12
|
+
## +budget-field-config
|
|
13
|
+
|
|
14
|
+
- **WHEN**:预算分布动态字段配置(按签约主体解析:主体 > 行业 > 不展示)
|
|
15
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
16
|
+
- **示例**:`sino-bc-cli project +budget-field-config --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
17
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
18
|
+
|
|
19
|
+
## +create
|
|
20
|
+
|
|
21
|
+
- **WHEN**:创建对客项目
|
|
22
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
23
|
+
- **示例**:`sino-bc-cli project +create --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
24
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
25
|
+
|
|
26
|
+
## +delete
|
|
27
|
+
|
|
28
|
+
- **WHEN**:删除对客项目
|
|
29
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
30
|
+
- **示例**:`sino-bc-cli project +delete --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
31
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
32
|
+
|
|
33
|
+
## +detail
|
|
34
|
+
|
|
35
|
+
- **WHEN**:对客项目详情(平铺 JSON:ext_json values + 业务组装字段)
|
|
36
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
37
|
+
- **示例**:`sino-bc-cli project +detail --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
38
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
39
|
+
- **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
|
|
40
|
+
|
|
41
|
+
## +industry-options
|
|
42
|
+
|
|
43
|
+
- **WHEN**:项目字段字典-下拉选项(按行业类型,适用于 SOURCE/GOAL/REGION/COUNTRY/MEDIA;industryType 可空,空则取当前签约主体行业)
|
|
44
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
45
|
+
- **示例**:`sino-bc-cli project +industry-options --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
46
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
47
|
+
- **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
|
|
48
|
+
|
|
49
|
+
## +industry-resolve
|
|
50
|
+
|
|
51
|
+
- **WHEN**:项目字段字典-批量解析 code->name(按行业类型)
|
|
52
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
53
|
+
- **示例**:`sino-bc-cli project +industry-resolve --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
54
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
55
|
+
|
|
56
|
+
## +options
|
|
57
|
+
|
|
58
|
+
- **WHEN**:项目字段字典-下拉选项(按签约主体,适用于 STATUS/TYPE/BUSINESS_LINE/MARKET_SCOPE)
|
|
59
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
60
|
+
- **示例**:`sino-bc-cli project +options --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
61
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
62
|
+
- **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
|
|
63
|
+
|
|
64
|
+
## +resolve
|
|
65
|
+
|
|
66
|
+
- **WHEN**:项目字段字典-批量解析 code->name(按签约主体)
|
|
67
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
68
|
+
- **示例**:`sino-bc-cli project +resolve --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
69
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
70
|
+
|
|
71
|
+
## +form-create
|
|
72
|
+
|
|
73
|
+
- **WHEN**:Formily 平铺 JSON 创建对客项目(从 body 取 templateType/templateId;响应同详情平铺)
|
|
74
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
75
|
+
- **示例**:`sino-bc-cli project +form-create --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
76
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
77
|
+
|
|
78
|
+
## +form-update
|
|
79
|
+
|
|
80
|
+
- **WHEN**:Formily 平铺 JSON 编辑对客项目(从 body 取 id/templateType/templateId;响应同详情平铺)
|
|
81
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
82
|
+
- **示例**:`sino-bc-cli project +form-update --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
83
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
84
|
+
|
|
85
|
+
## +batch-update-projects
|
|
86
|
+
|
|
87
|
+
- **WHEN**:批量修改项目分组(将指定项目移动到目标分组)
|
|
88
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
89
|
+
- **示例**:`sino-bc-cli project +batch-update-projects --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
90
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
91
|
+
|
|
92
|
+
## +group-create
|
|
93
|
+
|
|
94
|
+
- **WHEN**:创建项目分组
|
|
95
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
96
|
+
- **示例**:`sino-bc-cli project +group-create --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
97
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
98
|
+
|
|
99
|
+
## +group-delete
|
|
100
|
+
|
|
101
|
+
- **WHEN**:删除项目分组
|
|
102
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
103
|
+
- **示例**:`sino-bc-cli project +group-delete --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
104
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
105
|
+
|
|
106
|
+
## +group-detail
|
|
107
|
+
|
|
108
|
+
- **WHEN**:分组详情
|
|
109
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
110
|
+
- **示例**:`sino-bc-cli project +group-detail --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
111
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
112
|
+
- **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
|
|
113
|
+
|
|
114
|
+
## +group-list
|
|
115
|
+
|
|
116
|
+
- **WHEN**:分组列表(全量)
|
|
117
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
118
|
+
- **示例**:`sino-bc-cli project +group-list --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
119
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
120
|
+
|
|
121
|
+
## +group-update
|
|
122
|
+
|
|
123
|
+
- **WHEN**:更新项目分组名称
|
|
124
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
125
|
+
- **示例**:`sino-bc-cli project +group-update --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
126
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
127
|
+
|
|
128
|
+
## +list
|
|
129
|
+
|
|
130
|
+
- **WHEN**:对客项目列表(全量)
|
|
131
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
132
|
+
- **示例**:`sino-bc-cli project +list --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
133
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
134
|
+
|
|
135
|
+
## +invite
|
|
136
|
+
|
|
137
|
+
- **WHEN**:邀请项目成员
|
|
138
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
139
|
+
- **示例**:`sino-bc-cli project +invite --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
140
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
141
|
+
|
|
142
|
+
## +member-list
|
|
143
|
+
|
|
144
|
+
- **WHEN**:项目成员列表
|
|
145
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
146
|
+
- **示例**:`sino-bc-cli project +member-list --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
147
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
148
|
+
- **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
|
|
149
|
+
|
|
150
|
+
## +projects
|
|
151
|
+
|
|
152
|
+
- **WHEN**:指定用户关联项目列表(项目成员+任务成员)
|
|
153
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
154
|
+
- **示例**:`sino-bc-cli project +projects --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
155
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
156
|
+
- **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
|
|
157
|
+
|
|
158
|
+
## +remove
|
|
159
|
+
|
|
160
|
+
- **WHEN**:移除项目成员
|
|
161
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
162
|
+
- **示例**:`sino-bc-cli project +remove --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
163
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
164
|
+
|
|
165
|
+
## +tasks
|
|
166
|
+
|
|
167
|
+
- **WHEN**:项目成员参与任务
|
|
168
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
169
|
+
- **示例**:`sino-bc-cli project +tasks --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
170
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
171
|
+
- **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
|
|
172
|
+
|
|
173
|
+
## +page
|
|
174
|
+
|
|
175
|
+
- **WHEN**:对客项目列表(分页)
|
|
176
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
177
|
+
- **示例**:`sino-bc-cli project +page --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
178
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
179
|
+
|
|
180
|
+
## +status
|
|
181
|
+
|
|
182
|
+
- **WHEN**:更新对客项目状态
|
|
183
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
184
|
+
- **示例**:`sino-bc-cli project +status --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
185
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
186
|
+
|
|
187
|
+
## +update
|
|
188
|
+
|
|
189
|
+
- **WHEN**:编辑对客项目
|
|
190
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
191
|
+
- **示例**:`sino-bc-cli project +update --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
192
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
193
|
+
|
|
194
|
+
## api
|
|
195
|
+
|
|
196
|
+
- **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
|
|
197
|
+
- **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
|
|
198
|
+
- **示例**:`sino-bc-cli project api <name> --data '{...}'`
|
|
199
|
+
- **主体要求**:先查 `/schema <name>` 的 `_meta.tenant`;为 true 时,该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
package/dist/affordance/sso.md
CHANGED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
# task 命令何时用
|
|
2
|
+
|
|
3
|
+
字段口径在 `src/api-doc/`,这里只写 WHEN / 别用 / 示例。
|
|
4
|
+
|
|
5
|
+
## +action-log
|
|
6
|
+
|
|
7
|
+
- **WHEN**:任务操作日志列表(全量)
|
|
8
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
9
|
+
- **示例**:`sino-bc-cli task +action-log --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
10
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
11
|
+
|
|
12
|
+
## +adjust
|
|
13
|
+
|
|
14
|
+
- **WHEN**:调整任务(编辑任务基本信息、成员等,状态重新流转)
|
|
15
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
16
|
+
- **示例**:`sino-bc-cli task +adjust --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
17
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
18
|
+
|
|
19
|
+
## +approve-review
|
|
20
|
+
|
|
21
|
+
- **WHEN**:审核通过
|
|
22
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
23
|
+
- **示例**:`sino-bc-cli task +approve-review --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
24
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
25
|
+
|
|
26
|
+
## +confirm
|
|
27
|
+
|
|
28
|
+
- **WHEN**:确认通过
|
|
29
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
30
|
+
- **示例**:`sino-bc-cli task +confirm --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
31
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
32
|
+
|
|
33
|
+
## +create
|
|
34
|
+
|
|
35
|
+
- **WHEN**:创建任务
|
|
36
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
37
|
+
- **示例**:`sino-bc-cli task +create --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
38
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
39
|
+
|
|
40
|
+
## +delete
|
|
41
|
+
|
|
42
|
+
- **WHEN**:删除任务
|
|
43
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
44
|
+
- **示例**:`sino-bc-cli task +delete --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
45
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
46
|
+
|
|
47
|
+
## +detail
|
|
48
|
+
|
|
49
|
+
- **WHEN**:协同任务详情
|
|
50
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
51
|
+
- **示例**:`sino-bc-cli task +detail --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
52
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
53
|
+
- **参数**:`--data` 中的 query 字段按接口定义编码到 URL。
|
|
54
|
+
|
|
55
|
+
## +edit
|
|
56
|
+
|
|
57
|
+
- **WHEN**:编辑任务(修改基本信息、所属阶段、成员、附件,状态不变更,仅限待执行/待确认)
|
|
58
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
59
|
+
- **示例**:`sino-bc-cli task +edit --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
60
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
61
|
+
|
|
62
|
+
## +list
|
|
63
|
+
|
|
64
|
+
- **WHEN**:协同任务列表(全量)
|
|
65
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
66
|
+
- **示例**:`sino-bc-cli task +list --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
67
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
68
|
+
|
|
69
|
+
## +page
|
|
70
|
+
|
|
71
|
+
- **WHEN**:协同任务列表(分页)
|
|
72
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
73
|
+
- **示例**:`sino-bc-cli task +page --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
74
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
75
|
+
|
|
76
|
+
## +pause
|
|
77
|
+
|
|
78
|
+
- **WHEN**:暂停任务
|
|
79
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
80
|
+
- **示例**:`sino-bc-cli task +pause --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
81
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
82
|
+
|
|
83
|
+
## +reject-modify
|
|
84
|
+
|
|
85
|
+
- **WHEN**:需修改(驳回)
|
|
86
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
87
|
+
- **示例**:`sino-bc-cli task +reject-modify --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
88
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
89
|
+
|
|
90
|
+
## +reject-review
|
|
91
|
+
|
|
92
|
+
- **WHEN**:审核需修改
|
|
93
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
94
|
+
- **示例**:`sino-bc-cli task +reject-review --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
95
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
96
|
+
|
|
97
|
+
## +submit-delivery
|
|
98
|
+
|
|
99
|
+
- **WHEN**:去完成(提交交付)
|
|
100
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
101
|
+
- **示例**:`sino-bc-cli task +submit-delivery --data '{...}' --corporation-id <主体ID> --auth-context-id <认证上下文ID>`
|
|
102
|
+
- **主体上下文**:该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
103
|
+
|
|
104
|
+
## api
|
|
105
|
+
|
|
106
|
+
- **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
|
|
107
|
+
- **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
|
|
108
|
+
- **示例**:`sino-bc-cli task api <name> --data '{...}'`
|
|
109
|
+
- **主体要求**:先查 `/schema <name>` 的 `_meta.tenant`;为 true 时,该接口需要本次调用的主体绑定:先执行 `sino-bc-cli /auth status` 查看认证上下文,再用 `sino-bc-cli /tenant list` 查询当前身份可用主体,按任务明确的主体成对保存 ID 与认证上下文。每次调用传入 `--corporation-id <主体ID> --auth-context-id <认证上下文ID>`,不要放进 `--data`。漏传可补齐已有有效绑定;认证上下文变化时清除旧绑定,重新查询主体并唯一匹配后重新绑定,不能只替换认证标记。
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# tenant 命令何时用
|
|
2
|
+
|
|
3
|
+
字段口径在 `src/api-doc/`,这里只写 WHEN / 别用 / 示例。
|
|
4
|
+
|
|
5
|
+
## +list
|
|
6
|
+
|
|
7
|
+
- **WHEN**:查询用户签约主体列表
|
|
8
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
9
|
+
- **示例**:`sino-bc-cli tenant +list`
|
|
10
|
+
|
|
11
|
+
## api
|
|
12
|
+
|
|
13
|
+
- **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
|
|
14
|
+
- **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
|
|
15
|
+
- **示例**:`sino-bc-cli tenant api <name> --data '{...}'`
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# user 命令何时用
|
|
2
|
+
|
|
3
|
+
字段口径在 `src/api-doc/`,这里只写 WHEN / 别用 / 示例。
|
|
4
|
+
|
|
5
|
+
## +tenant-info-batch
|
|
6
|
+
|
|
7
|
+
- **WHEN**:批量查询租户用户信息
|
|
8
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
9
|
+
- **示例**:`sino-bc-cli user +tenant-info-batch --data '{...}'`
|
|
10
|
+
|
|
11
|
+
## +tenant-info
|
|
12
|
+
|
|
13
|
+
- **WHEN**:查询租户用户信息
|
|
14
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
15
|
+
- **示例**:`sino-bc-cli user +tenant-info --data '{...}'`
|
|
16
|
+
|
|
17
|
+
## +sso-info
|
|
18
|
+
|
|
19
|
+
- **WHEN**:查询SSO用户信息
|
|
20
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
21
|
+
- **示例**:`sino-bc-cli user +sso-info --data '{...}'`
|
|
22
|
+
|
|
23
|
+
## +sso-info-batch
|
|
24
|
+
|
|
25
|
+
- **WHEN**:批量查询SSO用户信息
|
|
26
|
+
- **别用**:已有更贴切的 Shortcut 时不要用本命令凑合。
|
|
27
|
+
- **示例**:`sino-bc-cli user +sso-info-batch --data '{...}'`
|
|
28
|
+
|
|
29
|
+
## api
|
|
30
|
+
|
|
31
|
+
- **WHEN**:需要原始 JSON 字段,或没有合适的便捷 Shortcut 时按 name 调用。
|
|
32
|
+
- **别用**:已有 Shortcut 的高频查询仍应走 `+xxx`。
|
|
33
|
+
- **示例**:`sino-bc-cli user api <name> --data '{...}'`
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# 接口文档索引
|
|
2
|
+
|
|
3
|
+
本目录描述 CLI catalog 中的接口字段。查看命令用途用 `sino-bc-cli <domain> --help`;查看某接口的完整输入和输出 schema 用 `sino-bc-cli /schema <name>`。便捷命令负责常见任务,原始 JSON 调用用 `<domain> api <name> --data '<json>'`。
|
|
4
|
+
|
|
5
|
+
## 文档分层
|
|
6
|
+
|
|
7
|
+
| 位置 | 来源与维护方式 |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| 本文件 | 手写导航,同步保留 |
|
|
10
|
+
| `oapi/` | Apifox 全模块同步生成,整层替换,禁止手改 |
|
|
11
|
+
| `custom/` | 手写字段说明或文档覆盖,同步只读 |
|
|
12
|
+
|
|
13
|
+
同名文档按 custom → oapi → 目录根解析。custom 同名文件会优先展示,只有确需完整覆盖生成文档时才使用;一般业务工作流放 `skills/default/sino-bc-<domain>/references/`。
|
|
14
|
+
|
|
15
|
+
## 按业务域查看
|
|
16
|
+
|
|
17
|
+
| 域 | 用途 | 接口文档 |
|
|
18
|
+
| --- | --- | --- |
|
|
19
|
+
| biz-line | 业务线、周策略、渠道、品类、优化项目及广告成效 | [查询](oapi/biz-line-query.md)、[策略](oapi/biz-line-strategy.md) |
|
|
20
|
+
| project-analysis | 优化项目月度分析、消耗/工时趋势、人效与 Excel 导出 | [项目分析](oapi/project-analysis.md) |
|
|
21
|
+
| sso | SSO 组别 | [SSO](oapi/sso.md) |
|
|
22
|
+
| project | 营销协同项目、成员、分组 | [项目](oapi/project.md) |
|
|
23
|
+
| project-stage | 营销协同项目阶段 | [阶段](oapi/project-stage.md) |
|
|
24
|
+
| task | 营销协同任务 | [任务](oapi/task.md) |
|
|
25
|
+
| document | 文档中心与项目文档 | [文档](oapi/document.md) |
|
|
26
|
+
| file | 文件上传与对象存储记录 | [文件](oapi/file.md) |
|
|
27
|
+
| delivery | Campaign 归集与投放阶段指标 | [投放](oapi/delivery.md) |
|
|
28
|
+
| dashboard | 看板 | [看板](oapi/dashboard.md) |
|
|
29
|
+
| organization | 组织架构、团队成员与当前用户 | [组织用户](oapi/organization.md) |
|
|
30
|
+
| user | SSO 与签约主体(租户)用户资料 | [用户信息](oapi/user.md) |
|
|
31
|
+
| im | 飞书群消息 | [消息](oapi/im.md) |
|
|
32
|
+
| tenant | 用户签约主体列表 | [租户](oapi/tenant.md) |
|
|
33
|
+
| auth | CLI 设备授权协议;日常登录优先 `/auth login` | [授权](oapi/auth.md) |
|
|
34
|
+
|
|
35
|
+
接口名称和数量以 `src/generated/api-catalog.json` 为唯一运行时依据;name 来自 OpenAPI 的 `x-cli-name`,不能从路由自行拼造。新开发者接入流程见 [bc-develop](../../.cursor/skills/bc-develop/SKILL.md),完整样例见 [项目分析接入](../../developer-doc/07-project-analysis-onboarding.md)。
|
|
36
|
+
|
|
37
|
+
## 请求与输出约定
|
|
38
|
+
|
|
39
|
+
业务请求只走生效网关根(缺省 `https://agent.beyondclick.com`,可用 `/set-config gateway-url`),路径保持 OpenAPI 的完整路由。例如 `/sino-opti-hive/project/analysis/getSummaryData` 不能剥掉或重复追加服务前缀。认证与业务共用该根;不能把文档来源服务地址当业务请求地址。
|
|
40
|
+
|
|
41
|
+
CLI 从平台密钥存储读取身份令牌(macOS/Linux 为 AES 密文,Windows 为凭据库),固定携带 `Authorization: Bearer …` 和 `X-GATEWAY-TYPE: A2C-CLI`。只有 catalog 声明 tenant=true 的业务接口才要求本次调用传入 `--corporation-id` 与 `--auth-context-id`,并注入 `x-corporation-id`。项目分析的 corporationIdList 是可选业务筛选,和网关主体上下文分开。
|
|
42
|
+
|
|
43
|
+
参数以实际输入为准,文档示例不会被当作默认请求体。GET query 同样通过 `--data` 提供;multipart 文件字段传本地路径,由 CLI 读取文件上传。`--dry-run` 校验并预览,不发业务请求。
|
|
44
|
+
|
|
45
|
+
仅 high-risk-write 要求确认:非交互未传 --yes 时返回 confirmation_required、退出码 10。普通 write 直接执行;项目分析三个导出属于普通 write,会生成文件并返回 URL。不能把 URL 响应称为本地下载完成。
|
|
46
|
+
|
|
47
|
+
TTY 默认表格,非 TTY 默认 JSON 信封。成功 stdout,失败 stderr;参数/配置错误退出码 2,一般 API 错误 1。上游响应由 CLI 解包到 data,不需要调用者重复解包。
|
|
48
|
+
|
|
49
|
+
## 维护同步
|
|
50
|
+
|
|
51
|
+
运行 `npm run sync-api-doc`,自动发现所有模块,分别导出、解析 OpenAPI,全部成功后统一替换生成物。token 只取环境变量 `APIFOX_TOKEN`;禁止进入仓库、用户配置或日志。业务技能入口、帮助和字段文档应同时验证,不能只看 catalog 新增数量。
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CLI 设备授权与自动刷新
|
|
2
|
+
|
|
3
|
+
交互 `/set-config` 的身份令牌项直接回车,保留完整 OAuth 凭证;显式输入 AT 才清除原 RT 并切换为手动模式,随后可空询问 RT。`/init` 只装技能,不问令牌。`auth login/logout/status` 支持省略 `/`,`auth +<shortcut>` 与 `auth api <name>` 则调用接口目录。
|
|
4
|
+
|
|
5
|
+
认证与业务共用生效网关根(缺省 `https://agent.beyondclick.com`,可用 `/set-config gateway-url` 改写),拼接 `/platform/auth/cli/...`。认证 HTTP 不跟随重定向。浏览器确认页打开服务端返回的 `verificationUrl` 原值,不再校验 origin。不可把私密设备码传入浏览器。`/auth login` 领取成功后进度流写出「授权成功,本机身份已就绪」;json 信封 `data.message` 为同文案并含 `data.configured: true`;TTY table 下 stdout 为含相同字段的结果对象。DENIED / EXPIRED 不写该成功文案。不输出 AT/RT。
|
|
6
|
+
|
|
7
|
+
| 操作 | POST path | JSON 请求体 |
|
|
8
|
+
| --- | --- | --- |
|
|
9
|
+
| 申请网页授权码 | `/platform/auth/cli/device/oauth/code` | `{deviceCode,clientId:"sino-bc-cli",accessType:"offline_access"}` |
|
|
10
|
+
| 交换凭证 | `/platform/auth/cli/device/oauth/exchange` | `{deviceCode}` |
|
|
11
|
+
| 刷新 | `/platform/auth/cli/oauth/refresh` | `{refreshToken}` |
|
|
12
|
+
|
|
13
|
+
CLI 用 `randomBytes(32).toString('base64url')` 生成私密 deviceCode。申请响应为独立网页 `code` 与 `verificationUrl`;设备码不得拼入授权地址。成功业务信封为 `{code:0,result:{...}}`(兼容 `data` 包装)。交换状态为 `PENDING`(3 秒后继续)、`EXPIRED`/`DENIED`(终止)或 `SUCCESS`。刷新状态为 `SUCCESS` 或 `INVALID_GRANT`(清除对应旧凭证并要求重新授权)。
|
|
14
|
+
|
|
15
|
+
令牌字段:`accessToken`、`refreshToken`、`tokenType:"Bearer"`、`accessExpiresAt`、`refreshExpiresAt`。两个 ExpiresAt 字段均为绝对过期时间(毫秒时间戳);CLI 校验为未过期的安全整数后直接保存,不按请求或响应时间重新计算。重复领取返回相同截止时间。
|
|
16
|
+
|
|
17
|
+
整套 OAuth 凭证存在平台密钥存储中,与环境无关;旧记录若仍带 `env` 字段则忽略。macOS/Linux 令牌本体为 `~/.sino-bc-cli/secrets/authToken.enc`(AES-256-GCM);macOS Keychain 只存 32 字节主密钥,可用 `/auth keychain-downgrade` 抄到文件。Windows 仍为当前用户凭据库 JSON。空凭证删除密文并留下无秘密的 `authToken.rev` 墓碑。旧 raw AT 兼容读取。AT 剩余超过 300 秒直接使用,否则在跨进程刷新锁内重读、校验 RT 并刷新。锁使用 `fs-native-extensions` 的 OS 文件描述符排他锁,目录在 `<home>/.sino-bc-cli/locks`。活进程锁不会按时间拆除,进程退出时由内核释放。所有凭证修改使用短临界区锁及版本比较交换,避免旧刷新/旧登录覆盖手动 AT、退出、新登录。`/auth logout` 清整份身份面(密文、墓碑、主密钥、遗留 keychain `authToken`)。网络或服务暂时错误保留凭证。exchange 遇到传输错误、HTTP 5xx/429 时保持同一 deviceCode 每 3 秒重试,服务端提交成功但响应丢失时可在授权后的 300 秒领取窗口恢复同代令牌;其它协议错误明确终止。
|
|
18
|
+
|
|
19
|
+
`GatewayClient.call` 从配置携带的内存解析器取得最新 AT;`prepare`/dry-run 不联网。请求日志不包含认证请求体或原始上游错误。
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# CLI设备授权
|
|
2
|
+
|
|
3
|
+
> **网关地址**:缺省 `https://agent.beyondclick.com`,可用 `/set-config gateway-url` 改写;业务与登录共用该根。不要直连上游服务地址。
|
|
4
|
+
>
|
|
5
|
+
> **调用路径**:等于下方列出的 path(即 OpenAPI / catalog 路由),由 CLI 拼到网关地址后发出。
|
|
6
|
+
|
|
7
|
+
对应命令:`auth +<shortcut>` 与 `auth api <name>`。
|
|
8
|
+
|
|
9
|
+
## 1. 获取授权链接地址
|
|
10
|
+
|
|
11
|
+
`POST /platform/auth/cli/device/oauth/code`
|
|
12
|
+
|
|
13
|
+
主体上下文:`tenant=false`。
|
|
14
|
+
|
|
15
|
+
角色范围:`未声明`。
|
|
16
|
+
|
|
17
|
+
CLI 生成浏览器授权链接。尚未确认时只保存短期申请;同一 deviceCode 未过期重复调用返回原链接且不延长 TTL。已落库的 deviceCode 不能重新申请,返回 DENIED。本接口免登录,由 deviceCode 校验。
|
|
18
|
+
|
|
19
|
+
**输入参数(--data)**
|
|
20
|
+
|
|
21
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
22
|
+
| --- | --- | --- | --- | --- |
|
|
23
|
+
| `deviceCode` | string | body | 是 | CLI 产生至少 32 字节安全随机 device_code(base64url,43 至 64 字符) |
|
|
24
|
+
| `clientId` | string | body | 是 | 固定为 sino-bc-cli |
|
|
25
|
+
| `accessType` | string | body | 是 | 固定为 offline_access |
|
|
26
|
+
|
|
27
|
+
## 2. 获取访问凭证accessToken和刷新凭证refreshToken
|
|
28
|
+
|
|
29
|
+
`POST /platform/auth/cli/device/oauth/exchange`
|
|
30
|
+
|
|
31
|
+
主体上下文:`tenant=false`。
|
|
32
|
+
|
|
33
|
+
角色范围:`未声明`。
|
|
34
|
+
|
|
35
|
+
按设备凭证查询授权状态或领取首代凭证。未确认返回 PENDING;申请过期或领取恢复窗口已过返回 EXPIRED;确认后首次领取写入授权及首代 token,宽限 300 秒内可恢复同一代结果。本接口免登录,由 deviceCode 校验。
|
|
36
|
+
|
|
37
|
+
**输入参数(--data)**
|
|
38
|
+
|
|
39
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
40
|
+
| --- | --- | --- | --- | --- |
|
|
41
|
+
| `deviceCode` | string | body | 是 | 与auth-cli-device-oauth-code申请时使用的同一 deviceCode |
|
|
42
|
+
|
|
43
|
+
## 3. 通过刷新凭证refreshToken获取访问凭证accessToken
|
|
44
|
+
|
|
45
|
+
`POST /platform/auth/cli/oauth/refresh`
|
|
46
|
+
|
|
47
|
+
主体上下文:`tenant=false`。
|
|
48
|
+
|
|
49
|
+
角色范围:`未声明`。
|
|
50
|
+
|
|
51
|
+
轮换刷新凭证。刷新凭证不存在、已删除、已失效或宽限外重试返回 INVALID_GRANT;首次轮换签发下一代 token 对,宽限内重试返回同一代结果,不产生分支、不延长到期。
|
|
52
|
+
|
|
53
|
+
**输入参数(--data)**
|
|
54
|
+
|
|
55
|
+
| 字段 | 类型 | 位置 | 必填 | 说明 |
|
|
56
|
+
| --- | --- | --- | --- | --- |
|
|
57
|
+
| `refreshToken` | string | body | 是 | exchange 或上一次 refresh 返回的 refreshToken |
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# 业务线查询
|
|
2
2
|
|
|
3
|
-
>
|
|
3
|
+
> **网关地址**:缺省 `https://agent.beyondclick.com`,可用 `/set-config gateway-url` 改写;业务与登录共用该根。不要直连上游服务地址。
|
|
4
4
|
>
|
|
5
5
|
> **调用路径**:等于下方列出的 path(即 OpenAPI / catalog 路由),由 CLI 拼到网关地址后发出。
|
|
6
6
|
|
|
@@ -10,10 +10,18 @@
|
|
|
10
10
|
|
|
11
11
|
`GET /sino-opti-hive/biz-line-open/channels`
|
|
12
12
|
|
|
13
|
+
主体上下文:`tenant=false`。
|
|
14
|
+
|
|
15
|
+
角色范围:`未声明`。
|
|
16
|
+
|
|
13
17
|
查询投放渠道列表
|
|
14
18
|
|
|
15
19
|
## 2. 查询投放品类字典
|
|
16
20
|
|
|
17
21
|
`GET /sino-opti-hive/biz-line-open/placement-categories`
|
|
18
22
|
|
|
23
|
+
主体上下文:`tenant=false`。
|
|
24
|
+
|
|
25
|
+
角色范围:`未声明`。
|
|
26
|
+
|
|
19
27
|
查询投放品类字典,sceneCode 固定 PLACEMENT_CATEGORY。一级节点 = 投放行业,二级节点(children)= 投放品类,分别对应筛选参数 adCategoryIndustryId / adCategoryProjectId。已过滤 isOther=1 的「其他」。叶子节点 children 为 null。
|