GraphQL Error Handling

When a Compass GraphQL query or mutation is executed, an error may be returned. This page explains what those errors mean.

Query errors

Query errors are typically returned inside the QueryError objects. For example:

1
2
{
  "data": {
    "compass": {
      "component": {
          "__typename": "QueryError",
          "message": "Component not found", // A developer readable error message. May change over time.
          "extensions": [
            {
              "statusCode": 404, // An HTTP status code representing the error
              "errorType": "COMPONENT_NOT_FOUND", // A code representing the error. This will not change over time.
            }
          ]
        }
      }
    }
  }
}

Mutation errors

Mutation errors are typically found in mutation payload objects. For example:

1
2
{
  "data": {
    "compass": {
      "updateComponent": {
        "__typename": "UpdateCompassComponentPayload",
        "success": false,
        "errors": [
          {
            "message": "The component’s Atlassian resource identifier (ARI) is invalid. Try again with a valid ARI.", // A developer readable error message. May change over time.
            "extensions": {
              "statusCode": 400, // An HTTP status code representing the error
              "errorType": "COMPONENT_ARI_INVALID" // A code representing the error. This will not change over time.
            }
          }
        ],
        "componentDetails": null
      }
    }
  }
}

Error types

The following error types may be returned by Compass queries and mutations.