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

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)