Method Signature: Required fields

This rule enforces that all google.api.method_signature annotations contain all top-level request message fields that are annotated with REQUIRED, as mandated in AIP-4232.

Details

This rule looks at any RPC methods with a google.api.method_signature annotation, and complains if any request field annotated with REQUIRED is missing.

Examples

Incorrect code for this rule:

// Incorrect.
rpc BatchDeleteBooks(BatchDeleteBooksRequest) returns (google.protobuf.Empty) {
  option (google.api.http) = {
    post: "/v1/{parent=publishers/*}/books:batchDelete"
    body: "*"
  };
  // The field "names" is annotated with REQUIRED and is missing from the
  // method_signature.
  option (google.api.method_signature) = "parent";
}

Correct code for this rule:

// Correct.
rpc BatchDeleteBooks(BatchDeleteBooksRequest) returns (google.protobuf.Empty) {
  option (google.api.http) = {
    post: "/v1/{parent=publishers/*}/books:batchDelete"
    body: "*"
  };
  option (google.api.method_signature) = "parent,names";
}

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: client-libraries::4232::required-fields=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
rpc BatchDeleteBooks(BatchDeleteBooksRequest) returns (google.protobuf.Empty) {
  option (google.api.http) = {
    post: "/v1/{parent=publishers/*}/books:batchDelete"
    body: "*"
  };
  option (google.api.method_signature) = "parent";
}

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