Use SSE for Managed Auth examples - #493
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Risk assessment: Very Low
Verdict: Approve
Evidence (from diff only)
- 6 files changed (+207 / −188), all documentation:
auth/credentials.mdx,auth/hosted-ui.mdx,auth/overview.mdx,auth/programmatic.mdxreference/cli/managed-auth.mdx(1-line help copy)specs/openapi.documented.yml(1-line endpoint description string only)
- Diff replaces Managed Auth example polling loops (
retrieve+ sleep) with SSE stream consumption (follow/FollowStreaming), and updates related guidance copy (completion checks, wording from “poll” to “stream/listen”). - No application runtime code, infra, CI, auth implementation, schema structure, or shared library changes.
Why Very Low
- Documentation-only surface with no production logic or infrastructure impact.
- Blast radius limited to published docs/examples.
- Easy to reason about; no CODEOWNERS requirement detected; no prior approval to re-evaluate.
Action: Approved per Very Low risk criteria.
Sent by Cursor Automation: Assign PR reviewers
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
followTesting
Note
Low Risk
Documentation-only changes to examples and copy; no runtime or API behavior changes in this diff.
Overview
Updates Managed Auth documentation so login progress is tracked via
auth.connections.follow()(SSE) instead ofretrieve()polling loops with fixed delays.Across Hosted UI, overview, programmatic, and partial credentials guides, TypeScript/Python/Go samples now consume
managed_auth_stateevents, callsubmitwhenflow_stepisAWAITING_INPUT, and treatflow_status === 'SUCCESS'as completion (replacing checks on connectionstatus === 'AUTHENTICATED'). Wording shifts from “poll” to “stream/listen,” and the programmatic page promotes SSE as the default integration path.CLI (
submithelp) and OpenAPI submit endpoint copy now point integrators at the connection SSE stream. A few Python examples switch toAsyncKernelwhere async iteration is required.Reviewed by Cursor Bugbot for commit 55faf1c. Bugbot is set up for automated code reviews on this repo. Configure here.