magento · Schema

Error

Standard error response returned for 4xx and 5xx responses.

Properties

Name Type Description
message string Human-readable error message.
parameters array Additional error context parameters.
View JSON Schema on GitHub

JSON Schema

magento-error-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Error",
  "title": "Error",
  "type": "object",
  "description": "Standard error response returned for 4xx and 5xx responses.",
  "properties": {
    "message": {
      "type": "string",
      "description": "Human-readable error message."
    },
    "parameters": {
      "type": "array",
      "description": "Additional error context parameters.",
      "items": {
        "type": "object"
      }
    }
  }
}