Parameter Fields

1 min readStableIntermediate

The ParamField component provides structured documentation for API request parameters — name, type, location, required/optional status, default value, and deprecation state.

Quick Start

A single required path parameter.

idstringpathrequired

The unique identifier for the resource.

Adding Options

Query parameters with default values.

pageintegerqueryDefault: 1

Page number for paginated results.

limitintegerqueryDefault: 20

Maximum number of items to return.

Advanced

A deprecated parameter and a required body parameter.

fieldsstringquerydeprecated

Comma-separated list of fields. Use the select parameter instead.

payloadobjectbodyrequired

JSON request body payload.

Options

namestringrequired

Parameter name in monospace.

typestring

Data type label.

locationstring

path, query, body, or header.

requiredbooleanDefault: false

Shows a red "required" label.

defaultValuestring

Default value as inline code.

deprecatedbooleanDefault: false

Shows an amber "deprecated" label.

childrenReactNode

Description text under the field; supports inline Markdown.

API Blocks

Response Fields

Was this page helpful?