Unkey · Schema

ValidationError

Individual validation error details. Each validation error provides precise information about what failed, where it failed, and how to fix it, enabling efficient error resolution.

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Properties

Name	Type	Description
location	string	JSON path indicating exactly where in the request the error occurred. This helps pinpoint the problematic field or parameter. Examples include: - 'body.name' (field in request body) - 'body.items[3].t
message	string	Detailed error message explaining what validation rule was violated. This provides specific information about why the field or parameter was rejected, such as format errors, invalid values, or constra
fix	string	A human-readable suggestion describing how to fix the error. This provides practical guidance on what changes would satisfy the validation requirements. Not all validation errors include fix suggestio

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ValidationError",
  "title": "ValidationError",
  "additionalProperties": false,
  "properties": {
    "location": {
      "description": "JSON path indicating exactly where in the request the error occurred. This helps pinpoint the problematic field or parameter. Examples include:\n- 'body.name' (field in request body)\n- 'body.items[3].tags' (nested array element)\n- 'path.apiId' (path parameter)\n- 'query.limit' (query parameter)\nUse this location to identify exactly which part of your request needs correction.",
      "type": "string",
      "example": "body.permissions[0].name"
    },
    "message": {
      "description": "Detailed error message explaining what validation rule was violated. This provides specific information about why the field or parameter was rejected, such as format errors, invalid values, or constraint violations.",
      "type": "string",
      "example": "Must be at least 3 characters long"
    },
    "fix": {
      "description": "A human-readable suggestion describing how to fix the error. This provides practical guidance on what changes would satisfy the validation requirements. Not all validation errors include fix suggestions, but when present, they offer specific remediation advice.",
      "type": "string",
      "example": "Ensure the name uses only alphanumeric characters, underscores, and hyphens"
    }
  },
  "required": [
    "location",
    "message"
  ],
  "type": "object",
  "description": "Individual validation error details. Each validation error provides precise information about what failed, where it failed, and how to fix it, enabling efficient error resolution."
}