A valid API Suite account with the required permissions. An API Suite account is required only if the GraphQL end point requires credentials to function. Otherwise, the account can be omitted.

A GraphQL end point, which is the server URL.

A GraphQL schema defined on the server.

In the schema provided by the server at the GraphQL endpoint, the root field that you want to query must implement cursor based pagination. It should use field parameters that enable pagination to be controlled by the user-defined variables at the top level of your GraphQL query (and pass them as arguments to the root field).

The schema must contain a Boolean field whose return value indicates the presence of additional pages of data.

The schema must contain a field whose value can be used to represent Position in the queried data (acting as a cursor). The field’s value must be usable directly for this purpose (without transformation or combination with another field’s value).

This Snap does not support subscriptions.

For key-value pairs defined in the GraphQL variables settings, string values must be contained in double quotes (" ").

The validation for the Variable name and Cursor variable name fields against variable names parsed from the query is now done in the document processing stage.

For Variable name and Cursor variable name suggestible fields, a warning message is displayed if the suggested variable names cannot be generated. This happens when the Query setting uses upstream parameters in its expression and the query cannot be evaluated during the suggestion stage.

Has additional page path, Next cursor path, and Cursor variable name will no longer produce configuration errors that stop Snap execution for validation issues, such as missing or invalid values, because they are now evaluated during document processing and the values may differ between input documents. These will now produce Snap data errors that write documents to the error view, and the Snap continues to process additional input documents.

• When the query is copied from the Snap to the query builder, it remains in expression format (for example, ${variableName}) instead of being converted into valid GraphQL syntax.

• As the expression isn’t evaluated before being passed into the query builder, the UI takes raw expressions instead of actual query values. Evaluation happens later. This behavior is bidirectional and expected. That is, when you copy a valid GraphQL query back into the Snap, it might not translate into an expression string. For example:

  If your query builder expects:

  query {
  
    user(id: "123") {
  
    name
  
    }
  
  }

  But the Snap uses expressions like:

  query {
  
    user(id: "${userId}") {
  
    name
  
    }
  
   }

The GraphQL Snap retires 401 responses by reloading the account between attempts. If the maximum number of attempts is exhausted and the response still contains a 401, the Snap stops the execution instead of writing to the error view because the error is now unrecoverable.

• Any error document caused by an error reported in the GraphQL Client Snap response now has a generic error message, similar to the errors reported by the GraphQL server while processing requests. The specific error message (and other additional details) are now available under the graphqlErrors field of the error document.

• Data for all GraphQL errors reported for a single request (or single page request when pagination is enabled) is now available in the same error document under the graphqlErrors field.

• Any error document generated by an error reported in the GraphQL Client Snap response now includes the query and variables for the request that caused it in the query and graphqlVariables fields, respectively.