Last updated

sortRequiredPropsFirst

By default, fields are rendered in the order they appear in the API description.

The sortRequiredPropsFirst option changes the order to display required fields first in each schema section.

Options

OptionTypeDescription
sortRequiredPropsFirstbooleanSort the required schema properties before the optional ones. Default value is false.

Examples

The following example configures Redoc to show required properties first:

redocly.yaml
openapi:
  sortRequiredPropsFirst: true
  • openapi - Learn more about using openapi configuration.

Resources