Schemas
ValidationError
Response and request schema
Schema
object
One field-level validation failure. Messages and rejected values are deliberately absent: documentation for the field and validation code supplies the human explanation.
| Field | Type | Description |
|---|---|---|
code | string · required | Stable bounded reason. Open set; documented values are Known values (open set): |
field | string · required | Public field or parameter name, or a JSON pointer for body fields. Never an internal property name. |
location | string · required | Where the failing input was supplied. Open set; documented values are Known values (open set): |
Complete OpenAPI definition
{
"description": "One field-level validation failure. Messages and rejected values are\ndeliberately absent: documentation for the field and validation code\nsupplies the human explanation.\n",
"properties": {
"code": {
"description": "Stable bounded reason. Open set; documented values are `required`, `unknown`, `invalid_format`, `out_of_range`, `unsupported_value` and `conflict`.",
"type": "string",
"x-known-values": [
"required",
"unknown",
"invalid_format",
"out_of_range",
"unsupported_value",
"conflict"
]
},
"field": {
"description": "Public field or parameter name, or a JSON pointer for body fields. Never an internal property name.",
"type": "string"
},
"location": {
"description": "Where the failing input was supplied. Open set; documented values are `path`, `query`, `header` and `body`.",
"type": "string",
"x-known-values": [
"path",
"query",
"header",
"body"
]
}
},
"required": [
"location",
"field",
"code"
],
"type": "object"
}