Tag Revision methods: Response message
This rule enforces that all Tag Revision RPCs have a response message of the resource, as mandated in AIP-162.
Details
This rule looks at any method matching Tag*Revision
, and complains
if the name of the corresponding output message does not match the name of the
RPC with the prefix Tag
and suffix Revision
removed.
Examples
Incorrect code for this rule:
// Incorrect.
// Should return `Book`.
rpc TagBookRevision(TagBookRevisionRequest) returns (TagBookRevisionResponse) {
option (google.api.http) = {
post: "/v1/{name=publishers/*/books/*}:tagRevision"
body: "*"
};
}
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-response-message-name=disabled
// aip.dev/not-precedent: We need to do this because reasons. --)
rpc TagBookRevision(TagBookRevisionRequest) returns (TagBookRevisionResponse) {
option (google.api.http) = {
post: "/v1/{name=publishers/*/books/*}:tagRevision"
body: "*"
};
}
If you need to violate this rule for an entire file, place the comment at the top of the file.