Get methods: Unknown fields

This rule enforces that all List standard methods use the correct type for any optional fields described in AIP-132.

Details

This rule looks at the fields in any message matching List*Request and complains if finds fields with the names below that do not have the correct type:

  • string filter
  • string order_by

Examples

Incorrect code for this rule:

// Incorrect.
message ListBooksRequest {
  string parent = 1;
  int32 page_size = 2;
  string page_token = 3;
  BookFilter filter = 4;  // Wrong type; should be a string.
}

Correct code for this rule:

// Correct.
message ListBooksRequest {
  string parent = 1;
  int32 page_size = 2;
  string page_token = 3;
  string filter = 4;
}

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 {
  string parent = 1;
  int32 page_size = 2;
  string page_token = 3;

  // (-- api-linter: core::0134::request-field-types=disabled
  //     aip.dev/not-precedent: We really need this field because reasons. --)
  BookFilter filter = 4;
}

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