Update @ConfigurationProperties Javadoc to mention that the canonical format is required

[mumukiller]

Reproduced for me using 2.0.3.RELEASE

I found similar issue here - #9545
As mentioned it should be fixed in 2.0.3.M3 but looks like it's not

My case is similar but without explicit prefix parameter

@Getter
@Setter
@ConfigurationProperties("myCommonProperties")
public class MyCommonProperties {
  private String someProperty;
}

It fails with

Caused by: org.springframework.boot.context.properties.source.InvalidConfigurationPropertyNameException: Configuration property name 'myCommonProperties' is not valid

Haven't found any other opened issues with similar behaviour

[snicoll]

You've deleted your comment on #9545 but just above it there is this comment.

The prefix for @ConfigurationProperties must use the canonical format (i.e. @ConfigurationProperties("my-common-properties"). Let's reuse this issue to also update the Javadoc of @ConfigurationProperties.

I guess you got that exception in a test. If you start the app there is a FailureAnalyzer that explains you what the problem was (that's what #9545 actually added).

[mumukiller]

Yup! It would be great to have this mentioned in the documentation.