SHSelfHealAPI
Documentation

SelfHealAPI Docs

Everything your team needs to connect repositories, monitor APIs, and review SelfHealAPI Pull Requests.

1. 2-Minute Quickstart

Complete the 4-step Onboarding Wizard. Non-technical founders can enter their developer’s email in Step 3 so the developer receives a 1-click GitHub App install link while the founder keeps access to deprecation alerts.

2. Public & Custom OpenAPI URLs

SelfHealAPI auto-detects APIs from package.json, requirements.txt, and base URLs. You can also paste any public HTTPS OpenAPI 3.x / Swagger JSON or YAML URL. All URLs are validated against our SSRF policy (HTTPS only, private IPs blocked).

3. Confidence Scores & Fallback Alerts

  • High Confidence (Tier 1 Deterministic): Applied via verified ast-grep rules with 0 AI tokens.
  • Medium Confidence (Leftover AI Patch): Applied strictly to the matched lines and verified through our Diff Firewall + AST parser.
  • Manual Migration Issue: For architectural changes (e.g., REST to GraphQL), SelfHealAPI opens an informative GitHub Issue instead of guessing.

4. GitHub App Permissions

We request only Contents (Read & Write) to create a feature branch, Pull Requests (Read & Write), and Issues (Write) for fallback alerts. We never request Admin, Secrets, or Workflow write permissions.

5. Frequently Asked Questions

Does SelfHealAPI ever auto-merge PRs?

No. A human on your team must always review and click Merge.

How are tests run?

When we open a Pull Request, your existing GitHub Actions CI pipeline runs your tests automatically.