Apideck · Schema

UnprocessableResponse

IntegrationsUnified API

Properties

Name Type Description
status_code number HTTP status code
error string Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)
type_name string The type of error returned
message string A human-readable message providing more details about the error.
detail object Contains parameter or domain specific information related to the error and why it occurred.
ref string Link to documentation of error type
View JSON Schema on GitHub

JSON Schema

apideck-unprocessableresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UnprocessableResponse",
  "title": "UnprocessableResponse",
  "type": "object",
  "x-apideck-schema-id": "Unprocessable",
  "properties": {
    "status_code": {
      "type": "number",
      "description": "HTTP status code",
      "example": 422
    },
    "error": {
      "type": "string",
      "description": "Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)",
      "example": "Unprocessable Entity"
    },
    "type_name": {
      "type": "string",
      "description": "The type of error returned",
      "example": "InvalidStateError"
    },
    "message": {
      "type": "string",
      "description": "A human-readable message providing more details about the error.",
      "example": "Invalid State",
      "x-speakeasy-error-message": true
    },
    "detail": {
      "anyOf": [
        {
          "type": "string",
          "example": "Unprocessable request, please verify your request headers and body."
        },
        {
          "type": "object",
          "x-speakeasy-detail": true,
          "example": {
            "error": "Unprocessable",
            "message": "Unprocessable request, please verify your request headers and body."
          }
        }
      ],
      "description": "Contains parameter or domain specific information related to the error and why it occurred."
    },
    "ref": {
      "type": "string",
      "description": "Link to documentation of error type",
      "example": "https://developers.apideck.com/errors#invalidstateerror"
    }
  }
}