Document that the @ConfigurationProperties annotation processor cannot generate description and defaultValue metadata for external types #43925
Labels
type: documentation
A documentation update
Milestone
When using
@ConfigurationProperties
,@NestedConfigurationProperty
andspring-boot-configuration-processor
together with classes from another JAR, the generated JSON file will not havedefaultvalue
anddescription
properties set even if default values and javadoc are present in the target class.Consider the example: https://github.com/ZIRAKrezovic/configuration-processor-issue
The class referencing property class from Spring Boot Autoconfigure will not contain any description or defaultValue: https://github.com/ZIRAKrezovic/configuration-processor-issue/blob/main/src/main/java/com/example/demo/DemoConfigurationProperties.java
The same class copied into the code will contain description and defaultValue: https://github.com/ZIRAKrezovic/configuration-processor-issue/blob/main/src/main/java/com/example/demo/ArtemisProperties.java
Snippet of the generated metadata JSON for both prefixes
This is an undocumented behavior and should be at least documented if it can't be outright fixed.
The text was updated successfully, but these errors were encountered: