Skip to main content

Introspection

This plugin generates a GraphQL introspection file based on your GraphQL schema.

Installation

introspection plugin version
Using yarn
yarn add -D @graphql-codegen/introspection

API Reference

minify

type: boolean default: false

Set to true in order to minify the JSON output.

Usage Examples

generates:
introspection.json:
plugins:
- introspection
config:
minify: true

descriptions

type: boolean default: true

Whether to include descriptions in the introspection result.

specifiedByUrl

type: boolean default: false

Whether to include specifiedByUrl in the introspection result.

directiveIsRepeatable

type: boolean default: true

Whether to include isRepeatable flag on directives.

schemaDescription

type: boolean default: false

Whether to include description field on schema.

federation

type: boolean