Skip to content
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

Registry config javadoc #16015

Merged
merged 1 commit into from
Mar 25, 2021

Conversation

aloubyansky
Copy link
Member

Added missing javadoc.

@aloubyansky aloubyansky requested a review from gastaldi March 25, 2021 10:57
@quarkus-bot quarkus-bot bot added area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/platform Issues related to definition and interaction with Quarkus Platform labels Mar 25, 2021
@aloubyansky aloubyansky force-pushed the registry-config-javadoc branch from 3c5aa5a to 68a9396 Compare March 25, 2021 11:00
Copy link
Contributor

@gastaldi gastaldi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, added one comment

* the client will not send requests to resolve platform extension catalogs to the registry.
*
* @return true if the registry will be able to handle platform descriptor requests, otherwise - false
*/
Boolean getExtensionCatalogsIncluded();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this method is not returning a primitive?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The way it is implemented currently, the default config is provided by the registry itself. The client may have a customized version of it (i.e. by selectively overriding some values) in the config.yaml. When the registry client is initialized, it is merging the default registry config and the client side version (if it exists). A non-null value from this method would represent a user's choice, which will override the registry's default. So null in this case will mean that the user is willing to accept whatever the registry's default is.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd recommend to put that in the Javadoc, but too late now :)

@aloubyansky aloubyansky merged commit 2114301 into quarkusio:main Mar 25, 2021
@quarkus-bot quarkus-bot bot added this to the 1.14 - main milestone Mar 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins area/platform Issues related to definition and interaction with Quarkus Platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants