Skip to content

Declarative config ref descriptions#8540

Open
jack-berg wants to merge 2 commits into
open-telemetry:mainfrom
jack-berg:declarative-config-ref-descriptions
Open

Declarative config ref descriptions#8540
jack-berg wants to merge 2 commits into
open-telemetry:mainfrom
jack-berg:declarative-config-ref-descriptions

Conversation

@jack-berg

Copy link
Copy Markdown
Member

Currently jsonschema2Pojo annotated generated content with property descriptions inconsistently:

  • Sometimes the getters get javadoc, other times not (!!)
  • Sometimes fields get javadoc, other times not (!!)
  • Sometimes fields get the descriptions duplicated in @JsonPropertyDescription, other times not (!!)

This inconsistency is frustrating to me. This PR updates the generation logic to:

  • Only add javadoc description on getters
  • Fields get nothing: no javadoc, no @JsonPropertyDescription
  • Format the descriptions such that line breaks have new <p>
  • Omit the (Required) added to required properties by jsonschema2Pojo - opentelemetry-configuration has build tooling that automatically include this information in descriptions so its purely duplicative

@jack-berg jack-berg requested a review from a team as a code owner June 25, 2026 20:31
@codecov

codecov Bot commented Jun 25, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.95%. Comparing base (104d56e) to head (c6bfa97).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #8540      +/-   ##
============================================
+ Coverage     90.93%   90.95%   +0.01%     
- Complexity    10209    10210       +1     
============================================
  Files          1013     1013              
  Lines         27175    27176       +1     
  Branches       3184     3184              
============================================
+ Hits          24712    24718       +6     
+ Misses         1735     1731       -4     
+ Partials        728      727       -1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant