The fieldExpandLevel option allows you to specify the maximum depth of the data available in the Return type section. Use this option to define how much information is in this context; the user can click on the fields to view further arguments and other details.
| Option | Type | Description |
|---|---|---|
| fieldExpandLevel | number | Indicates the maximum depth of the data described in the "Return type" section. This setting allows users to expand the fields to view further arguments and other details. Default value is 4. |
The following example sets the maximum depth of the Return type to three.
redocly.yaml
graphql:
fieldExpandLevel: 3If you have fields with more than three levels of data structure within them, users will need to visit the data types documentation for that type rather than having it all displayed in the "Return type" section.
- GraphQL - Official GraphQL specification and documentation for understanding query language fundamentals
- GraphQL configuration - Complete guide to GraphQL configuration options for customizing API reference documentation
- JSON samples depth - Set the default expand level for JSON payload samples to work alongside field expand level settings