Field names: Abbreviations

This rule enforces that field names use common abbreviations, as mandated in AIP-140.

Details

This rule checks every descriptor in the proto and complains if the long form of any of the following words are used instead of the abbreviation:

• configuration
• identifier
• information
• specification
• statistics

Examples

Single word method

Incorrect code for this rule:

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

Correct code for this rule:

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

Disabling

If you need to violate this rule, use a leading comment above the method. Remember to also include an aip.dev/not-precedent comment explaining why.

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

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