79 lines
1.6 KiB
Markdown
79 lines
1.6 KiB
Markdown
# Terminology
|
|
|
|
Use these terms consistently when changing code, docs, or UI.
|
|
|
|
## Core Terms
|
|
|
|
### `design-time`
|
|
|
|
Use for configuration, editing, and control-plane concepts that exist before a
|
|
specific runtime is launched.
|
|
|
|
Typical examples:
|
|
|
|
- `workspaces/`
|
|
- workspace registry CRUD
|
|
- design-time agent metadata
|
|
|
|
### `runtime`
|
|
|
|
Use for the active execution layer and its state.
|
|
|
|
Typical examples:
|
|
|
|
- runtime lifecycle APIs
|
|
- scheduler / gateway execution
|
|
- approvals during a live run
|
|
- runtime snapshots and logs
|
|
|
|
### `run`
|
|
|
|
Use for one concrete execution instance.
|
|
|
|
Typical examples:
|
|
|
|
- `runs/<run_id>/`
|
|
- runtime history
|
|
- run logs
|
|
- run bootstrap config
|
|
- run-scoped agent assets
|
|
|
|
### `workspace`
|
|
|
|
Prefer this word only for the design-time registry unless you are working on a
|
|
historical compatibility surface that still uses the old path or field name.
|
|
|
|
Examples:
|
|
|
|
- good: "design workspace"
|
|
- good: "workspace registry"
|
|
- avoid for new runtime UI: "current workspace" when you really mean current run
|
|
|
|
## Compatibility Rule
|
|
|
|
Some fields still use legacy names:
|
|
|
|
- `workspace_id` on approval records
|
|
|
|
Current API path rule:
|
|
|
|
- design-time CRUD uses `/api/workspaces/{workspace_id}/...`
|
|
- runtime agent assets use `/api/runs/{run_id}/agents/...`
|
|
|
|
For new code:
|
|
|
|
- prefer `runId` for runtime variables and runtime API paths
|
|
- prefer `workspaceId` only for design-time registry flows
|
|
|
|
## UI Wording
|
|
|
|
For operator-facing runtime UI, prefer:
|
|
|
|
- "运行任务"
|
|
- "运行文件"
|
|
- "运行资产"
|
|
- "任务 ID"
|
|
|
|
Avoid using "工作区" for active runtime concepts unless the screen is truly
|
|
about the design-time workspace registry.
|