Atlassian · Schema

ErrorCollection

Error messages from an operation.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
errorMessages array The list of error messages produced by this operation. For example, "input parameter 'key' must be provided"
errors object The list of errors by parameter returned by the operation. For example,"projectKey": "Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters."
status integer
View JSON Schema on GitHub

JSON Schema

atlassian-errorcollection-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ErrorCollection",
  "title": "ErrorCollection",
  "additionalProperties": false,
  "description": "Error messages from an operation.",
  "properties": {
    "errorMessages": {
      "description": "The list of error messages produced by this operation. For example, \"input parameter 'key' must be provided\"",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "errors": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "The list of errors by parameter returned by the operation. For example,\"projectKey\": \"Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters.\"",
      "type": "object"
    },
    "status": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}