Generated Pages

When you set "openapi": "openapi.json" on a tab, Holocron generates one page per operation in the spec.

Slug format

Each operation gets a slug derived from the method and path:

Operation	Generated slug
`GET /users`	`api/get-users`
`POST /users`	`api/post-users`

The base prefix (default "api") is prepended to all slugs.

Custom endpoint URLs

Set x-holocron.href on an operation to replace its generated slug. The Mintlify-compatible x-mint.href alias works too.

12345paths:
  /users:
    get:
      x-holocron:
        href: /api-reference/users/list

This endpoint renders at /api-reference/users/list instead of /api/get-users. Custom href values must be internal paths without a query string or hash.

Grouping by tags

Operations are grouped by their tags field in the spec. Each tag becomes a sidebar group:

123456789101112paths:
  /users:
    get:
      tags: [Users]
      operationId: listUsers
    post:
      tags: [Users]
      operationId: createUser
  /teams:
    get:
      tags: [Teams]
      operationId: listTeams

This produces:

Users group: get-users, post-users
Teams group: get-teams

The group label follows Mintlify: the tag's x-group, then the OpenAPI 3.2 tag summary, else the tag name as written. Redocly's x-displayName also works.

123tags:
  - name: api-keys
    x-group: API keys

Sidebar labels

Same order as Mintlify. The page title is metadata.title, then summary, then operationId. The sidebar label is metadata.sidebarTitle, else the page title. Set sidebarTitle when the title is long:

1234x-holocron:
  metadata:
    title: Take exclusive use of one iPhone
    sidebarTitle: Acquire lease

Hiding endpoints

Mintlify's visibility extensions work on any operation. x-hidden: true keeps the page but leaves it out of the sidebar, for endpoints you link to but do not promote. x-excluded: true generates no page at all.

Overview page

In a tab without pages or groups, the spec's info.description becomes an Overview page at <base>/overview, above the tag groups. It renders as Markdown. Tabs that list their own pages skip it: write your intro page there instead.

Page layout

Generated API pages use a two-column layout:

Left column: description, parameters, request body schema
Right column: request and response examples (displayed in the aside)

Ask AI about this page