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 the assembly user interface; for details on how to configure the policy in your OpenAPI source, see graphql-introspect.

Properties

The following table lists the policy properties, indicates whether a property is required, specifies the valid and default values for input, and specifies the data type of the values.

Table 2. GraphQL introspect policy properties
Property label Required Description Data type
Title No The title of the policy.

The default value is graphql-introspect.

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 in the Input field. Therefore, by default, the input of the introspection is overwritten by the output. string