Document health_checks and auto_reauth connection flags#374
Conversation
Document the new health_checks and auto_reauth boolean flags on managed auth connections. Both default to true. Explains the interaction (auto_reauth is gated by health_checks running) and notes that auto_reauth is opt-in only — it doesn't guarantee reauth feasibility. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Firetiger deploy monitoring skipped This PR didn't match the auto-monitor filter configured on your GitHub connection:
Reason: PR only updates documentation for existing API flags; it does not change kernel API endpoints or Temporal workflows themselves. To monitor this PR anyway, reply with |
There was a problem hiding this comment.
Risk assessment: Very Low.
This PR only updates auth/configuration.mdx with documentation for health_checks and auto_reauth. I found no production code, config, schema, infrastructure, or shared-library changes in the diff, and no CODEOWNERS file requiring a code owner review for this path.
The PR is already approved, so I did not add another approval.
Sent by Cursor Automation: Assign PR reviewers


Summary
Adds documentation for the two new managed-auth connection flags shipped on the API:
health_checks(boolean, defaulttrue) — whether periodic health checks run at all.auto_reauth(boolean, defaulttrue) — whether a failing scheduled health check is allowed to attempt re-authentication.Updates
/auth/configuration:auto_reauth: trueis opt-in only — connections still transition toNEEDS_AUTHwhen reauth preconditions (e.g. saved credentials) aren't met.Test plan
Note
Low Risk
Low risk documentation-only change; no product logic or APIs are modified.
Overview
Adds documentation to
auth/configuration.mdxexplaining the new connection flagshealth_checksandauto_reauth, including their defaults, interaction, and the fact thatauto_reauthis best-effort and may still result inNEEDS_AUTH.Updates examples to show disabling both flags at creation time, and extends the connection update table/notes to include these fields and clarify that changes take effect immediately.
Reviewed by Cursor Bugbot for commit cb6ee08. Bugbot is set up for automated code reviews on this repo. Configure here.