Otter · Schema

ErrorDetail

The error detail response object.

RestaurantOrder ManagementDeliveryOnline OrderingMenu ManagementAnalytics

Properties

Name Type Description
attribute string The error attribute.
message string The error detail description.
View JSON Schema on GitHub

JSON Schema

public-api-error-detail-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ErrorDetail",
  "description": "The error detail response object.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/otter/refs/heads/main/json-schema/public-api-error-detail-schema.json",
  "type": "object",
  "properties": {
    "attribute": {
      "type": "string",
      "description": "The error attribute.",
      "example": "Order Currency Code"
    },
    "message": {
      "type": "string",
      "description": "The error detail description.",
      "example": "Order Currency Code must be exactly 3 characters"
    }
  }
}