REST API Errors (umpire, auth-api, media-library)

This document provides an overview of how errors are structured and what information you can expect in error responses.

Error Response Format

JSON:API error responses consist of a top-level object with the following members:

errors (required): An array of error objects, where each object represents a specific error.
meta (optional): Additional information about the error.

{
  "errors": [
    {
      "status": "422",
      "title": "Validation Error",
      "detail": "The request data is not valid.",
      "source": {
        "pointer": "/data/attributes/title",
        "parameter": "title"
      },
      "meta": {
        "key": "validation_error"
      }
    }
  ]
}

Meta keys

The following meta keys are used in error responses helping to identify the error type for translation purposes.

Key	Description
`validation_error`	The request data is not valid.
`argument_error`	An error related to invalid or missing arguments in the request.
`authorization_error`	An error indicating issues with authentication or authorization, often related to an invalid token or insufficient permissions.
`failed_dependency_error`	An error signifying a dependency required for the request has failed or is unavailable.
`resource_type_conflict_error`	An error indicating a conflict with the resource type, often due to incorrect formatting or type mismatches.
`resource_id_conflict_error`	An error specifying a conflict with the resource identifier, typically related to duplicate or conflicting identifiers.
`jwt_error`	An error related to JSON Web Tokens (JWTs), often indicating issues such as token expiration or verification failures.
`unsupported_include_error`	An error indicating that the requested include paths are not supported or allowed in the API.
`unprocessable_entity_error`	An error relating to an entity within the request that cannot be processed due to issues with the data or user associated with it.
`unprocessable_pagination_error`	An error suggesting that the provided pagination parameters are not valid or cannot be processed.
`bad_request_error`	An error indicating a malformed or invalid request, often due to missing or incorrectly formatted data.
`not_found_error`	An error indicating that the requested resource could not be found or does not exist in the system.