Akamai · Schema

validation

Contains feedback on validation.

CDNCloudEdge ComputingNetworksPlatformSecurity

Properties

Name Type Description
detail string The explanation of the error message.
fieldName string The name of the field causing the validation problem.
jsonReference string The JSON reference to the field in the resource.
title string The title for the error.
type string The URL for the error type.
View JSON Schema on GitHub

JSON Schema

akamai-validation-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/validation",
  "title": "validation",
  "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"
  }
}