The <ResponseField> component is designed to define the return values of an API. Many docs also use <ResponseField> on pages when you need to list the types of something.

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.