Skip to content

docs(flow): fix get_flow_detail docstring -- no schedule info is returned - #721

Merged
padak merged 1 commit into
mainfrom
claude/unruffled-dirac-78cb67
Aug 30, 2026
Merged

docs(flow): fix get_flow_detail docstring -- no schedule info is returned#721
padak merged 1 commit into
mainfrom
claude/unruffled-dirac-78cb67

Conversation

@padak

@padak padak commented Aug 30, 2026

Copy link
Copy Markdown
Member

Summary

The docstring of FlowService.get_flow_detail claimed it returns "full flow detail including phases, tasks, and schedule info", but the implementation performs no schedule join -- it returns the raw config detail enriched with parsed phases/tasks, phase_count/task_count, component_id, branch_id and project_alias. Schedules are only fetched via list_flows(with_schedules=True) (the flow list --with-schedules path) or during flow schedule-remove.

This PR fixes the docstring to match reality and points readers to the actual schedule path. Deliberately does NOT add a schedule fetch.

Scope

  • Docs-only (one docstring), no behavior change
  • No version bump, no changelog entry (per the release-PR-only rule)
  • No test changes needed

…rned

The docstring claimed the result includes schedule info, but the
implementation only parses phases/tasks from the configuration body and
enriches the raw config detail with counts and identifiers. Schedules
are only fetched via list_flows(with_schedules=True) or the
schedule-remove path. Docs-only change; no behavior change.
@padak
padak merged commit 477cb54 into main Aug 30, 2026
4 checks passed
@padak
padak deleted the claude/unruffled-dirac-78cb67 branch August 30, 2026 11:31
@padak padak mentioned this pull request Aug 30, 2026
9 tasks
padak added a commit that referenced this pull request Aug 30, 2026
Batches the seven PRs merged since v0.91.0 into one version bump, one
changelog entry and one set of resolved version gates:

- #719 (#714) `flow triggers` -- table triggers, not just cron
- #717 (#711) a 401 is no longer automatically blamed on the token
- #722 (#704) setup completes in chat; skill covers setup + logout
- #718 (#716) `--conversation-id` global flag
- #706 223 stale version gates retired at the 0.80.0 floor
- #702 release process enforced rather than remembered
- #721 `get_flow_detail` docstring fix

Includes a curated What's-new entry (#717's error rework is UI-visible on
the Semantic Layer page) and the step 8-11 silent-drift review.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant