Jersey3 OpenAPI templates: add attribute description as comment #1190
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jillingk
reviewed
Nov 29, 2023
Co-authored-by: jillingk <93914435+jillingk@users.noreply.github.com>
gcatanese
force-pushed
the
attributes-javadoc
branch
from
6c8002b
to
b537790
Compare
michaelpaul
approved these changes
Dec 1, 2023
jillingk
approved these changes
Dec 1, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I'd like to suggest a change to the Jersey3 templates so that each pojo attribute includes the OpenAPI description as a comment, helping developers to understand the property and how to use it, for example: