Expandables

Document nested object properties

Place <Expandable> inside a field.

​

Usage

<ResponseField name="user" type="object">
  A user record.
  <Expandable title="properties" defaultOpen>
    <ResponseField name="id" type="string" required />
    <ResponseField name="name" type="string" />
  </Expandable>
</ResponseField>

The default title is properties.

​

Example

user · object

A user record.

Hide properties

id · string · required

name · string