Skip to content

Use SSE for Managed Auth examples - #493

Merged
masnwilliams merged 1 commit into
mainfrom
hypeship/use-managed-auth-sse
Aug 7, 2026
Merged

Use SSE for Managed Auth examples#493
masnwilliams merged 1 commit into
mainfrom
hypeship/use-managed-auth-sse

Conversation

@masnwilliams

@masnwilliams masnwilliams commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Summary

  • replace polling loops in Managed Auth TypeScript, Python, and Go examples with the connection SSE stream
  • make SSE the recommended flow in Hosted UI and programmatic guidance
  • align CLI and API reference copy with follow

Testing

  • checked JavaScript and Python snippet syntax
  • compiled the complete Go examples against the current Go SDK
  • loaded all changed documentation pages successfully in the Mintlify preview
  • verified no polling loops remain in Managed Auth docs

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 of retrieve() polling loops with fixed delays.

Across Hosted UI, overview, programmatic, and partial credentials guides, TypeScript/Python/Go samples now consume managed_auth_state events, call submit when flow_step is AWAITING_INPUT, and treat flow_status === 'SUCCESS' as completion (replacing checks on connection status === 'AUTHENTICATED'). Wording shifts from “poll” to “stream/listen,” and the programmatic page promotes SSE as the default integration path.

CLI (submit help) and OpenAPI submit endpoint copy now point integrators at the connection SSE stream. A few Python examples switch to AsyncKernel where async iteration is required.

Reviewed by Cursor Bugbot for commit 55faf1c. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview Aug 7, 2026, 7:41 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@vercel

vercel Bot commented Aug 7, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs Error Error Aug 7, 2026 7:40pm

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.mdx
    • reference/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.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

@masnwilliams
masnwilliams merged commit 512e314 into main Aug 7, 2026
6 of 7 checks passed
@masnwilliams
masnwilliams deleted the hypeship/use-managed-auth-sse branch August 7, 2026 19:50
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