Repeated fields: Unordered

This rule enforces that only repeated fields, not singular ones, are annotated with (google.api.field_behavior) = UNORDERED_LIST, as mandated by AIP-203.

Details

This rule looks at any field with a (google.api.field_behavior) = UNORDERED_LIST annotation and complains if it is not a repeated field.

Examples

Incorrect code for this rule:

message Book {
  // UNORDERED_LIST only applies to repeated fields.
  string name = 1 [(google.api.field_behavior) = UNORDERED_LIST];

  repeated string genres = 2 [(google.api.field_behavior) = UNORDERED_LIST];
}

Correct code for this rule:

// Correct.
message Book {
  string name = 1;

  repeated string genres = 2 [(google.api.field_behavior) = UNORDERED_LIST];
}

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 Book {
  // (-- api-linter: core::0203::unordered-list-repeated=disabled
  //     aip.dev/not-precedent: We need to do this because reasons. --)
  string name = 1 [(google.api.field_behavior) = UNORDERED_LIST];

  repeated string genres = 2 [(google.api.field_behavior) = UNORDERED_LIST];
}

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