List methods: Required fields

This rule enforces that all List standard methods do not have unexpected required fields, as mandated in AIP-132.

Details

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

Examples

Incorrect code for this rule:

// Incorrect.
message ListBooksRequest {
	// The parent, which owns this collection of books.
	// Format: publishers/{publisher}
	string parent = 1 [
	    (google.api.field_behavior) = REQUIRED,
	    (google.api.resource_reference) = {
	  		child_type: "library.googleapis.com/Book"
	    }];

  // Non-standard required field.
  int32 page_size = 2 [(google.api.field_behavior) = REQUIRED]
}

Correct code for this rule:

// Correct.
message ListBooksRequest {
	// The parent, which owns this collection of books.
	// Format: publishers/{publisher}
	string parent = 1 [
	    (google.api.field_behavior) = REQUIRED,
	    (google.api.resource_reference) = {
	  		child_type: "library.googleapis.com/Book"
	    }];

  int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL]
}

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 ListBooksRequest {
	// The parent, which owns this collection of books.
	// Format: publishers/{publisher}
	string parent = 1 [
	    (google.api.field_behavior) = REQUIRED,
	    (google.api.resource_reference) = {
	  		child_type: "library.googleapis.com/Book"
	    }];

  // (-- api-linter: core::0132::request-required-fields=disabled
  //     aip.dev/not-precedent: We really need this field to be required because
  // reasons. --)
  int32 page_size = 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.