Add logs to notify when SpringDocs/Scalar is enabled because SpringDocs/Scalar is enabled by default (#3090) #3122
Conversation
|
@bnasslahsen @zakaria-shahen IMHO #3131 makes deep sense. However if a developer needs this API and enables it EXPLICITLY - the warning becomes just confusing. |
|
+1, these warnings are currently unconditionally printed if the docs are enabled, it doesn't make sense at all to have unfixable warnings. There should be a way to disable the warnings, and that would be explicitly enabling the docs. |
|
@Gugu7264/ @zakaria-shahen / @lrozenblyum, As you can see, it's not easy to satisfy everyone in the open source community! You're welcome to submit a new PR for this change! |
|
Yes, I agree with @bnasslahsen that adding more configuration options can be misleading or confusing to users. Perhaps in the next major version, we could do a similar revamp of the configuration properties like what the Spring team did in Spring Boot 2.0. For example, we could deprecate the following properties:
And replace them with a single property: |
|
@bnasslahsen @zakaria-shahen Instead of adding a new property, couldn't we just display the warnings if the corresponding property ( That would make sense to have the warnings in such a case, and also would prevent having yet another property to add as you said. |
|
I vote for it. I think that could also make sense. |
|
@bnasslahsen I see your point, but it would be more confusing to have a property just to disable a warning. |
|
Agree, we will go for it for now, and see feedbacks |
|
I just stumbled upon this discussion, because I was trying to get rid of the warnings in some projects. |
I had the very same journey and consider @Gugu7264 suggestion a good first start. 👍 |
Add logs to notify when SpringDocs/Scalar is enabled (#3090)
Since the SpringDoc team disagrees with disabling SpringDocs/Scalar by default #3090 (like Scalar does scalar/scalar#6781).
we can use an alternative approach to achieve the same result: notify developers who may be unaware about SpringDocs behavior.
Background: