Pinnate Docs

GitHubApp

API reference layout

Customize ordering and visibility in the API reference.

Configure the sidebar for an API embed section with api_layout in site.yaml:

sections:
  - name: API
    slug: api
    api: payments
    api_layout:
      tag_order:
        - Pets
        - Users
      hide_tags:
        - Internal
      hide_operations:
        - GET /health
        - POST /pets/{petId}
      hide_models: true
      flatten: false

Key

Type

Notes

tag_order

string[]

Preferred tag order; unspecified tags follow afterward

hide_tags

string[]

Drop entire tags (and their operations)

hide_operations

string[]

METHOD /path or op:method/path

hide_models

bool

Omit the Models group

flatten

bool

List operations without tag folders (still respects tag_order)

Layout applies to the generated OpenAPI nav used by public docs (empty section menus, which is the default after git sync). Editor-reordered menus keep their custom order until cleared.

Markdown injection into the reference tree is not supported yet — link related guides from a neighboring guide section.