Batch Get methods: Response message

This rule enforces that all BatchGet RPCs have a response message name of BatchGet*Response, as mandated in AIP-231.

Details

This rule looks at any method beginning with BatchGet, and complains if the name of the corresponding returned message does not match the name of the RPC with the suffix Response appended.

Examples

Incorrect code for this rule:

// Incorrect.
// Should be `BatchGetBooksResponse`.
rpc BatchGetBooks(BatchGetBooksRequest) returns (Books) {
  option (google.api.http) = {
    get: "/v1/{parent=publishers/*}/books:batchGet"
  };
}

Correct code for this rule:

// Correct.
rpc BatchGetBooks(BatchGetBooksRequest) returns (BatchGetBooksResponse) {
  option (google.api.http) = {
    get: "/v1/{parent=publishers/*}/books:batchGet"
  };
}

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::0231::response-message-name=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
rpc BatchGetBooks(BatchGetBooksRequest) returns (Books) {
  option (google.api.http) = {
    get: "/v1/{parent=publishers/*}/books:batchGet"
  };
}

If you need to violate this rule for an entire file, place the comment at the top of the file.