API Components
Response Fields
API Components
Response Fields
Display API response values
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
requiredA response field example
Props
name
string
requiredThe name of the response value.
type
string
requiredExpected type of the response value
default
string
The default value.
required
boolean
Show “required” beside the field name.
Was this page helpful?