Writing contentComponents

Parameter field

The ParamField component documents API parameters and properties with consistent formatting for type, requirements, default values, and descriptions.

Usage

username
stringRequired

The user’s display name

limit
numberDefaults to 50

Maximum number of items to return

Markdown
1<ParamField path="username" type="string" required={true}>
2  The user's display name
3</ParamField>
4
5<ParamField path="limit" type="number" default="50">
6  Maximum number of items to return
7</ParamField>

Variants

Deprecated parameter

api_key
stringDeprecated

Use OAuth authentication instead

Markdown
1<ParamField path="api_key" type="string" deprecated={true}>
2  Use OAuth authentication instead
3</ParamField>

Union types

status
'active' | 'inactive' | 'pending'Defaults to active

The current status of the user account

Markdown
1<ParamField path="status" type="'active' | 'inactive' | 'pending'" default="active">
2  The current status of the user account
3</ParamField>

Properties

path
string

The name of the parameter (e.g., “username”, “limit”)

type
stringRequired

The data type of the parameter (e.g., “string”, “number”, “boolean”)

required
boolean

Indicates if the parameter is required. Displays a “Required” label when true.

default
string

The default value for the parameter, if any

deprecated
boolean

Marks the parameter as deprecated.

toc
boolean

Whether to include the parameter in the table of contents. Defaults to false.