Products:RedocRealm
Plans:ProEnterpriseEnterprise+
Customize the behavior and appearance of integrated GraphQL documentation. Requires a GraphQL schema.
| Option | Type | Description |
|---|---|---|
| menu | object | Menu options. |
| samplesMaxInlineArgs | number | Maximum number of inline arguments for samples. |
| jsonSamplesDepth | number | Sets the default expand level for JSON payload samples. |
| fieldExpandLevel | number | Maximum depth of the Return type in the middle panel. |
| feedback | Feedback object | Hide or customize the type of or text included in the feedback form that displays at the end of each endpoint. |
| showBuiltInScalars | boolean | Show GraphQL built-in scalar types in the navigation and pages. |
| showBuiltInDirectives | boolean | Show GraphQL built-in directives in the navigation and pages. |
- GraphQL - Official GraphQL specification and documentation for understanding query language fundamentals
- Add GraphQL documentation to your project - Step-by-step guide to adding GraphQL API documentation to your Redocly project