jsonSamplesDepth
The jsonSamplesDepth option sets the default depth for rendering JSON payload samples for queries and responses. Use this option to set the depth to a comfortable default value for the data structure of your API.
Options
| Option | Type | Description |
|---|---|---|
| jsonSamplesDepth | number | Sets the default depth for rendering JSON payload samples. The default value is 1. |
Examples
The following example sets the depth for JSON payload samples to five levels.
redocly.yaml
graphql: jsonSamplesDepth: 5
Using this setting, the samples will show up to five levels of nested payload data.
Related options
- samplesMaxInlineArgs - Maximum number of inline arguments for samples.
- fieldExpandLevel - Maximum depth of the
Return typein the middle panel. - graphql - Learn more about using the
graphqlconfiguration.