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

Config docs generation error when inheritance is used #41892

Closed
brunobat opened this issue Jul 15, 2024 · 2 comments · Fixed by #41979
Closed

Config docs generation error when inheritance is used #41892

brunobat opened this issue Jul 15, 2024 · 2 comments · Fixed by #41979
Labels
area/config kind/bug Something isn't working
Milestone

Comments

@brunobat
Copy link
Contributor

Describe the bug

When generating the documentation from @ConfigRoot, if the interface extends another interface, the listed properties in the base interface will not include the prefix of the @ConfigMapping and are hardcoded to build time properties.

Expected behavior

When having this interface definition:

@ConfigMapping(prefix = "quarkus.otel.exporter.otlp")
@ConfigRoot(phase = ConfigPhase.RUN_TIME)
public interface OtlpExporterRuntimeConfig extends OtlpExporterConfig

Classes in the OtlpExporterConfig are displayed like:
quarkus.otel.exporter.otlp.endpoint

Actual behavior

Properties show up without prefix and are built time.
Screenshot 2024-07-15 at 09 35 29

How to Reproduce?

Override a property defined on a base interface and see the generated documentation

Output of uname -a or ver

Darwin 22.6.0 Darwin Kernel Version 22.6.0: Mon Apr 22 20:49:37 PDT 2024; root:xnu-8796.141.3.705.2~1/RELEASE_ARM64_T6000 arm64

Output of java -version

% java --version openjdk 21.0.2 2024-01-16 LTS OpenJDK Runtime Environment Temurin-21.0.2+13 (build 21.0.2+13-LTS) OpenJDK 64-Bit Server VM Temurin-21.0.2+13 (build 21.0.2+13-LTS, mixed mode)

Quarkus version or git rev

No response

Build tool (ie. output of mvnw --version or gradlew --version)

Apache Maven 3.9.6 (bc0240f3c744dd6b6ec2920b3cd08dcc295161ae) Maven home: /Users//.sdkman/candidates/maven/current Java version: 21.0.2, vendor: Eclipse Adoptium, runtime: /Users//.sdkman/candidates/java/21.0.2-tem Default locale: en_PT, platform encoding: UTF-8 OS name: "mac os x", version: "13.6.7", arch: "aarch64", family: "mac"

Additional information

No response

@brunobat brunobat added the kind/bug Something isn't working label Jul 15, 2024
Copy link

quarkus-bot bot commented Jul 15, 2024

/cc @radcortez (config)

@brunobat
Copy link
Contributor Author

This #41891
Was created as temp workaround.

@brunobat brunobat changed the title Config docs generation error Config docs generation error when override is used Jul 15, 2024
@brunobat brunobat changed the title Config docs generation error when override is used Config docs generation error when inheritance is used Jul 17, 2024
@quarkus-bot quarkus-bot bot added this to the 3.14 - main milestone Jul 22, 2024
@gsmet gsmet modified the milestones: 3.14 - main, 3.13.0 Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/config kind/bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants