BatchCreate methods: Parent field resource reference

This rule enforces that all BatchCreate standard methods with a string parent field use a proper google.api.resource_reference, that being either a child_type referring to the created resource or a type referring directly to the parent resource, as mandated in AIP-233.

Details

This rule looks at any message matching BatchCreate*Request and complains if the google.api.resource_reference on the parent field refers to the wrong resource.

Examples

Incorrect code for this rule:

// Incorrect.
message BatchCreateBooksRequest {
  // `child_type` should be used instead of `type` when referring to the
  // created resource on a parent field.
  string parent = 1 [(google.api.resource_reference).type = "library.googleapis.com/Book"];
  repeated CreateBooksRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
}

Correct code for this rule:

// Correct.
message BatchCreateBooksRequest {
  string parent = 1 [(google.api.resource_reference).child_type = "library.googleapis.com/Book"];
  repeated CreateBooksRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
}

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 BatchCreateBooksRequest {
  // (-- api-linter: core::0233::resource-reference-type=disabled
  //     aip.dev/not-precedent: We need to do this because reasons. --)
  string parent = 1 [(google.api.resource_reference).type = "library.googleapis.com/Book"];
  repeated CreateBooksRequest requests = 2 [(google.api.field_behavior) = REQUIRED];
}

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