Batch Delete methods: Unknown request fields
This rule enforces that all BatchDelete
standard methods do not have unexpected
fields, as mandated in AIP-235.
Details
This rule looks at any message matching BatchDelete*Request
and complains if it comes
across any fields other than:
bool force
(AIP-135)repeated string names
(AIP-235)string parent
(AIP-235)string request_id
(AIP-155)repeated Delete*Request requests
(AIP-235)bool validate_only
(AIP-163)
Examples
Incorrect code for this rule:
// Incorrect.
message BatchDeleteBooksRequest {
string parent = 1 [
(google.api.resource_reference).child_type = "library.googleapis.com/Book"
];
repeated string names = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference).type = "library.googleapis.com/Book"
];
string library_id = 3; // Non-standard field.
}
Correct code for this rule:
// Correct.
message BatchDeleteBooksRequest {
string parent = 1 [
(google.api.resource_reference).child_type = "library.googleapis.com/Book"
];
repeated string names = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference).type = "library.googleapis.com/Book"
];
}
Disabling
If you need to violate this rule, use a leading comment above the field. Remember to also include an aip.dev/not-precedent comment explaining why.
message BatchDeleteBooksRequest {
string parent = 1 [
(google.api.resource_reference).child_type = "library.googleapis.com/Book"
];
repeated string names = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference).type = "library.googleapis.com/Book"
];
// (-- api-linter: core::0235::request-unknown-fields=disabled
// aip.dev/not-precedent: We really need this field because reasons. --)
string library_id = 3;
}
If you need to violate this rule for an entire file, place the comment at the top of the file.