-
Notifications
You must be signed in to change notification settings - Fork 40.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
JacksonAutoConfiguration.FEATURE_DEFAULTS not reflected in property hint docs in properties editor. #12675
Comments
That's interesting, thanks. If we went down the route of providing custom metadata for this, we should implement #9945 first. |
We've discussed this and there is unfortunately no way for us to override the Javadoc of Jackson's Enums (the IDE is reading that, not something we would have written). Unfortunately, even if we had #9945, it would be quite confusing to add a hints that states a different default value than what's described in the Javadoc. We'll review the ref guide to make sure those defaults are clearly documented. |
I'm aware that hint comes from the javadoc. Just to be clear, I'm talking about property hints displayed in Spring Properties editor in Eclipse (when editing application.properties, with Spring IDE plug-in for Eclipse). However, if not explicitly specified, property It seems that current hint is confusing (not the Jackson's javadoc by itself - it is correct as far as Jackson is concerned - but when used as Spring Boot property hint, since Spring Boot overrides the default). Updating the ref guide to explicitly state that hint is wrong in this case would be good enough, I guess. |
What hint? Can you please share a screenshot where that hint is displayed? |
OK that confirms my suspicion.
I just wanted to make sure that something outside of the Javadoc wasn't providing that information. So we're back to my original comment. Based on your feedback @wilkinsona also raised spring-attic/spring-ide#265 |
Yes, making it obvious that I'm seeing Jackson javadoc would have helped (along with the note in ref guide). As it is, I had to dig a bit through Spring Boot and Jackson sources to make sure what is the actual default value being used. This issue can be closed as far as I'm concerned. |
Thanks for the feedback |
Since property hints/docs are generated based on property javadoc (when using
@ConfigurationProperties
), andspring.jackson.*
properties target theJacksonProperties
class, hint for serialization/deserialization features is inherited from enum members' javadoc incom.fasterxml.jackson.databind.SerializationFeature / com.fasterxml.jackson.databind.DeserializationFeature
. These are, of course, not aware of default overrides inJacksonAutoConfiguration
viaFEATURE_DEFAULTS
.Encountered with Spring Boot 2.0.0.RELEASE.
I'm not sure what would be the good way around this, but at least some kind of mention/warning in documentation would be nice. Got me confused.
The text was updated successfully, but these errors were encountered: