Akamai · Schema

validations

Contains warnings, errors, or notices determined by validating the match target.

CDNCloudEdge ComputingNetworksPlatformSecurity

Properties

Name Type Description
errors array The list of errors.
notices array The list of notices.
warnings array The list of warnings.
View JSON Schema on GitHub

JSON Schema

akamai-validations-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/validations",
  "title": "validations",
  "additionalProperties": false,
  "description": "Contains warnings, errors, or notices determined by validating the match target.",
  "properties": {
    "errors": {
      "description": "The list of errors.",
      "items": {
        "additionalProperties": false,
        "description": "Contains feedback on validation.",
        "properties": {
          "detail": {
            "description": "The explanation of the error message.",
            "type": "string"
          },
          "fieldName": {
            "description": "The name of the field causing the validation problem.",
            "type": "string"
          },
          "jsonReference": {
            "description": "The JSON reference to the field in the resource.",
            "type": "string"
          },
          "title": {
            "description": "The title for the error.",
            "example": "Not Found",
            "type": "string"
          },
          "type": {
            "description": "The URL for the error type.",
            "example": "/appsec/problem-types/INCOMPATIBLE-FIELD",
            "type": "string"
          }
        },
        "required": [
          "title",
          "type"
        ],
        "type": "object",
        "x-akamai": {
          "file-path": "schemas/validation.yaml"
        }
      },
      "type": "array"
    },
    "notices": {
      "description": "The list of notices.",
      "items": {
        "additionalProperties": false,
        "description": "Contains feedback on validation.",
        "properties": {
          "detail": {
            "description": "The explanation of the error message.",
            "type": "string"
          },
          "fieldName": {
            "description": "The name of the field causing the validation problem.",
            "type": "string"
          },
          "jsonReference": {
            "description": "The JSON reference to the field in the resource.",
            "type": "string"
          },
          "title": {
            "description": "The title for the error.",
            "example": "Not Found",
            "type": "string"
          },
          "type": {
            "description": "The URL for the error type.",
            "example": "/appsec/problem-types/INCOMPATIBLE-FIELD",
            "type": "string"
          }
        },
        "required": [
          "title",
          "type"
        ],
        "type": "object",
        "x-akamai": {
          "file-path": "schemas/validation.yaml"
        }
      },
      "type": "array"
    },
    "warnings": {
      "description": "The list of warnings.",
      "items": {
        "additionalProperties": false,
        "description": "Contains feedback on validation.",
        "properties": {
          "detail": {
            "description": "The explanation of the error message.",
            "type": "string"
          },
          "fieldName": {
            "description": "The name of the field causing the validation problem.",
            "type": "string"
          },
          "jsonReference": {
            "description": "The JSON reference to the field in the resource.",
            "type": "string"
          },
          "title": {
            "description": "The title for the error.",
            "example": "Not Found",
            "type": "string"
          },
          "type": {
            "description": "The URL for the error type.",
            "example": "/appsec/problem-types/INCOMPATIBLE-FIELD",
            "type": "string"
          }
        },
        "required": [
          "title",
          "type"
        ],
        "type": "object",
        "x-akamai": {
          "file-path": "schemas/validation.yaml"
        }
      },
      "type": "array"
    }
  },
  "required": [
    "notices",
    "errors",
    "warnings"
  ],
  "type": "object",
  "x-akamai": {
    "file-path": "schemas/validations.yaml"
  }
}