Pinnate Docs

GitHubApp

OpenAPI embed

Point a site section at an organization API.

site.yaml

- name: API
  slug: api
  api: payments

api resolves by id or slug in the same organization. Unresolved refs fail git sync.

Requirements

  • The API must exist in the organization

  • Publish an OpenAPI version so the embed is not empty

  • Prefer stable slugs so renames in prose stay valid

Multiple APIs

Add multiple embed sections (or group them under More):

- name: More
  children:
    - name: Payments API
      slug: payments-api
      api: payments
    - name: Platform API
      slug: platform-api
      api: platform