Repository navigation
chore(api): describe the settled-pause rule in the run status overlay TSDoc - #9957
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
[Low impact] The PR changes API documentation comments without changing runtime behavior. The comment-only change is safe to merge, with a non-blocking correction to how it describes the pause rule. Findings
SummaryUpdates the TSDoc for
Reviews (1) · Last reviewed commit: "chore(api): describe the settled-pause r..." · Reviewed by Greptile |
| * `paused_executions` that still has a point to resume (a finished run whose every point | ||
| * resumed or failed reads its log status). A reported `paused` is either that overlay or the |
There was a problem hiding this comment.
Comments narrow the pause rule
The new wording requires an unsettled pause point for every paused overlay. But executionStatus checks whether all points have settled only when the log is completed, failed, or cancelled. For other log statuses, an open pause record still wins regardless of its points.
Describe the actual exception: an open pause record reads paused unless the log has finished and every point has resumed or failed. Use the same wording in logs.ts. This keeps maintainers from copying a stricter rule into another status read.
Summary
v2WorkflowRunListStatusValueSchemaandv2LogStatusSchemato match fix(api): report a finished run's real status once its pauses have settled; show the request id in the CLI #9924: the run list overlayspausedonly while the open pause record still has a point to resumeType of Change
Testing
biome check on both files; no runtime change
Checklist
test-auditauthoring gate)