BadRequest
Stay organized with collections
Save and categorize content based on your preferences.
Describes violations in a client request. This error type focuses on the syntactic aspects of the request.
JSON representation |
{
"fieldViolations": [
{
object (FieldViolation )
}
]
} |
Fields |
fieldViolations[] |
object (FieldViolation )
Describes all violations in a client request.
|
FieldViolation
A message type used to describe a single bad request field.
JSON representation |
{
"field": string,
"description": string
} |
Fields |
field |
string
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 the full_name value
email_addresses[1].email for a violation in the email field of the first email_addresses message
email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.
In JSON, the same values are represented as:
fullName for a violation in the fullName value
emailAddresses[1].email for a violation in the email field of the first emailAddresses message
emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.
|
description |
string
A description of why the request element is bad.
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2020-10-21 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]