Akamai · Schema

problem

Encapsulates debugging information for error responses.

CDNCloudEdge ComputingNetworksPlatformSecurity

Properties

Name Type Description
detail string Detail error message.
errors array Further nested problem objects describing individual errors.
instance string The non-referenceable URI for the error instance.
status integer HTTP status code.
title string Title for the error.
type string URL for the error type.
View JSON Schema on GitHub

JSON Schema

siem-problem-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/akamai/main/json-schema/siem-problem-schema.json",
  "title": "problem",
  "additionalProperties": true,
  "description": "Encapsulates debugging information for error responses.",
  "properties": {
    "detail": {
      "description": "Detail error message.",
      "type": "string"
    },
    "errors": {
      "description": "Further nested problem objects describing individual errors.",
      "items": {
        "description": "A further-nested problem object.",
        "type": "object",
        "x-akamai": {
          "file-path": "schemas/problem-nested.yaml"
        }
      },
      "type": "array"
    },
    "instance": {
      "description": "The non-referenceable URI for the error instance.",
      "example": "https://problems.luna.akamaiapis.net/siem/error-instances/d54686b5-21cb-4ab7-a8d6-a92282cf1749",
      "type": "string"
    },
    "status": {
      "description": "HTTP status code.",
      "example": 404,
      "type": "integer"
    },
    "title": {
      "description": "Title for the error.",
      "example": "Not Found",
      "type": "string"
    },
    "type": {
      "description": "URL for the error type.",
      "example": "https://problems.luna.akamaiapis.net/siem/error-types/NOT-FOUND",
      "type": "string"
    }
  },
  "required": [
    "type",
    "title"
  ],
  "type": "object",
  "x-akamai": {
    "file-path": "schemas/problem.yaml"
  }
}