Response Fields

Display API response values

The <ResponseField> component defines API return values and can be used to list types in documentation.

response

string

required

A response field example

Props

name

string

required

The name of the response value.

type

string

required

Expected type of the response value

default

string

The default value.

required

boolean

Show “required” beside the field name.