Last updated

generatedSamplesMaxDepth

The generatedSamplesMaxDepth option controls how many schema levels automatically generated for payload samples. The default is 8 which works well for most APIs, but you can adjust it if necessary for your use case.

Options

OptionTypeDescription
generatedSamplesMaxDepthnumberSet the number of levels to generate payload samples. Default value is 8.

Examples

The following example produces automatically generated payload samples with 3 levels:

redocly.yaml
openapi:
  generatedSamplesMaxDepth: 3
  • openapi - Learn more about using openapi configuration.

Resources