A message type used to describe a single bad request field.
Value parameters
- description
-
A description of why the request element is bad.
- field
-
A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field. Consider the following: message CreateContactRequest { message EmailAddress { enum Type { TYPE_UNSPECIFIED = 0; HOME = 1; WORK = 2; } optional string email = 1; repeated EmailType type = 2; } string full_name = 1; repeated EmailAddress email_addresses = 2; } In this example, in proto
field
could take one of the following values: *full_name
for a violation in thefull_name
value *email_addresses[1].email
for a violation in theemail
field of the firstemail_addresses
message *email_addresses[3].type[2]
for a violation in the secondtype
value in the thirdemail_addresses
message. In JSON, the same values are represented as: *fullName
for a violation in thefullName
value *emailAddresses[1].email
for a violation in theemail
field of the firstemailAddresses
message *emailAddresses[3].type[2]
for a violation in the secondtype
value in the thirdemailAddresses
message.
Attributes
- Companion
- object
- Source
- BadRequest.scala
- Graph
-
- Supertypes
-
trait Updatable[FieldViolation]trait GeneratedMessagetrait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any