Pinnate Docs

GitHubApp

Git sync for the registry

Sync OpenAPI, schemas, and rulesets from GitHub or GitLab.

Connect a repository on an API, schema, or ruleset Integrations page.

Typical paths

Resource

Path example

API

openapi/openapi.yaml

Schema

schemas/payment.json

Ruleset

rulesets/spectral.yaml

The path is usually a file (not a docs directory). Site sync uses a directory with site.yaml — see Site git sync.

Workflow

  1. Open a PR that updates the OpenAPI (or schema/rules) file

  2. Merge to the tracked branch

  3. Webhook or manual sync validates and publishes a new version

Monorepo

One remote can back multiple resources with different paths:

repo/
├── openapi/openapi.yaml      # API sync path
├── rulesets/spectral.yaml    # Ruleset sync path
└── docs/                     # Site sync path
    └── site.yaml