Skip to content
AEP

AEP-0159 Linter Rules

Hardcoded hyphen segments

Hardcoded hyphen segments

This rule enforces that URIs do not “hard-code” a segment of - in their URIs, as mandated in [AIP-159][].

Details

This rule looks at every method and complains if it sees a segment in the URI that is just the - character and nothing else.

Examples

Incorrect code for this rule:

// Incorrect.
rpc ListBooks(ListBooksRequest) returns (ListBooksResponse) {
  option (google.api.http) = {
    get: "/v1/{parent=publishers/-}/books"  // Should use `*`, not `-`.
  };
}

Correct code for this rule:

// Correct.
rpc ListBooks(ListBooksRequest) returns (ListBooksResponse) {
  option (google.api.http) = {
    get: "/v1/{parent=publishers/*}/books"
  };
}

Disabling

If you need to violate this rule, use a leading comment above the method. Remember to also include an aep.dev/not-precedent comment explaining why.

// (-- api-linter: core::0159::hardcoded-hyphen=disabled
//     aep.dev/not-precedent: We need to do this because reasons. --)
rpc ListBooks(ListBooksRequest) returns (ListBooksResponse) {
  option (google.api.http) = {
    get: "/v1/{parent=publishers/-}/books"
  };
}

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