graphql-introspect

Use the graphql-introspect policy to introspect a GraphQL schema.

Gateway support

Table 1. Table showing which gateways support this policy, and the corresponding policy version
Gateway	Policy version
DataPower® API Gateway	2.0.0

This topic describes how to configure the policy in your OpenAPI source; for details on how to configure the policy in the assembly user interface, see GraphQL Introspect.

Properties

Table 2. graphql-introspect policy properties
Property	Required	Description	Data type
version	Yes	The policy version number.	string
title	No	The title of the policy.	string
description	No	A description of the policy.	string
input	No	A variable in the API context that contains the input to introspect. The content of the `body` field of the variable is the input to introspect. By default, the variable name is `message`.	string
output	No	A variable in the API context where the results of the introspection are stored. The content of the `body` field of the variable is the result of GraphQL introspection. The default variable name is the same as that of the variable specified for the `input` field. Therefore, by default, the input of the introspection is overwritten by the output.	string

Example

- graphql-introspect:
    version: 2.0.0
    title: introspect the accounts graphql schema
    input: message