Adding a GraphQL introspect assembly action

A GraphQL introspect assembly action introspects a GraphQL schema.

About this task

The correlation path indicates the part of the API definition that correlates with the assembly action. This path is included in the debug data for use by debugging tools. For example, when an API configuration is specified in an OpenAPI document with gateway extensions, this path is the JSON path to the policy in the IBM extensions section of the document. The path can be expressed in any form that the debugging tool can correlate to the API definition.

Procedure

  1. In the search field, enter graphql.
  2. From the search results, click GraphQL introspect assembly action.
  3. Click Add.
  4. Define the basic properties: Name, administrative state, descriptive summary, title, and correlation path.
  5. Optional: Specify a description.
  6. Optional: Specify an API context variable for the input.
    The input variable is a variable in the API context that contains the input to introspect. The content of the body field is the input to introspect. By default, the variable name is message.
  7. Optional: Specify an API context variable for the output.
    The input variable is a variable in the API context to store the introspection results. The content of the body field is the result of GraphQL introspection. The default variable is the same as the input variable. Therefore, by default, the input of the introspection is overwritten by the output.
  8. Click Apply to save changes to the running configuration.
  9. Click Save to save changes to the persisted configuration.