OrgTJWater/TJWaterServerBinary
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(cli): use renamed backend APIs

Browse Source
This commit is contained in:
jiang
2026-06-13 13:56:44 +08:00
parent 5a55d65002
commit 80ca985c28
4 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cli/tjwater_cli/commands_analysis.py
+5 -5
View File
@@ -53,7 +53,7 @@ def simulation_run(
ctx, ctx,
summary="触发模拟成功", summary="触发模拟成功",
method="POST", method="POST",
path="/runsimulationmanuallybydate/", path="/simulations/run-by-date",
json_body=body, json_body=body,
require_auth=True, require_auth=True,
require_network_ctx=True, require_network_ctx=True,
@@ -87,7 +87,7 @@ def analysis_burst(
ctx, ctx,
summary="爆管分析执行成功", summary="爆管分析执行成功",
method="GET", method="GET",
path="/burst_analysis/", path="/burst-analysis",
params=params, params=params,
require_auth=True, require_auth=True,
require_network_ctx=True, require_network_ctx=True,
@@ -151,7 +151,7 @@ def analysis_valve(
ctx, ctx,
summary="阀门隔离分析执行成功", summary="阀门隔离分析执行成功",
method="GET", method="GET",
path="/valve_isolation_analysis/", path="/valve-isolation-analysis",
params=params, params=params,
require_auth=True, require_auth=True,
require_network_ctx=True, require_network_ctx=True,
@@ -186,7 +186,7 @@ def analysis_flushing(
ctx, ctx,
summary="冲洗分析执行成功", summary="冲洗分析执行成功",
method="GET", method="GET",
path="/flushing_analysis/", path="/flushing-analysis",
params=params, params=params,
require_auth=True, require_auth=True,
require_network_ctx=True, require_network_ctx=True,
@@ -240,7 +240,7 @@ def analysis_contaminant(
ctx, ctx,
summary="污染物模拟执行成功", summary="污染物模拟执行成功",
method="GET", method="GET",
path="/contaminant_simulation/", path="/contaminant-simulation",
params=params, params=params,
require_auth=True, require_auth=True,
require_network_ctx=True, require_network_ctx=True,
cli/tjwater_cli/commands_data.py
+1 -1
View File
@@ -501,7 +501,7 @@ def data_scheme_list(ctx: typer.Context) -> None:
ctx, ctx,
summary="读取方案列表成功", summary="读取方案列表成功",
method="GET", method="GET",
path="/getallschemes/", path="/schemes",
params={"network": require_network(runtime)}, params={"network": require_network(runtime)},
require_auth=True, require_auth=True,
require_network_ctx=True, require_network_ctx=True,
cli/tjwater_cli/registry.py
+3 -3
View File
@@ -137,7 +137,7 @@ COMMAND_DOCS: dict[tuple[str, ...], CommandDoc] = {
("simulation", "run"): CommandDoc( ("simulation", "run"): CommandDoc(
path=("simulation", "run"), path=("simulation", "run"),
summary="触发指定绝对时间的模拟运行", summary="触发指定绝对时间的模拟运行",
description="把显式带时区的 RFC3339 start-time 直接传给 /runsimulationmanuallybydate/；服务端按带时区时间处理并统一按 UTC 存储结果，实时数据需后续通过 data timeseries 在对应时间段查询。duration 单位为分钟。", description="把显式带时区的 RFC3339 start-time 直接传给 /simulations/run-by-date；服务端按带时区时间处理并统一按 UTC 存储结果，实时数据需后续通过 data timeseries 在对应时间段查询。duration 单位为分钟。",
options=( options=(
CommandOptionDoc("start-time", "显式带时区的开始时间", required=True), CommandOptionDoc("start-time", "显式带时区的开始时间", required=True),
CommandOptionDoc("duration", "持续分钟数", required=True), CommandOptionDoc("duration", "持续分钟数", required=True),
@@ -211,7 +211,7 @@ COMMAND_DOCS: dict[tuple[str, ...], CommandDoc] = {
("analysis", "contaminant"): CommandDoc( ("analysis", "contaminant"): CommandDoc(
path=("analysis", "contaminant"), path=("analysis", "contaminant"),
summary="执行污染物模拟", summary="执行污染物模拟",
description="调用 /contaminant_simulation/。duration 单位为秒。", description="调用 /contaminant-simulation。duration 单位为秒。",
options=( options=(
CommandOptionDoc("start-time", "显式带时区的开始时间", required=True), CommandOptionDoc("start-time", "显式带时区的开始时间", required=True),
CommandOptionDoc("duration", "持续秒数", required=True), CommandOptionDoc("duration", "持续秒数", required=True),
@@ -499,7 +499,7 @@ COMMAND_DOCS: dict[tuple[str, ...], CommandDoc] = {
("data", "scheme", "list"): CommandDoc( ("data", "scheme", "list"): CommandDoc(
path=("data", "scheme", "list"), path=("data", "scheme", "list"),
summary="列出方案", summary="列出方案",
description="调用 /getallschemes/。", description="调用 /schemes。",
examples=("tjwater-cli data scheme list",), examples=("tjwater-cli data scheme list",),
), ),
} }
cli/tjwater_cli_endpoint_scope.md
+6 -6
View File
@@ -194,12 +194,12 @@ app/api/v1/endpoints/risk.py
| 命令 | 覆盖接口 | 说明 | | 命令 | 覆盖接口 | 说明 |
|---|---|---| |---|---|---|
| `tjwater-cli simulation run --start-time RFC3339 --duration MINUTES` | `POST /runsimulationmanuallybydate/` | 按指定绝对开始时间触发当前 project 的实时模拟；`start-time` 必须显式带时区，结果写入服务端时序库，后续通过 `tjwater-cli data timeseries realtime *` 查询 | | `tjwater-cli simulation run --start-time RFC3339 --duration MINUTES` | `POST /simulations/run-by-date` | 按指定绝对开始时间触发当前 project 的实时模拟；`start-time` 必须显式带时区，结果写入服务端时序库，后续通过 `tjwater-cli data timeseries realtime *` 查询 |
| `tjwater-cli analysis burst --start-time TIME --duration SEC --scheme SCHEME --burst-file FILE` | `GET /burst_analysis/` | 爆管分析；`FILE` 提供爆管点与流量列表，CLI 负责转换为 `burst_ID[]` / `burst_size[]` | | `tjwater-cli analysis burst --start-time TIME --duration SEC --scheme SCHEME --burst-file FILE` | `GET /burst-analysis` | 爆管分析；`FILE` 提供爆管点与流量列表，CLI 负责转换为 `burst_ID[]` / `burst_size[]` |
| `tjwater-cli analysis valve --mode close\|isolation --start-time TIME --valve VALVE [--scheme SCHEME]` | `GET /valve_close_analysis/`、`GET /valve_isolation_analysis/` | 阀门分析；close 模式需要 `--scheme`，`--valve` 可重复 | | `tjwater-cli analysis valve --mode close\|isolation --start-time TIME --valve VALVE [--scheme SCHEME]` | `GET /valve_close_analysis/`、`GET /valve-isolation-analysis` | 阀门分析；close 模式需要 `--scheme`，`--valve` 可重复 |
| `tjwater-cli analysis flushing --start-time TIME --valve-setting-file FILE --drainage-node NODE --flow FLOW --scheme SCHEME [--duration SEC]` | `GET /flushing_analysis/` | 冲洗分析；`FILE` 提供阀门与开度列表，CLI 负责转换为 `valves[]` / `valves_k[]` | | `tjwater-cli analysis flushing --start-time TIME --valve-setting-file FILE --drainage-node NODE --flow FLOW --scheme SCHEME [--duration SEC]` | `GET /flushing-analysis` | 冲洗分析；`FILE` 提供阀门与开度列表，CLI 负责转换为 `valves[]` / `valves_k[]` |
| `tjwater-cli analysis age --start-time TIME --duration SEC` | `GET /age_analysis/` | 水龄分析 | | `tjwater-cli analysis age --start-time TIME --duration SEC` | `GET /age_analysis/` | 水龄分析 |
| `tjwater-cli analysis contaminant --start-time TIME --duration SEC --source-node NODE --concentration VALUE --scheme SCHEME [--pattern PATTERN]` | `GET /contaminant_simulation/` | 污染物模拟 | | `tjwater-cli analysis contaminant --start-time TIME --duration SEC --source-node NODE --concentration VALUE --scheme SCHEME [--pattern PATTERN]` | `GET /contaminant-simulation` | 污染物模拟 |
| `tjwater-cli analysis sensor-placement kmeans --count N` | `GET /pressuresensorplacementkmeans/` | 基于 kmeans 的传感器放置分析；不包含创建方案 | | `tjwater-cli analysis sensor-placement kmeans --count N` | `GET /pressuresensorplacementkmeans/` | 基于 kmeans 的传感器放置分析；不包含创建方案 |
| `tjwater-cli analysis leakage identify --scheme SCHEME --start-time TIME --end-time TIME` | `POST /leakage/identify/` | 漏损识别 | | `tjwater-cli analysis leakage identify --scheme SCHEME --start-time TIME --end-time TIME` | `POST /leakage/identify/` | 漏损识别 |
| `tjwater-cli analysis leakage schemes list\|get` | `GET /leakage/schemes/`、`GET /leakage/schemes/{scheme_name}` | 漏损方案查询 | | `tjwater-cli analysis leakage schemes list\|get` | `GET /leakage/schemes/`、`GET /leakage/schemes/{scheme_name}` | 漏损方案查询 |
@@ -229,7 +229,7 @@ POST /daily_scheduling_analysis/
- 首批 CLI 统一按同步命令设计，避免引入额外的异步轮询协议。 - 首批 CLI 统一按同步命令设计，避免引入额外的异步轮询协议。
- `simulation run` 不直接回传全量模拟结果；它负责触发服务端模拟，并返回执行摘要、时间窗口和后续查询提示。 - `simulation run` 不直接回传全量模拟结果；它负责触发服务端模拟，并返回执行摘要、时间窗口和后续查询提示。
- 当前 `runsimulationmanuallybydate` 接口会从 `start_time` 指定的绝对时间开始，按 15 分钟步长运行直到达到 `duration`，结果持久化到服务端时序存储。 - 当前 `simulations/run-by-date` 接口会从 `start_time` 指定的绝对时间开始，按 15 分钟步长运行直到达到 `duration`，结果持久化到服务端时序存储。
- `start_time` 必须显式带时区；CLI 推荐直接传 **UTC+8** 时间，服务端统一转换后执行和落库。CLI 文档与帮助信息需要把这条规则写成显式契约，不能把数据库存储时间直接暴露成用户输入语义。 - `start_time` 必须显式带时区；CLI 推荐直接传 **UTC+8** 时间，服务端统一转换后执行和落库。CLI 文档与帮助信息需要把这条规则写成显式契约，不能把数据库存储时间直接暴露成用户输入语义。
- 模拟结果读取统一走 `tjwater-cli data timeseries realtime *`，而不是再单独设计 `simulation output`。 - 模拟结果读取统一走 `tjwater-cli data timeseries realtime *`，而不是再单独设计 `simulation output`。
- `analysis` 相关命令首批也按同步请求处理；若后续服务端真的引入任务队列，再单独设计 `job` 类基础设施能力。 - `analysis` 相关命令首批也按同步请求处理；若后续服务端真的引入任务队列，再单独设计 `job` 类基础设施能力。