Atlassian · Schema

ErrorResponse

Standard error response.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
code integer The HTTP status code.
message string A human-readable error message.
errors array Detailed error information.
View JSON Schema on GitHub

JSON Schema

atlassian-errorresponse-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ErrorResponse",
  "title": "ErrorResponse",
  "type": "object",
  "description": "Standard error response.",
  "properties": {
    "code": {
      "type": "integer",
      "description": "The HTTP status code.",
      "example": 10
    },
    "message": {
      "type": "string",
      "description": "A human-readable error message.",
      "example": "example_value"
    },
    "errors": {
      "type": "array",
      "description": "Detailed error information.",
      "items": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "A machine-readable error code."
          },
          "message": {
            "type": "string",
            "description": "A human-readable description of the error."
          }
        }
      },
      "example": []
    }
  }
}