search

zalando / zally

A minimalistic, simple-to-use API linter
https://zalando.github.io/zally
MIT License
908 stars 145 forks source link

FunctionalNamingForHostnames only works with zalando domains #1474

Open JoacimV opened 1 year ago

JoacimV commented 1 year ago

As far as i can tell, it seems like the FunctionalNamingForHostnamesRule only work on zalando domains, i guess this must be a mistake?

https://github.com/zalando/zally/blob/main/server/zally-ruleset-zalando/src/test/kotlin/org/zalando/zally/ruleset/zalando/FunctionalNamingForHostnamesRuleTest.kt

tkrop commented 8 months ago

Sorry for missing to answer timely. Yes, this is a mistake. We should have implemented the rule more general to allow customizing the domain used for the functional host name. You are welcome to make the rule configurable and contribute this back to Zally. Until we have done this, you can disable the rule by either using:

  1. Using x-zally-ignore: 224,
  2. Remove the rule from your jar-file, or
  3. Disable the rule by configuration in the application.yml by adding #zally/ingoreRules (see application.yml#L41).