Integrations

Connect GitHub

Push your spec to a repo for code review and version control.

Updated

The GitHub integration pushes your current spec into a file on a repository — typically openapi.yaml or spec/openapi.json — so it shows up in code review alongside the implementation.

Connecting

From workspace settings → Integrations, click Connect next to GitHub. You’ll be redirected to GitHub’s OAuth screen. Approve the requested scopes:

  • repo — to write spec files into your repos.
  • user:email — to identify the connecting user.

You’re redirected back, and GitHub shows as Connected.

Pushing your spec

  1. Open the spec you want to push.
  2. From the export panel, click GitHub → Push.
  3. Pick the repo, branch, and target path (e.g. openapi.yaml).
  4. Choose JSON or YAML.
  5. Add a commit message (defaults to “Update OpenAPI spec from OpenAPI Studio”).
  6. Push.

We commit directly to the chosen branch. If the branch doesn’t exist, we create it from the default branch first.

Pull request mode

Instead of committing directly, pick Open as PR in step 6. We’ll create a new branch (openapi-studio/<timestamp> by default), commit the change there, and open a PR against your default branch — ready for review.

Workflow tips

  • Push to a spec branch and open PRs from there to keep main clean.
  • Combine with a CI step that runs your codegen on the latest committed spec.
  • Use hotlinks for read-only consumption; use GitHub for change tracking.

Disconnecting

Workspace settings → Integrations → GitHub → Disconnect. The OAuth token is revoked immediately.