Skip to main content

Keeping your API current

Weekly update workflows​

From Install, add the GitHub workflows that keep Frankie in step with your code:

  • SDK updates open a pull request when a new @frankieai/react is released.
  • API sync proposes spec changes when your routes change.

Neither merges anything on its own.

Reviewing the spec by hand​

In GitHub integration → choose a workspace → API specification, click Review repo & update spec. Frankie reads one snapshot of the default branch and proposes a draft pull request when edits are found. It preserves authored schemas, security declarations and operation IDs, and documents write methods as well as reads. Existing proposals and maintainer edits are never force-pushed.

The spec is auto-detected when there is one JSON or YAML OpenAPI document. Use Review settings to choose a different repository-relative path, or to select an app root in a monorepo. With no existing spec, a single-app repo starts at public/frankie.openapi.json.

Refreshing the agent​

Review the pull request, complete its request and response schemas, remove retired operations if appropriate, run your checks, and merge it. Then choose the existing API connection and click Refresh Frankie from merged spec. This reads the default branch again and records the repository, path, commit and refresh time. It never loads a proposed branch into a running agent.

Refresh keeps the connection's credentials, base URL, enabled state and limits. Only approvals for identical operations survive:

  • New, changed or removed operations lose approval.
  • Changes to shared components or security revoke affected approvals.

Changes apply to the next agent turn, not a call already running.

Remote specs

For a remote spec, set an explicit API base URL before the first refresh. A changed servers declaration also requires an explicit base URL, so a refresh can never redirect forwarded user credentials.

What the review can and can't see​

  • Static discovery supports Next.js App Router named HTTP exports, including aliases, literal query parameter names and JSON body detection. It never runs your code.
  • Imported validators, middleware, rewrites, response types and authorization need human review. Unknown schemas are marked for review, never invented.
  • Other frameworks and unrecognised routes appear in review notes. A missing handler doesn't prove deletion, so existing operations are kept until a reviewer removes them.
  • OpenAPI 3.0 and 3.1, JSON and YAML. Bundle external references into the selected document before refreshing.
  • A review covers up to 350 candidate source files, 6 MB of source and a 1 MB spec.