Share feedback
Answers are generated based on the documentation.

Experimental

Product manualDownload OpenAPI specificationMarkdown

Schema

ValidationViolation

Type: object

A validation failure, with the affected field, rule, and a human-readable message.
field
The field that failed validation, including its parent fields.
Exactly one alternative must match

Schema: ValidationFieldPath

Type: null

All schema constraints and annotations
{
  "type": "null"
}
All schema constraints and annotations
{
  "description": "The field that failed validation, including its parent fields.",
  "oneOf": [
    {
      "$ref": "#/components/schemas/ValidationFieldPath"
    },
    {
      "type": "null"
    }
  ]
}
forKey

Type: boolean | null

for_key indicates whether the violation was caused by a map key, rather than a value.
All schema constraints and annotations
{
  "description": "`for_key` indicates whether the violation was caused by a map key, rather than a value.",
  "type": [
    "boolean",
    "null"
  ]
}
message

Type: string | null

message is a human-readable error message that describes the nature of the violation. This can be the default error message from the violated Rule, or it can be a custom message that gives more context about the violation.
All schema constraints and annotations
{
  "description": "`message` is a human-readable error message that describes the nature of the violation.\nThis can be the default error message from the violated `Rule`, or it can be a custom message that gives more context about the violation.",
  "type": [
    "string",
    "null"
  ]
}
rule
The validation rule that failed.
Exactly one alternative must match

Schema: ValidationFieldPath

Type: null

All schema constraints and annotations
{
  "type": "null"
}
All schema constraints and annotations
{
  "description": "The validation rule that failed.",
  "oneOf": [
    {
      "$ref": "#/components/schemas/ValidationFieldPath"
    },
    {
      "type": "null"
    }
  ]
}
ruleId

Type: string | null

rule_id is the unique identifier of the Rule that was not fulfilled. This is the same id that was specified in the Rule message, allowing easy tracing of which rule was violated.
All schema constraints and annotations
{
  "description": "`rule_id` is the unique identifier of the `Rule` that was not fulfilled.\nThis is the same `id` that was specified in the `Rule` message, allowing easy tracing of which rule was violated.",
  "type": [
    "string",
    "null"
  ]
}
All schema constraints and annotations
{
  "description": "A validation failure, with the affected field, rule, and a human-readable message.",
  "properties": {
    "field": {
      "description": "The field that failed validation, including its parent fields.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/ValidationFieldPath"
        },
        {
          "type": "null"
        }
      ]
    },
    "forKey": {
      "description": "`for_key` indicates whether the violation was caused by a map key, rather than a value.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "message": {
      "description": "`message` is a human-readable error message that describes the nature of the violation.\nThis can be the default error message from the violated `Rule`, or it can be a custom message that gives more context about the violation.",
      "type": [
        "string",
        "null"
      ]
    },
    "rule": {
      "description": "The validation rule that failed.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/ValidationFieldPath"
        },
        {
          "type": "null"
        }
      ]
    },
    "ruleId": {
      "description": "`rule_id` is the unique identifier of the `Rule` that was not fulfilled.\nThis is the same `id` that was specified in the `Rule` message, allowing easy tracing of which rule was violated.",
      "type": [
        "string",
        "null"
      ]
    }
  },
  "title": "Violation",
  "type": "object"
}