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.
This commit is contained in:
parent
db65202712
commit
693189997f
1 changed files with 3 additions and 0 deletions
|
|
@ -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],
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue