ParamField

Usage

<ParamField> documents a single API parameter. Stack several together to describe an endpoint's full input contract.

<ParamField name="projectId" type="string" required path="path">
  The UUID of the project. Copy it from the dashboard URL.
</ParamField>

<ParamField name="limit" type="number" default="20" path="query">
  Number of results per page. Maximum 100.
</ParamField>

Parameter location badge

Set the path prop to show where the parameter lives in the request. The badge appears next to the type and helps readers parse a busy endpoint at a glance.

<ParamField name="Authorization" type="string" required path="header">
  Bearer token from your dashboard.
</ParamField>

<ParamField name="name" type="string" required path="body">
  The new project name shown in the sidebar.
</ParamField>

Enum options

Pass an enum array to render the allowed values inline below the description:

<ParamField name="theme" type="string" enum={["light", "dark", "system"]} default="system">
  The default theme for visitors arriving without a saved preference.
</ParamField>

Deprecated parameters

Mark a parameter as deprecated to strikethrough the name and add a warning badge:

<ParamField name="legacyId" type="string" deprecated>
  Use `id` instead. This parameter will be removed in v2.
</ParamField>

Default value

The default prop is rendered as inline metadata next to the type and badge:

<ParamField name="page" type="number" default="1" path="query">
  Page number to fetch.
</ParamField>

Mintlify compatibility

Mintlify uses the location as the prop name with the parameter name as the value. Both styles are supported:

{/* Mintlify style */}
<ParamField path="user_id" type="string" required>
  The user's unique identifier.
</ParamField>

<ParamField query="page" type="integer" default="1">
  Page number.
</ParamField>

<ParamField body="email" type="string" required>
  User's email address.
</ParamField>

<ParamField header="Authorization" type="string" required>
  Bearer token.
</ParamField>

When name is absent, the location prop value is used as the parameter name and the location is inferred from the prop name. When name is present, use path as a location indicator (NookDocs style).

Auto-generation from OpenAPI

If your project has an OpenAPI spec configured via api.openapi, ParamField entries are generated automatically on the API reference pages — you don't need to write them by hand. See the OpenAPI integration guide for details. Manually-written ParamField components are still useful for examples in concept pages and tutorials.

Props

NookDocs style

Mintlify-compatible style

For documenting response fields, use <ResponseField> — it's the output twin.