docs: update promptDelivery to synchronous after async revert (#3274)#3277
Merged
Merged
Conversation
The async prompt delivery from #3253 was reverted in #3274 due to a P0 regression (tracking never updated, status stuck at 'pending'). Updates: - promptDelivery.status is now 'delivered' or 'failed' immediately - Removed async polling pattern documentation - Removed 'pending' and 'timeout' from status values - Updated example response to show synchronous result
Contributor
There was a problem hiding this comment.
β Approved.
PR #3277 β docs: update promptDelivery to synchronous after async revert (#3274)
Gate checklist:
- β CI: all checks green (lint, test, helm-smoke, CodeQL, Trivy, Gitleaks, dashboard-e2e)
- β
Mergeable, no conflicts, targets
develop - β No secrets, no sensitive data
- β Docs-only change β no code, no tests needed
- β
Correct fix: removes async polling pattern (
pending,timeout, poll instruction) after #3274 reverted async delivery - β
Conventional commit title (
docs:) - β Context clearly documented in PR body
Clean, minimal, well-scoped docs fix. Ready to merge.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes docs drift caused by PR #3274 (revert of async prompt delivery).
The async
pendingβ polling pattern documented in #3254 no longer exists. Prompt delivery is synchronous again βstatusisdeliveredorfailedimmediately in the POST response.Changes
promptDeliverynotedeliveredorfailed(removedpending,timeout)Context
pending)