---
title: ParamField
description: Document request parameters — body, query, path, and header.
url: http://localhost:3040/components/param-field
---

# ParamField

Document request parameters — body, query, path, and header.

`<ParamField>` renders a structured parameter entry for API request documentation. Use `body`, `query`, `path`, or `header` props to specify the parameter location.

## Example

- **name** (string):
  The name of the pet. Must be between 1 and 100 characters.

- **limit** (integer):
  Number of results to return. Maximum is 100.

- **petId** (string):
  The unique identifier of the pet.

- **Authorization** (string):
  Bearer token for authentication: `Bearer sk-...`

```mdx
<ParamField body name="name" type="string" required>
  The name of the pet.
</ParamField>

<ParamField query name="limit" type="integer" default="20">
  Maximum results to return.
</ParamField>

<ParamField path name="petId" type="string" required>
  The unique identifier.
</ParamField>
```

## Props

| Prop | Type | Description |
|---|---|---|
| `name` | `string` | Parameter name |
| `type` | `string` | Data type (e.g. `string`, `integer`, `boolean`) |
| `body` | `boolean` | Marks as a request body parameter |
| `query` | `boolean` | Marks as a query string parameter |
| `path` | `boolean` | Marks as a path parameter |
| `header` | `boolean` | Marks as a request header |
| `required` | `boolean` | Shows a "required" badge |
| `default` | `string` | Default value shown inline |