Get methods: Resource reference
This rule enforces that all Get
standard methods have
google.api.resource_reference
on their string name
field, as mandated in
AIP-131.
Details
This rule looks at the name
field of any message matching Get*Request
and
complains if it does not have a google.api.resource_reference
annotation.
Examples
Incorrect code for this rule:
// Incorrect.
message GetBookRequest {
// The `google.api.resource_reference` annotation should also be included.
string name = 1 [(google.api.field_behavior) = REQUIRED];
}
Correct code for this rule:
// Correct.
message GetBookRequest {
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference).type = "library.googleapis.com/Book"
];
}
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 GetBookRequest {
// (-- api-linter: core::0131::request-name-reference=disabled
// aip.dev/not-precedent: We need to do this because reasons. --)
string name = 1 [(google.api.field_behavior) = REQUIRED];
}
If you need to violate this rule for an entire file, place the comment at the top of the file.