request-unknown-fields
Rule Group	core
AIP	233

Batch Create methods: Unknown request fields

This rule enforces that all BatchCreate standard methods do not have unexpected fields, as mandated in AIP-233.

Details

This rule looks at any message matching BatchCreate*Request and complains if it comes across any fields other than:

string parent (AIP-233)
string request_id (AIP-155)
repeated Create*Request requests (AIP-233)
bool validate_only (AIP-163)

Examples

Incorrect code for this rule:

// Incorrect.
message BatchCreateBooksRequest {
  string parent = 1 [
    (google.api.resource_reference).child_type = "library.googleapis.com/Book"
  ];

  repeated CreateBookRequest requests = 2 [
    (google.api.field_behavior) = REQUIRED
  ];

  string library_id = 3;  // Non-standard field.
}

Correct code for this rule:

// Correct.
message BatchCreateBooksRequest {
  string parent = 1 [
    (google.api.resource_reference).child_type = "library.googleapis.com/Book"
  ];

  repeated CreateBookRequest 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 {
  string parent = 1 [
    (google.api.resource_reference).child_type = "library.googleapis.com/Book"
  ];

  repeated CreateBookRequest requests = 2 [
    (google.api.field_behavior) = REQUIRED
  ];

  // (-- api-linter: core::0233::request-unknown-fields=disabled
  //     aip.dev/not-precedent: We really need this field because reasons. --)
  string library_id = 3;
}

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