Rollback methods: POST HTTP verb
This rule enforces that all Rollback RPCs use the POST HTTP verb, as
mandated in AIP-162.
Details
This rule looks at any method beginning with Rollback, and complains
if the HTTP verb is anything other than POST. It does check additional
bindings if they are present.
Examples
Incorrect code for this rule:
// Incorrect.
rpc RollbackBook(RollbackBookRequest) returns (Book) {
option (google.api.http) = {
get: "/v1/{name=publishers/*/books/*}:rollback" // Should be `post:`.
};
}
Correct code for this rule:
// Correct.
rpc RollbackBook(RollbackBookRequest) returns (Book) {
option (google.api.http) = {
post: "/v1/{name=publishers/*/books/*}:rollback"
body: "*"
};
}
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::0162::rollback-http-method=disabled
// aip.dev/not-precedent: We need to do this because reasons. --)
rpc RollbackBook(RollbackBookRequest) returns (Book) {
option (google.api.http) = {
get: "/v1/{name=publishers/*/books/*}:rollback"
};
}
If you need to violate this rule for an entire file, place the comment at the top of the file.
View on GitHub