Experimental
Schema
ValidationFieldPathElement
Type:
object
One field in a validation path. For a map or list, the subscript identifies the selected element.
All constraints apply
fieldName
Type:
string | null
field_name contains the field name this path element refers to.
This can be used to display a human-readable path even if the field number is unknown.All schema constraints and annotations
{
"description": "`field_name` contains the field name this path element refers to.\nThis can be used to display a human-readable path even if the field number is unknown.",
"type": [
"string",
"null"
]
}fieldNumber
Type:
integer | null
field_number is the field number this path element refers to.All schema constraints and annotations
{
"description": "`field_number` is the field number this path element refers to.",
"format": "int32",
"type": [
"integer",
"null"
]
}fieldType
The type of the field that failed validation.
Exactly one alternative must match
Schema:
ValidationFieldType
All schema constraints and annotations
{
"$ref": "#/components/schemas/ValidationFieldType"
}Type:
null
All schema constraints and annotations
{
"type": "null"
}All schema constraints and annotations
{
"description": "The type of the field that failed validation.",
"oneOf": [
{
"$ref": "#/components/schemas/ValidationFieldType"
},
{
"type": "null"
}
]
}keyType
key_type specifies the map key type of this field. This value is useful when traversing
unknown fields through wire data: specifically, it allows handling the differences between
different integer encodings.Exactly one alternative must match
Schema:
ValidationFieldType
All schema constraints and annotations
{
"$ref": "#/components/schemas/ValidationFieldType"
}Type:
null
All schema constraints and annotations
{
"type": "null"
}All schema constraints and annotations
{
"description": "`key_type` specifies the map key type of this field. This value is useful when traversing\nunknown fields through wire data: specifically, it allows handling the differences between\ndifferent integer encodings.",
"oneOf": [
{
"$ref": "#/components/schemas/ValidationFieldType"
},
{
"type": "null"
}
]
}valueType
value_type specifies map value type of this field. This is useful if you want to display a
value inside unknown fields through wire data.Exactly one alternative must match
Schema:
ValidationFieldType
All schema constraints and annotations
{
"$ref": "#/components/schemas/ValidationFieldType"
}Type:
null
All schema constraints and annotations
{
"type": "null"
}All schema constraints and annotations
{
"description": "`value_type` specifies map value type of this field. This is useful if you want to display a\nvalue inside unknown fields through wire data.",
"oneOf": [
{
"$ref": "#/components/schemas/ValidationFieldType"
},
{
"type": "null"
}
]
}All schema constraints and annotations
{
"properties": {
"fieldName": {
"description": "`field_name` contains the field name this path element refers to.\nThis can be used to display a human-readable path even if the field number is unknown.",
"type": [
"string",
"null"
]
},
"fieldNumber": {
"description": "`field_number` is the field number this path element refers to.",
"format": "int32",
"type": [
"integer",
"null"
]
},
"fieldType": {
"description": "The type of the field that failed validation.",
"oneOf": [
{
"$ref": "#/components/schemas/ValidationFieldType"
},
{
"type": "null"
}
]
},
"keyType": {
"description": "`key_type` specifies the map key type of this field. This value is useful when traversing\nunknown fields through wire data: specifically, it allows handling the differences between\ndifferent integer encodings.",
"oneOf": [
{
"$ref": "#/components/schemas/ValidationFieldType"
},
{
"type": "null"
}
]
},
"valueType": {
"description": "`value_type` specifies map value type of this field. This is useful if you want to display a\nvalue inside unknown fields through wire data.",
"oneOf": [
{
"$ref": "#/components/schemas/ValidationFieldType"
},
{
"type": "null"
}
]
}
}
}Exactly one alternative must match
Type:
object
boolKey
· required
Type:
boolean
bool_key specifies a map key of type bool.All schema constraints and annotations
{
"description": "`bool_key` specifies a map key of type bool.",
"type": "boolean"
}All schema constraints and annotations
{
"properties": {
"boolKey": {
"description": "`bool_key` specifies a map key of type bool.",
"type": "boolean"
}
},
"required": [
"boolKey"
],
"title": "bool_key",
"type": "object"
}Type:
object
index
· required
Type:
integer | string
index specifies a 0-based index into a repeated field.All schema constraints and annotations
{
"description": "`index` specifies a 0-based index into a repeated field.",
"format": "int64",
"type": [
"integer",
"string"
]
}All schema constraints and annotations
{
"properties": {
"index": {
"description": "`index` specifies a 0-based index into a repeated field.",
"format": "int64",
"type": [
"integer",
"string"
]
}
},
"required": [
"index"
],
"title": "index",
"type": "object"
}Type:
object
intKey
· required
Type:
integer | string
int_key specifies a map key of type int32, int64, sint32, sint64, sfixed32 or sfixed64.All schema constraints and annotations
{
"description": "`int_key` specifies a map key of type int32, int64, sint32, sint64, sfixed32 or sfixed64.",
"format": "int64",
"type": [
"integer",
"string"
]
}All schema constraints and annotations
{
"properties": {
"intKey": {
"description": "`int_key` specifies a map key of type int32, int64, sint32, sint64, sfixed32 or sfixed64.",
"format": "int64",
"type": [
"integer",
"string"
]
}
},
"required": [
"intKey"
],
"title": "int_key",
"type": "object"
}Type:
object
stringKey
· required
Type:
string
string_key specifies a map key of type string.All schema constraints and annotations
{
"description": "`string_key` specifies a map key of type string.",
"type": "string"
}All schema constraints and annotations
{
"properties": {
"stringKey": {
"description": "`string_key` specifies a map key of type string.",
"type": "string"
}
},
"required": [
"stringKey"
],
"title": "string_key",
"type": "object"
}Type:
object
uintKey
· required
Type:
integer | string
uint_key specifies a map key of type uint32, uint64, fixed32 or fixed64.All schema constraints and annotations
{
"description": "`uint_key` specifies a map key of type uint32, uint64, fixed32 or fixed64.",
"format": "int64",
"type": [
"integer",
"string"
]
}All schema constraints and annotations
{
"properties": {
"uintKey": {
"description": "`uint_key` specifies a map key of type uint32, uint64, fixed32 or fixed64.",
"format": "int64",
"type": [
"integer",
"string"
]
}
},
"required": [
"uintKey"
],
"title": "uint_key",
"type": "object"
}All schema constraints and annotations
{
"oneOf": [
{
"properties": {
"boolKey": {
"description": "`bool_key` specifies a map key of type bool.",
"type": "boolean"
}
},
"required": [
"boolKey"
],
"title": "bool_key",
"type": "object"
},
{
"properties": {
"index": {
"description": "`index` specifies a 0-based index into a repeated field.",
"format": "int64",
"type": [
"integer",
"string"
]
}
},
"required": [
"index"
],
"title": "index",
"type": "object"
},
{
"properties": {
"intKey": {
"description": "`int_key` specifies a map key of type int32, int64, sint32, sint64, sfixed32 or sfixed64.",
"format": "int64",
"type": [
"integer",
"string"
]
}
},
"required": [
"intKey"
],
"title": "int_key",
"type": "object"
},
{
"properties": {
"stringKey": {
"description": "`string_key` specifies a map key of type string.",
"type": "string"
}
},
"required": [
"stringKey"
],
"title": "string_key",
"type": "object"
},
{
"properties": {
"uintKey": {
"description": "`uint_key` specifies a map key of type uint32, uint64, fixed32 or fixed64.",
"format": "int64",
"type": [
"integer",
"string"
]
}
},
"required": [
"uintKey"
],
"title": "uint_key",
"type": "object"
}
]
}All schema constraints and annotations
{
"allOf": [
{
"properties": {
"fieldName": {
"description": "`field_name` contains the field name this path element refers to.\nThis can be used to display a human-readable path even if the field number is unknown.",
"type": [
"string",
"null"
]
},
"fieldNumber": {
"description": "`field_number` is the field number this path element refers to.",
"format": "int32",
"type": [
"integer",
"null"
]
},
"fieldType": {
"description": "The type of the field that failed validation.",
"oneOf": [
{
"$ref": "#/components/schemas/ValidationFieldType"
},
{
"type": "null"
}
]
},
"keyType": {
"description": "`key_type` specifies the map key type of this field. This value is useful when traversing\nunknown fields through wire data: specifically, it allows handling the differences between\ndifferent integer encodings.",
"oneOf": [
{
"$ref": "#/components/schemas/ValidationFieldType"
},
{
"type": "null"
}
]
},
"valueType": {
"description": "`value_type` specifies map value type of this field. This is useful if you want to display a\nvalue inside unknown fields through wire data.",
"oneOf": [
{
"$ref": "#/components/schemas/ValidationFieldType"
},
{
"type": "null"
}
]
}
}
},
{
"oneOf": [
{
"properties": {
"boolKey": {
"description": "`bool_key` specifies a map key of type bool.",
"type": "boolean"
}
},
"required": [
"boolKey"
],
"title": "bool_key",
"type": "object"
},
{
"properties": {
"index": {
"description": "`index` specifies a 0-based index into a repeated field.",
"format": "int64",
"type": [
"integer",
"string"
]
}
},
"required": [
"index"
],
"title": "index",
"type": "object"
},
{
"properties": {
"intKey": {
"description": "`int_key` specifies a map key of type int32, int64, sint32, sint64, sfixed32 or sfixed64.",
"format": "int64",
"type": [
"integer",
"string"
]
}
},
"required": [
"intKey"
],
"title": "int_key",
"type": "object"
},
{
"properties": {
"stringKey": {
"description": "`string_key` specifies a map key of type string.",
"type": "string"
}
},
"required": [
"stringKey"
],
"title": "string_key",
"type": "object"
},
{
"properties": {
"uintKey": {
"description": "`uint_key` specifies a map key of type uint32, uint64, fixed32 or fixed64.",
"format": "int64",
"type": [
"integer",
"string"
]
}
},
"required": [
"uintKey"
],
"title": "uint_key",
"type": "object"
}
]
}
],
"description": "One field in a validation path. For a map or list, the subscript identifies the selected element.",
"title": "FieldPathElement",
"type": "object"
}