Batch Get methods: Plural method name

This rule enforces that all BatchGet RPCs have a plural resource in the method name, as mandated in AIP-231.

Details

This rule looks at any method whose name begins with BatchGet, and complains if the name of the resource in the method name is singular.

Examples

Incorrect code for this rule:

// Incorrect.
// Method name should be `BatchGetBooks`
rpc BatchGetBook(BatchGetBookRequest) returns (BatchGetBookRespose) {
  option (google.api.http) = {
    get: "/v1/{parent=publishers/*}/books:batchGet"
  };
}

Correct code for this rule:

// Correct.
rpc BatchGetBooks(BatchGetBooksRequest) returns (BatchGetBooksRespose) {
  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::plural-method-name=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
rpc BatchGetBook(BatchGetBookRequest) returns (BatchGetBookRespose) {
  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.