Atlassian · Schema

Error

Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
type string
error object
View JSON Schema on GitHub

JSON Schema

atlassian-error-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/error",
  "title": "Error",
  "type": "object",
  "description": "Base type for most resource objects. It defines the common `type` element that identifies an object's type. It also identifies the element as Swagger's `discriminator`.",
  "properties": {
    "type": {
      "type": "string",
      "example": "example_value"
    },
    "error": {
      "type": "object",
      "properties": {
        "message": {
          "type": "string"
        },
        "detail": {
          "type": "string"
        },
        "data": {
          "type": "object",
          "description": "Optional structured data that is endpoint-specific.",
          "properties": {},
          "additionalProperties": true
        }
      },
      "required": [
        "message"
      ],
      "additionalProperties": false,
      "example": "example_value"
    }
  },
  "required": [
    "type"
  ],
  "additionalProperties": true
}