Skip to content

Document health_checks and auto_reauth connection flags#374

Open
aylee855 wants to merge 1 commit into
mainfrom
hypeship/auth-config-flags
Open

Document health_checks and auto_reauth connection flags#374
aylee855 wants to merge 1 commit into
mainfrom
hypeship/auth-config-flags

Conversation

@aylee855
Copy link
Copy Markdown
Contributor

@aylee855 aylee855 commented May 22, 2026

Summary

Adds documentation for the two new managed-auth connection flags shipped on the API:

  • health_checks (boolean, default true) — whether periodic health checks run at all.
  • auto_reauth (boolean, default true) — whether a failing scheduled health check is allowed to attempt re-authentication.

Updates /auth/configuration:

  • Expands "Credentials and Auto-Reauth" to introduce both flags, the interaction between them (auto_reauth is only meaningful while health_checks is true), and a create-time example with both disabled.
  • Notes that auto_reauth: true is opt-in only — connections still transition to NEEDS_AUTH when reauth preconditions (e.g. saved credentials) aren't met.
  • Adds both fields to the "Updating a Connection" table and notes the changes take effect immediately on the running connection.

Test plan

  • Preview renders cleanly on Mintlify
  • Code samples copy/paste correctly in both TypeScript and Python

Note

Low Risk
Low risk documentation-only change; no product logic or APIs are modified.

Overview
Adds documentation to auth/configuration.mdx explaining the new connection flags health_checks and auto_reauth, including their defaults, interaction, and the fact that auto_reauth is best-effort and may still result in NEEDS_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.

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>
@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 22, 2026

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

Project Status Preview Updated (UTC)
Kernel 🟢 Ready View Preview May 22, 2026, 12:24 AM

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

Copy link
Copy Markdown
Contributor

@masnwilliams masnwilliams left a comment

Choose a reason for hiding this comment

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

lgtm

@masnwilliams masnwilliams marked this pull request as ready for review May 22, 2026 18:03
@firetiger-agent
Copy link
Copy Markdown

Firetiger deploy monitoring skipped

This PR didn't match the auto-monitor filter configured on your GitHub connection:

Any PR that changes the kernel API. Monitor changes to API endpoints (packages/api/cmd/api/) and Temporal workflows (packages/api/lib/temporal) in the kernel repo

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 @firetiger monitor this.

Copy link
Copy Markdown

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

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.

Open in Web View Automation 

Sent by Cursor Automation: Assign PR reviewers

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.

2 participants