Batch Update methods: Plural method name

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

Details

This rule looks at any method whose name begins with BatchUpdate, 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 `BatchUpdateBooks`
rpc BatchUpdateBook(BatchUpdateBookRequest) returns (BatchUpdateBookResponse) {
  option (google.api.http) = {
    post: "/v1/{parent=publishers/*}/books:batchUpdate"
    body: "*"
  };
}

Correct code for this rule:

// Correct.
rpc BatchUpdateBooks(BatchUpdateBooksRequest) returns (BatchUpdateBooksResponse) {
  option (google.api.http) = {
    post: "/v1/{parent=publishers/*}/books:batchUpdate"
    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::0234::plural-method-name=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
rpc BatchUpdateBook(BatchUpdateBookRequest) returns (BatchUpdateBookResponse) {
  option (google.api.http) = {
    post: "/v1/{parent=publishers/*}/books:batchUpdate"
    body: "*"
  };
}

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