Components

Response field

Document object properties and schema fields.

Use ResponseField for response body fields, object properties, and similar schema documentation. Nest fields under headings to document nested objects.

Basic usage#

idstringrequired

Unique identifier for the resource.

<ResponseField name="id" type="string" required>
  Unique identifier for the resource.
</ResponseField>

Optional and deprecated fields#

legacyFieldnumberdeprecated

Removed in a future release.

<ResponseField name="legacyField" type="number" deprecated>
  Removed in a future release.
</ResponseField>

Properties#

Name	Type	Description
namerequired	string	Field name.
type	string \| number \| boolean \| null	Type label. HTML entities in string values are decoded before rendering.
required	boolean	Shows a required badge. Default: false
deprecated	boolean	Shows a deprecated badge. Default: false
children	ReactNode	Field description.

Last updated on Aug 8, 2026

Param field Steps