Components

Param Field

Reference for documenting API parameters with location badges, types, and status indicators.

Basic syntax

Use the <ParamField> component to document API parameters with their location, type, and requirements.

<ParamField path="id" param-type="string" required="true">
  Unique identifier for the resource.
</ParamField>

Unique identifier for the resource.

Use showLocation="false" to hide the location badge:

<ParamField query="token" param-type="string" showLocation="false" required="true">
  Authentication token without location badge.
</ParamField>

Authentication token without location badge.

Parameter name for URL path parameters.

Parameter name for query string parameters.

Parameter name for HTTP headers.

Parameter name for request body fields.

Data type: string, integer, boolean, object, array, etc.

Set to "true" for required parameters (default: "false").

Set to "true" to mark as deprecated (default: "false").

Set to "false" to hide the location badge (default: "true").

Use exactly one location attribute (path, query, header, or body) per ParamField.