From 693189997f091f6e88d50d33e362da418c97a897 Mon Sep 17 00:00:00 2001 From: tegwick Date: Wed, 8 Jul 2026 20:00:35 +0200 Subject: [PATCH] CUST-WP-0055 T05: document workplan_id preference on progress router Clarify that workplan_id is preferred and workstream_id is a legacy wire-compat alias until legacy-meter retires it. --- hub_core/routers/progress.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/hub_core/routers/progress.py b/hub_core/routers/progress.py index 63cf048..b1266b8 100644 --- a/hub_core/routers/progress.py +++ b/hub_core/routers/progress.py @@ -12,6 +12,9 @@ from hub_core.models.progress_event import ProgressEvent from hub_core.schemas.progress_event import ProgressEventCreate, ProgressEventRead from hub_core.utils.pagination import PageParams, apply_pagination +# List/create progress events. ``workplan_id`` is the preferred filter/body field; +# ``workstream_id`` remains a wire-compat alias until legacy-meter retires it. + def create_progress_router( get_session: Callable[..., AsyncSession],