fix: enable enum description for API parameters#1076
Closed
Copilot wants to merge 1 commit intoDX-1373-Support-enum-variant-descriptionsfrom
Closed
fix: enable enum description for API parameters#1076Copilot wants to merge 1 commit intoDX-1373-Support-enum-variant-descriptionsfrom
Copilot wants to merge 1 commit intoDX-1373-Support-enum-variant-descriptionsfrom
Conversation
Copilot
AI
changed the title
[WIP] Fix enum description for API parameters
fix: enable enum description for API parameters
Nov 10, 2025
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
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
Enables individual descriptions for enum variants in OpenAPI output. Previously, enums generated from
t.keyof()lost per-variant JSDoc comments during optimization.Changes
knownImports.ts: Preserve property comments when generating keyof enum variantsoptimize.ts: Skip consolidation for enum schemas with comments, maintainingoneOfstructurecomments.test.ts: Add test validating individual enum variant descriptionsExample
Now generates OpenAPI with individual descriptions:
{ "oneOf": [ { "type": "string", "enum": ["pendingApproval"], "description": "Transaction is waiting for approval from authorized users" }, { "type": "string", "enum": ["canceled"], "description": "Transaction was canceled by the user" } ] }✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.