spring.cloud.consul.config.prefixes documentation update

[shan916]

The documentation for spring-cloud-consul has no mention of the deprecation of spring.cloud.consul.config.prefix in favor of spring.cloud.consul.config.prefixes. I had to do dig up the code to see if the new (plural) property is a YAML list or if it is a comma separated String. The documentation at the below URL should be updated with an explanation.

https://docs.spring.io/spring-cloud-consul/docs/current/reference/html/#customizing

[mario45211]

up - I wasted few hours trying to figured out why my configuration has not been resolving because of this confusing doc... 👎

[spencergibb]

This typically wouldn't go in the documentation but in release notes. This was missed, our bad. Both properties were supported in 3.x and was removed in 4.0

[spencergibb]

My mistake, prefix support hasn't been removed and it should still work. @mario45211 prefix should still work.

[NaldoRay]

We also had some headache when migrating some of our services to the new property.
Turned out it's because prefixes doesn't work the same way as prefix when it's set to empty string ""

This works:

spring.cloud.consul.config.prefix=
spring.cloud.consul.config.name=config/my-service

This doesn't:

spring.cloud.consul.config.prefixes=
spring.cloud.consul.config.name=config/my-service

Because the latter will lead to empty context on ConsulPropertySources#generateAutomaticContexts.

[AzazelSensei]

Opened #1012 to document prefixes on the customizing page.