Name field suffix

This rule enforces that fields do not use the suffix _name, as mandated in AIP-122.

Details

This rule scans all fields complains if it sees the suffix _name on a field.

Note: The standard field display_name is exempt, as are given_name and family_name (used to represent the human-readable name of a person).

Examples

Incorrect code for this rule:

// Incorrect.
message Book {
  string name = 1;
  string author_name = 2;  // Should be `author`.
}

Correct code for this rule:

// Correct.
message Book {
  string name = 1;
  string author = 2;
}

Disabling

If you need to violate this rule, use a leading comment above the method.

// (-- api-linter: core::0122::name-suffix=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
message Book {
  string name = 1;
  string author_name = 2;  // Should be `author`.
}

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