Get methods: Method signature

This rule enforces that all Get standard methods have a google.api.method_signature annotation with a value of "name", as mandated in AIP-131.

Details

This rule looks at any method beginning with Get, and complains if the google.api.method_signature annotation is missing, or if it is set to any value other than "name". Additional method signatures, if present, are ignored.

Examples

Incorrect code for this rule:

// Incorrect.
rpc GetBook(GetBookRequest) returns (Book) {
  // A google.api.method_signature annotation should be present.
}

// Incorrect.
rpc GetBook(GetBookRequest) returns (Book) {
  option (google.api.method_signature) = "book";  // Should be "name".
}

Correct code for this rule:

// Correct.
rpc GetBook(GetBookRequest) returns (Book) {
  option (google.api.method_signature) = "name";
}

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::0131::method-signature=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
rpc GetBook(GetBookRequest) returns (Book);

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