feat: require @description tags for enum comments #1092
Merged
+128
−149
Conversation
This file contains hidden or 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
Contributor
Author
|
Not sure why the Nix Flake Check is failing. I can run |
koralkulacoglu
force-pushed
the
DX-1373-add-a-tag-for-enumDescriptions
branch
from
db69853 to
b7531fe
Compare
starfy84
approved these changes
Nov 24, 2025
Contributor
starfy84
left a comment
starfy84
left a comment
There was a problem hiding this comment.
LGTM. @koralkulacoglu can you also make a PR in dev-portal to bump the version of openapi-generator?
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.
Ticket: DX-1373
Previously, all JSDoc comments on enum values were automatically converted to x-enumDescriptions in the OpenAPI spec, causing internal developer comments to be exposed as public API documentation.
This change modifies the keyof function to only generate x-enumDescriptions when enum values have explicit
@descriptiontags, giving developers control over what becomes public documentation.More context can be found on this Slack thread.