samplesMaxInlineArgs
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.
Options
Option | Type | Description |
---|---|---|
samplesMaxInlineArgs | number | Sets the maximum number of inline arguments for samples. Default value is 2 . |
Examples
The following example allows up to five inline arguments to be displayed in code samples.
redocly.yaml
graphql: samplesMaxInlineArgs: 5
For longer-named arguments, a lower setting may produce more readable samples.
Related options
- jsonSamplesDepth - Sets the default expand level for JSON payload samples.
- graphql - Learn more about using
graphql
configuration.