Delete methods: Name field
This rule enforces that all Delete
standard methods have a string name
field in the request message, as mandated in AIP-135.
Details
This rule looks at any message matching Delete*Request
and complains if
the name
field is missing.
Examples
Incorrect code for this rule:
// Incorrect.
message DeleteBookRequest {
// Field name should be `name`.
string book = 1;
}
Correct code for this rule:
// Correct.
message DeleteBookRequest {
string name = 1;
}
Disabling
If you need to violate this rule, use a leading comment above the message. Remember to also include an aip.dev/not-precedent comment explaining why.
// (-- api-linter: core::0135::request-name-required=disabled
// aip.dev/not-precedent: We need to do this because reasons. --)
message DeleteBookRequest {
string book = 1;
}
If you need to violate this rule for an entire file, place the comment at the top of the file.