ALPHA SETUP GUIDE

From first repository to first draft repair.

API Mender is in alpha. Expect rough edges, and read what it reads and stores before connecting a private repository.

Steps

  1. Create your workspace. Open the workspace, create an account, confirm your email, and name your workspace.
  2. Install the GitHub App. Go to Integrated services, select Connect first API, then Connect GitHub App. Choose only the repositories Mender should see: the one holding your OpenAPI file and the ones that call that API.
  3. Watch your API contract. Choose the repository holding the contract, enter the path to its OpenAPI JSON file, and select Watch API contract. YAML contracts are not supported in this flow.
  4. Connect the code that calls it. Under Watched API, choose the API and the Consumer codebase, then select Connect consumer. Pushes to a connected repository start a new scan.
  5. Add the CI proof workflow. Under Customer CI proof setup, enter a focused test command and the exact text it prints when the old request fails, then select Generate proof workflow. Commit that file to the repository's default branch yourself. Point the test at a test API or a safe read-only endpoint, never at production writes.
  6. Review a finding. Open Findings and select Open evidence. If it's a false alarm, select Dismiss; you can restore it later. There are no alerts for findings yet, so check this page after API changes.
  7. Open a draft repair. Select Preview bounded repair. If two fields could match, Try AI field mapping asks Claude to choose, limited to five attempts per workspace per day. Save the repair job, then select Open draft repair PR.
  8. Check the proof, then decide. Your CI runs the test on the old and new code. Select Check customer CI proof to see the result. Mender never merges: a person on your team reviews the draft and merges it.

What the alpha can and can't do

Detected
REST APIs described by OpenAPI, called from JavaScript or TypeScript in GitHub repositories.
Repaired
One case only: a literal fetch JSON body missing one required field, where an existing field was renamed.
Not supported yet
Other languages, GitLab or Bitbucket, GraphQL or gRPC, dynamic URLs, and calls wrapped in helper functions.
CI proof
A pass shows your test failed before the patch and passed after it. It does not show that every path is safe. If the base branch moves, the proof is withdrawn and you need a new repair.

Report a problem

Open an issue on GitHub. Issues are public, so leave out private code and repository details. For anything private, use the Join us form.