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.

Sign up for GitHub

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

Jump to bottom

JSON schema generator should use descriptions from Java interfaces #814

Closed
DirkMahler opened this issue Feb 17, 2025 · 0 comments · Fixed by #815
Closed

JSON schema generator should use descriptions from Java interfaces #814

DirkMahler opened this issue Feb 17, 2025 · 0 comments · Fixed by #815
Assignees
@Bramaten
Milestone
2.6

Comments

@DirkMahler
Copy link
Member

The configuration interfaces for SmallRye Config make use of a @Ðescription annotation.

It shall be evaluated if the values here can be include in the generated JSON schema.
@DirkMahler DirkMahler added this to the 2.7 milestone Feb 17, 2025
Bramaten added a commit that referenced this issue Feb 17, 2025
@Bramaten
#814 added support for descriptions from java interfaces (only for me…
2cd8c2b 
…thods) & restructured generateSchema()
@Bramaten Bramaten linked a pull request Feb 17, 2025 that will close this issue
#814 added support for descriptions from java interfaces #815
Merged
Bramaten added a commit that referenced this issue Feb 19, 2025
@Bramaten
#814 added definition support for inner definitions
c2209dc
Bramaten added a commit that referenced this issue Feb 24, 2025
@Bramaten
#814 added test for behaviour of adding descriptions and defaults to …
e661991 
…JSON schema
Bramaten added a commit that referenced this issue Feb 24, 2025
@Bramaten
#814 adjusted tests for descriptions and defaults
1905424
@DirkMahler DirkMahler modified the milestones: 2.7, 2.6 Feb 24, 2025
Bramaten added a commit that referenced this issue Feb 24, 2025
@Bramaten
#814 merged master into branch and adjusted tests
d21435d
DirkMahler pushed a commit that referenced this issue Feb 24, 2025
@Bramaten
#814 added support for descriptions from java interfaces (#815)
64499c4 
* #814 added support for descriptions from java interfaces (only for methods) & restructured generateSchema()

* #814 added definition support for inner definitions

* #814 added test for behaviour of adding descriptions and defaults to JSON schema

* #814 adjusted tests for descriptions and defaults

* #814 merged master into branch and adjusted tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Bramaten Bramaten

Labels
None yet
Projects
None yet
Milestone
2.6
Development

Successfully merging a pull request may close this issue.

#814 added support for descriptions from java interfaces jQAssistant/jqassistant
2 participants
@DirkMahler @Bramaten