The samplesMaxInlineArgs option sets how many arguments are shown inline in the query sample. When there are more arguments than the configured value, every argument will be shown on its own line.
| Option | Type | Description |
|---|---|---|
| samplesMaxInlineArgs | number | Sets the maximum number of inline arguments for samples. Default value is 2. |
The following example allows up to five inline arguments to be displayed in code samples.
redocly.yaml
graphql:
samplesMaxInlineArgs: 5For longer-named arguments, a lower setting may produce more readable samples.
- 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 configuration - Set the default expand level for JSON payload samples to complement inline argument display
- GraphQL configuration - Complete guide to GraphQL configuration options for comprehensive API reference documentation customization