Parameters
The ParamField component helps document API parameters and properties with consistent formatting. It displays the parameter name, type, requirements, and description in a structured layout.
Properties
path
The name of the parameter (e.g., “username”, “limit”)
type
The data type of the parameter (e.g., “string”, “number”, “boolean”)
required
Indicates if the parameter is required. Displays a “Required” label when true.
default
The default value for the parameter, if any
deprecated
Marks the parameter as deprecated. Shows a “Deprecated” warning when true.