Custom methods: HTTP name variable

This rule enforces that custom methods only use the name variable if the RPC noun matches the resource, as mandated in AIP-136.

Details

This rule looks at custom methods and, if the URI contains a name variable, it ensures that the RPC name ends with the same text as the final component in the URI (after adjusting for case).

Examples

Incorrect code for this rule:

// Incorrect.
// The variable should be "book", or the RPC name should change.
rpc WritePage(WritePageRequest) return (WritePageResponse) {
  option (google.api.http) = {
    post: "/v1/{name=publishers/*/books/*}:writePage"
    body: "*"
  };
}

Correct code for this rule:

// Correct.
// If Page is not a first-class resource, use `book` as the variable name
// and a verb-noun suffix.
rpc WritePage(WritePageRequest) return (WritePageResponse) {
  option (google.api.http) = {
    post: "/v1/{book=publishers/*/books/*}:writePage"
    body: "*"
  };
}
// Correct.
// If Page is a first-class, already-created resource, use `name` as the
// variable name and a verb-only suffix.
rpc WritePage(WritePageRequest) return (WritePageResponse) {
  option (google.api.http) = {
    post: "/v1/{name=publishers/*/books/*/pages/*}:write"
    body: "*"
  };
}

See also the http-parent-variable rule (for first-class resources that are created by the custom RPC).

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::0136::http-name-variable=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
rpc WritePage(WritePageRequest) return (WritePageResponse) {
  option (google.api.http) = {
    post: "/v1/{name=publishers/*/books/*}:writePage"
    body: "*"
  };
}

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