SbPublicApiDetailedErrorResponse

snowbee.publicapi.SbPublicApiDetailedErrorResponse

detailsoptional

Structured details; shape depends on error

errorrequired
Example"VALIDATION_ERROR"
messagerequired

Human-readable error message

Example"3 of 5000 items failed validation"
resolutionrequired

Suggested next action

Example"Correct the invalid items and retry the complete batch"
View raw schema
{
  "type": "object",
  "properties": {
    "details": {
      "type": [
        "null",
        "object"
      ],
      "description": "Structured details; shape depends on error",
      "title": "Any"
    },
    "error": {
      "type": "string",
      "example": "VALIDATION_ERROR",
      "title": "String"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message",
      "example": "3 of 5000 items failed validation",
      "title": "String"
    },
    "resolution": {
      "type": "string",
      "description": "Suggested next action",
      "example": "Correct the invalid items and retry the complete batch",
      "title": "String"
    }
  },
  "required": [
    "error",
    "message",
    "resolution"
  ],
  "title": "SbPublicApiDetailedErrorResponse"
}