{
  "name": "validation",
  "apidoc": {"version": "0.14.68"},
  "enums": {
    "fieldValidationErrorType": {
      "description": "Error types for field validation.",
      "values": [
        {
          "name": "isNull",
          "description": "Field is null or missing."

        },
        {
          "name": "isEmpty",
          "description": "Field is empty."
        },
        {
          "name": "minimumLength",
          "description": "Field length is less than the minimum allowed."
        },
        {
          "name": "maximumLength",
          "description": "Field exceeds the maximum allowable length."
        },
        {
          "name": "pattern",
          "description": "Field does not match a predefined pattern."
        },
        {
          "name": "syntax",
          "description": "Field syntax type error."
        }
      ]
    }
  },
  "models": {
    "fieldValidationError": {
      "description": "Error description object for a single field.",
      "fields": [
        {
          "name": "path",
          "type": "string",
          "minimum": 1,
          "maximum": 256,
          "required": true,
          "description": "The object path of the field.",
          "example": "/searches/search.query"
        },
        {
          "name": "message",
          "type": "string",
          "minimum": 1,
          "maximum": 512,
          "required": true,
          "description": "A user friendly error message.",
          "example": "Query parameter 'query' exceeds parameter maximum length of 512 characters."
        }
      ]
    },
    "fieldValidationErrorEntry": {
      "description": "A single validation error description.",
      "fields": [
        {
          "name": "message",
          "type": "string",
          "minimum": 1,
          "maximum": 512,
          "required": true,
          "description": "A user friendly error message.",
          "example": "Query parameter 'query' exceeds parameter maximum length of 512 characters."
        },
        {
          "name": "errors",
          "type": "fieldValidationErrorType",
          "required": true,
          "description": "A field validation type.",
          "example": "isNull"
        }
      ]
    },
    "fieldValidationResponse": {
      "description": "A response object for field validation errors.",
      "fields": [
        {
          "name": "status",
          "type": "integer",
          "required": true,
          "minimum": 100,
          "maximum": 599,
          "description": "The response status."
        },
        {
          "name": "message",
          "type": "string",
          "minimum": 1,
          "maximum": 512,
          "required": true,
          "description": "The response message."
        },
        {
          "name": "errors",
          "type": "[fieldValidationError]",
          "maximum": 32,
          "required": true,
          "description": "A set of field validation errors."
        }
      ]
    },
    "conflictResourceExistsResponse": {
      "description": "A response object for field 409 conflict errors resulting from trying to create a resource that already exists.",
      "fields": [
        {
          "name": "status",
          "type": "integer",
          "required": true,
          "minimum": 100,
          "maximum": 599,
          "description": "The response status."
        },
        {
          "name": "message",
          "type": "string",
          "minimum": 1,
          "maximum": 512,
          "required": true,
          "description": "The response message."
        }
      ]
    }
  },
  "resources": {}
}