Custom methods: HTTP method

This rule enforces that all custom methods use the POST or GET HTTP verbs, as mandated in AIP-136.

Details

This rule looks at any method that is not a standard method, and complains if the HTTP verb is anything other than POST or GET. It does check additional bindings if they are present.

Examples

Incorrect code for this rule:

// Incorrect.
rpc CheckoutBook(CheckoutBookRequest) returns (CheckoutBookResponse) {
  option (google.api.http) = {
    put: "/v1/{name=publishers/*/books/*}:checkout"  // Should be `post:`.
    body: "*"
  };
}

Correct code for this rule:

// Correct.
rpc CheckoutBook(CheckoutBookRequest) returns (CheckoutBookResponse) {
  option (google.api.http) = {
    post: "/v1/{name=publishers/*/books/*}:checkout"
    body: "*"
  };
}

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-method=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
rpc CheckoutBook(CheckoutBookRequest) returns (CheckoutBookResponse) {
  option (google.api.http) = {
    put: "/v1/{name=publishers/*/books/*}:checkout"
    body: "*"
  };
}

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