Update methods: Resource field

This rule enforces that all Update standard methods have a field in the request message for the resource itself, as mandated in AIP-134.

Details

This rule looks at any message matching Update*Request and complains if there is no field of the resource’s type with the expected field name.

Examples

Incorrect code for this rule:

// Incorrect.
// `Book book` is missing.
message UpdateBookRequest {
  google.protobuf.FieldMask update_mask = 2;
}

Correct code for this rule:

// Correct.
message UpdateBookRequest {
  Book book = 1;
  google.protobuf.FieldMask update_mask = 2;
}

Disabling

If you need to violate this rule, use a leading comment above the message. Remember to also include an aip.dev/not-precedent comment explaining why.

// (-- api-linter: core::0134::request-resource-required=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
message UpdateBookRequest {
  google.protobuf.FieldMask update_mask = 2;
}

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