Components

Param field

Document request parameters with location and type badges.

Use ParamField for query, path, header, or body parameters, and Param for inline parameter names.

Basic usage#

limitquerynumberrequired

Maximum number of records to return.

<ParamField name="limit" query="limit" type="number" required>
  Maximum number of records to return.
</ParamField>

Location variants#

userIdpathstringrequired

User id in the URL path.

Authorizationheaderstringrequired

Bearer token.

<ParamField path="userId" type="string" required>
  User id in the URL path.
</ParamField>

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

The location badge is inferred from query, path, header, or body. If several are set, precedence is query → path → header → body. The display label is name, or the first location prop value when name is omitted.

Inline parameter names#

Set limit and offset together for pagination.

Set <Param>limit</Param> and <Param>offset</Param> together for pagination.

Properties#

ParamField#

Name	Type	Description
name	string	Display label for the parameter.
query	string	Query parameter name. Marks the field as a query param.
path	string	Path parameter name. Marks the field as a path param.
header	string	Header name. Marks the field as a header param.
body	string	Body field name. Marks the field as a body param.
type	string	Type label shown next to the name.
required	boolean	Shows a required badge. Default: false
children	ReactNode	Parameter description.

Param#

Name	Type	Description
children	ReactNode	Inline parameter name rendered as code.

Last updated on Aug 8, 2026

Icon Response field