Tag Revision methods: HTTP body
This rule enforces that all Tag Revision RPCs use *
as the HTTP body
, as mandated in
AIP-162.
Details
This rule looks at any method matching Tag*Revision
, and complains
if the HTTP body
field is anything other than *
.
Examples
Incorrect code for this rule:
// Incorrect.
rpc TagBookRevision(TagBookRevisionRequest) returns (Book) {
option (google.api.http) = {
post: "/v1/{name=publishers/*/books/*}:tagRevision"
// body: "*" should be set.
};
}
Correct code for this rule:
// Correct.
rpc TagBookRevision(TagBookRevisionRequest) returns (Book) {
option (google.api.http) = {
post: "/v1/{name=publishers/*/books/*}:tagRevision"
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::tag-revision-http-body=disabled
// aip.dev/not-precedent: We need to do this because reasons. --)
rpc TagBookRevision(TagBookRevisionRequest) returns (Book) {
option (google.api.http) = {
post: "/v1/{name=publishers/*/books/*}:tagRevision"
};
}
If you need to violate this rule for an entire file, place the comment at the top of the file.