Skip to main content

ErrorExtensions

The ErrorExtensions type is used to communicate additional information about the error, should be used in conjunction with the Error interface. It extends the error message with more detailed information about the problem following the RFC9457 standard: https://www.rfc-editor.org/rfc/rfc9457.html

type ErrorExtensions {
  detail: String!
  status: Int!
  timestamp: Time!
  title: String!
  type: String!
  errors: [ErrorProblem]
}

Fields​

ErrorExtensions.detail ● String! non-null scalar​

A human-readable explanation specific to this occurrence of the problem. For example: could not connect with the database It provides a more detailed message which can assist in diagnosing or fixing the issue.

ErrorExtensions.status ● Int! non-null scalar​

The HTTP status code generated by the server for this occurrence of the problem. The status code matches the type of error, for example a 404 status code for a not found error.

ErrorExtensions.timestamp ● Time! non-null scalar​

A timestamp indicating when the problem was generated. This helps in logging and tracing the error, especially in systems where timing is critical.

ErrorExtensions.title ● String! non-null scalar​

A short, human-readable summary of the problem type. It does not vary for different occurrences of the problem and is designed to be used in conjunction with the type field, for example Bad Request.

ErrorExtensions.type ● String! non-null scalar​

A URI reference that identifies the problem type. It is a URL that, when dereferenced, provides human-readable documentation about the problem, for example /errors/input.

ErrorExtensions.errors ● [ErrorProblem] list object​

A list of optional problems details that are related to the main problem, for example a list of validation errors. This should be used together with Error interface.

Member Of​

AddressNotFoundError object ● Error interface ● UsageOutsideOfThresholdError object