Resource pattern use of singular

This rule enforces that messages that have a google.api.resource annotation use the singular form as the resource ID segment, as described in AIP-123.

Details

This rule scans messages with a google.api.resource annotation, and validates the singular form of the resource type name is used as the resource ID segment in every pattern.

Note: Special consideration is given to type names of child collections that stutter next to their parent collection, as described in AIP-122 Nested Collections. See AIP-122 for more details.

Important: Do not accept the suggestion if it would produce a backwards incompatible change.

Examples

Incorrect code for this rule:

// Incorrect.
message Book {
  option (google.api.resource) = {
    type: "library.googleapis.com/BookShelf"
    // resource ID segment doesn't match the singular.
    pattern: "publishers/{publisher}/bookShelves/{shelf}"
    singular: "bookShelf"
    plural: "bookShelves"
  };

  string name = 1;
}

Correct code for this rule:

// Correct.
message Book {
  option (google.api.resource) = {
    type: "library.googleapis.com/BookShelf"
    pattern: "publishers/{publisher}/bookShelves/{book_shelf}"
    singular: "bookShelf"
    plural: "bookShelves"
  };

  string name = 1;
}

Disabling

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

// (-- api-linter: core::0123::resource-pattern-singular=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
message Book {
  option (google.api.resource) = {
    type: "library.googleapis.com/BookShelf"
    pattern: "publishers/{publisher}/bookShelves/{shelf}"
    singular: "bookShelf"
    plural: "bookShelves"
  };

  string name = 1;
}

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