GitHub source synchronization

Open Settings > API Source, choose GitHub and connect an integration authorized for your repository. Select the repository, branch and JSON or YAML specification file. Preview the definition before saving. Installation permissions determine which repositories are visible.

Run a manual source check after changing the specification in GitHub. Review detected changes and resolve conflicts before applying updates. Automatic checks and auto-apply settings are separate choices; select a schedule within the account plan minimum interval. Monthly check quotas apply across the account.

This workflow imports a repository definition. It does not promise to push local API Designer edits back to GitHub.

Missing repository: check GitHub App installation access. Missing branch or file: verify the selected branch and path. Invalid definition: validate its OpenAPI version and JSON or YAML syntax. YAML aliases are unsupported for GitHub sources.

When updates stop, inspect source errors and account source-check usage before rerunning. Avoid pasting repository tokens into URLs or support messages.