Delete methods: DELETE HTTP verb
This rule enforces that all Delete
RPCs use the DELETE
HTTP verb, as
mandated in AIP-135.
Details
This rule looks at any message matching beginning with Delete
, and complains
if the HTTP verb is anything other than DELETE
. It does check additional
bindings if they are present.
Examples
Incorrect code for this rule:
// Incorrect.
rpc DeleteBook(DeleteBookRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=publishers/*/books/*}" // Should be `delete:`.
};
}
Correct code for this rule:
// Correct.
rpc DeleteBook(DeleteBookRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=publishers/*/books/*}"
};
}
Disabling
If you need to violate this rule, use a leading comment above the method. Remember to also include an aip.dev/not-precedent comment explaining why.
// (-- api-linter: core::0135::http-method=disabled
// aip.dev/not-precedent: We need to do this because reasons. --)
rpc DeleteBook(DeleteBookRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
post: "/v1/{name=publishers/*/books/*}"
};
}
If you need to violate this rule for an entire file, place the comment at the top of the file.