Batch Get methods: Field behavior

This rule enforces that all BatchGet requests have google.api.field_behavior set to REQUIRED on their repeated string names field, as mandated in AIP-231.

Details

This rule looks at any message matching BatchGet*Request and complains if the names field does not have a google.api.field_behavior annotation with a value of REQUIRED.

Examples

Incorrect code for this rule:

// Incorrect.
message BatchGetBooksRequest {
  // The `google.api.field_behavior` annotation should also be included.
  repeated string names = 1 [(google.api.resource_reference) = {
    type: "library.googleapis.com/Book"
  }];
}

Correct code for this rule:

// Correct.
message BatchGetBooksRequest {
  repeated string names = 1 [
    (google.api.field_behavior) = REQUIRED,
    (google.api.resource_reference).type = "library.googleapis.com/Book"
  ];
}

Disabling

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

message BatchGetBooksRequest {
  // (-- api-linter: core::0231::request-names-behavior=disabled
  //     aip.dev/not-precedent: We need to do this because reasons. --)
  repeated string names = 1 [(google.api.resource_reference) = {
    type: "library.googleapis.com/Book"
  }];
}

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