Update methods: HTTP body

This rule enforces that all Update RPCs set the HTTP body to the resource, as mandated in AIP-134.

Details

This rule looks at any method whose name begins with Update, and complains if the HTTP body field is not set to the resource being created.

Examples

Incorrect code for this rule:

// Incorrect.
rpc UpdateBook(UpdateBookRequest) returns (Book) {
  option (google.api.http) = {
    patch: "/v1/{book.name=publishers/*/books/*}"
    body: "*"  // This should be "book".
  };
}

Correct code for this rule:

// Correct.
rpc UpdateBook(UpdateBookRequest) returns (Book) {
  option (google.api.http) = {
    patch: "/v1/{book.name=publishers/*/books/*}"
    body: "book"
  };
}

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::0134::http-body=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
rpc UpdateBook(UpdateBookRequest) returns (Book) {
  option (google.api.http) = {
    patch: "/v1/{book.name=publishers/*/books/*}"
    body: "*"
  };
}

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