Skip to content

chore(api): describe the settled-pause rule in the run status overlay TSDoc - #9957

Merged
waleedlatif1 merged 1 commit into
stagingfrom
fix/run-status-overlay-tsdoc
Nov 12, 2026
Merged

waleedlatif1 merged 1 commit into
stagingfrom
fix/run-status-overlay-tsdoc

Conversation

@waleedlatif1

@waleedlatif1 waleedlatif1 commented Nov 12, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Type of Change

  • Documentation (comments only)

Testing

biome check on both files; no runtime change

Checklist

  • Code follows project style guidelines
  • Self-reviewed my changes
  • Tests added/updated and passing (new tests pass the test-audit authoring gate)
  • No new warnings introduced
  • I confirm that I have read and agree to the terms outlined in the Contributor License Agreement (CLA)

@vercel

vercel Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated
docs Skipped Skipped Nov 12, 2026 10:45pm UTC

Request Review

@waleedlatif1
waleedlatif1 merged commit 364d1f4 into staging Nov 12, 2026
59 of 60 checks passed
@waleedlatif1
waleedlatif1 deleted the fix/run-status-overlay-tsdoc branch November 12, 2026 22:47
@greptile-apps

greptile-apps Bot commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 4/5

[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

  1. P2 Comments narrow the pause rule ▶

Summary

Updates the TSDoc for v2WorkflowRunListStatusValueSchema and v2LogStatusSchema.

  • Run status notes say when a pause still counts as paused.

Reviews (1) · Last reviewed commit: "chore(api): describe the settled-pause r..." · Reviewed by Greptile

Comment on lines +1991 to +1992
* `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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 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.

This branch was previously deployed

1 inactive deployment
Preview — 18cfc316 Deployed Nov 12, 2026 by vercel[bot]
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