Agent-readable docs index: /llms.txt. Full docs in one file: /llms-full.txt. Download /docs.zip to grep all markdown files locally.

Request and Response Examples

Generated OpenAPI pages render request and response information based on your spec's schemas.

Request parameters

Query parameters are listed with their type, description, and required/optional status. Path parameters show in the endpoint path, and header parameters only in the cURL example.
Each field shows its constraints as small tags: default, example (or the first of examples), pattern, minimum/maximum (exclusiveMinimum shows as > 0), lengths and item counts. readOnly and writeOnly get a badge. Mintlify parameter pills work too: x-mint: { pre: [PII], post: [indexed] } on a schema shows those labels before and after the field name. Add x-enumDescriptions (a value → text map, or x-enum-descriptions as a list) to describe each enum value on its own line:
step:
  type: string
  enum: [pair, ready]
  x-enumDescriptions:
    pair: Pair the Mac from iPhone Settings > Bluetooth
    ready: Agents can use it

Authorization

The Authorization section lists the security schemes the operation accepts. When security includes an empty requirement (- {}), auth is optional and the section shows an optional badge. The cURL example sends the first non-empty requirement: a bearer header, -u for basic auth, or the apiKey header, query param or cookie by its name.

Servers

The cURL example uses the first server. Server variables like {scheme}://{host}:{port} are filled with their default values.

Request body

If an operation has a requestBody, Holocron renders the schema as a structured field list. JSON Schema properties become rows with name, type, and description.

Response schemas

Each response status code (200, 201, 400, etc.) is rendered with its schema. Multiple response codes are shown in separate sections.

Examples in the spec

Holocron renders a generated cURL request in the right-side aside, plus:
  • x-codeSamples on the operation (SDK / CLI snippets) as extra Request example tabs. See SDK examples.
  • Named request-body and response example / examples as JSON tabs.
Schema and parameter examples are still useful context in the field list, but they are not separate aside code blocks.
paths:
  /users:
    get:
      responses:
        '200':
          description: List of users
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'
              example:
                - id: 1
                  name: Alice
                - id: 2
                  name: Bob

Two-column layout

On desktop, the request/response examples appear in the right aside column next to the parameter descriptions. On mobile, they stack below the parameters.