HTTP URI case

This rule enforces that the HTTP URI pattern only uses camel case for word separation, as mandated in AIP-122.

Details

This rule scans all methods and ensures that the _ character is not present in the URI.

Examples

Incorrect code for this rule:

// Incorrect.
rpc GetElectronicBook(GetElectronicBookRequest) returns (ElectronicBook) {
  option (google.api.http) = {
    // Should be "electronicBooks", not "electronic_books".
    get: "/v1/{name=publishers/*/electronic_books/*}"
  };
}

Correct code for this rule:

// Correct.
rpc GetElectronicBook(GetElectronicBookRequest) returns (ElectronicBook) {
  option (google.api.http) = {
    get: "/v1/{name=publishers/*/electronicBooks/*}"
  };
}

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::0122::camel-case-uris=disabled
//     aip.dev/not-precedent: We need to do this because reasons. --)
rpc GetElectronicBook(GetElectronicBookRequest) returns (ElectronicBook) {
  option (google.api.http) = {
    // Should be "electronicBooks", not "electronic_books".
    get: "/v1/{name=publishers/*/electronic_books/*}"
  };
}

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