`graphql`

Products:RedocRealm

Plans:ProEnterpriseEnterprise+

Customize the behavior and appearance of integrated GraphQL documentation. Requires a GraphQL schema.

Options

Option	Type	Description
menu	object	Menu options.
info	Info object	API metadata including title, description, contact, and license information for the overview page.
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.
excludeFromSearch	boolean	Excludes a GraphQL schema from search results and `llms.txt` when set to `true`. Default: `false`.

Examples

Exclude a GraphQL API from search

To exclude a specific GraphQL API from the search results, locate the API in redocly.yaml. Under the graphql key, set the excludeFromSearch option to true.

redocly.yaml

apis:
  library@default:
    root: 'graphql/schema.graphql'
    graphql:
      excludeFromSearch: true

Exclude all GraphQL APIs from search

To exclude all GraphQL APIs from the search results, under the graphql key, set the excludeFromSearch option to true.