Components

ParamField

Document API request parameters with type information

ParamField components help you document API parameters clearly with type information and descriptions.

Basic Usage

Request Parameters

idstringrequired

The unique identifier for the resource

limitnumberdefault: 10

Maximum number of results to return

offsetnumberdefault: 0

Number of results to skip for pagination

<ParamFieldGroup title="Request Parameters">
  <ParamField name="id" type="string" required>
    The unique identifier for the resource
  </ParamField>
  <ParamField name="limit" type="number" default="10">
    Maximum number of results to return
  </ParamField>
  <ParamField name="offset" type="number" default="0">
    Number of results to skip for pagination
  </ParamField>
</ParamFieldGroup>

Body Parameters

Body

namestringrequired

User’s display name (1-100 characters)

emailstringrequired

User’s email address

role'admin' | 'user' | 'guest'default: 'user'

User’s role in the system

metadataobject

Additional user metadata as key-value pairs

Props

ParamFieldGroup

title - Group heading (e.g., “Query Parameters”, “Body”)
className - Additional CSS classes

ParamField

name (required) - Parameter name
type - Parameter type (e.g., “string”, “number”)
required - Mark as required
default - Default value
children - Parameter description