Components
Document API parameters and configuration options with type information and badges
The <ParamField> component documents parameters, configuration options, or properties with type information, requirement status, and descriptions. Commonly used in API documentation and configuration references.
## Database Configuration
<ParamField path="host" type="string" required>
Database server hostname or IP address.
</ParamField>
<ParamField path="port" type="number" default="5432">
Database server port.
</ParamField>
<ParamField path="ssl" type="boolean" default="false">
Enable SSL/TLS encryption for database connections.
</ParamField>## Query Parameters
<ParamField path="limit" type="number" body="query" default="10">
Maximum number of results to return (1-100).
</ParamField>
<ParamField path="offset" type="number" body="query" default="0">
Number of results to skip for pagination.
</ParamField>
<ParamField path="sort" type="string" body="query">
Field to sort by. Prefix with `-` for descending order.
**Examples:** `created_at`, `-updated_at`
</ParamField>Each ParamField automatically generates an anchor link for easy reference:
See the [apiKey parameter](#param-apikey) for authentication details.Type badges are color-coded:
Descriptions support full Markdown:
<ParamField path="webhook_url" type="string" required>
HTTPS endpoint to receive webhook events.
**Requirements:**
- Must use HTTPS protocol
- Must return 200 status code
- Response within 5 seconds
See [Webhook Security](/docs/webhooks/security) for best practices.
</ParamField>The parameter name or path. Displayed prominently and used for anchor links.
<ParamField path="user.email" type="string">
User's email address
</ParamField>The data type of the parameter.
Common types: string, number, boolean, object, array, enum
<ParamField path="timeout" type="number">
Request timeout in milliseconds
</ParamField>Whether the parameter is required. Displays a red "required" badge.
<ParamField path="username" type="string" required>
User's unique username
</ParamField>Mark parameter as deprecated with strikethrough and orange badge.
<ParamField path="oldField" type="string" deprecated>
Use newField instead
</ParamField>Default value if parameter is omitted.
<ParamField path="retries" type="number" default="3">
Number of retry attempts
</ParamField>Location of the parameter: query, path, body, or header.
<ParamField path="Authorization" type="string" body="header">
Bearer token for authentication
</ParamField>Next, learn about the ResponseField Component for API response documentation.