Skip to content

Add support for x-enumDescriptions extension - #1359

Open
federicobond wants to merge 1 commit into
tfranzel:masterfrom
federicobond:x-enum-descriptions
Open

Add support for x-enumDescriptions extension#1359
federicobond wants to merge 1 commit into
tfranzel:masterfrom
federicobond:x-enum-descriptions

Conversation

@federicobond

@federicobond federicobond commented Jan 6, 2025

Copy link
Copy Markdown
Contributor

This adds support for the x-enumDescriptions OpenAPI extension field as documented here:
https://redocly.com/docs/realm/author/reference/openapi-extensions/x-enum-descriptions

Redoc and Scalar support this extension and provide a better UX than text-based descriptions.

The change is fully backward-compatible. I added a new boolean setting ENUM_GENERATE_X_ENUM_DESCRIPTIONS to enable this feature. Let me know if this makes sense for you.

@codecov

codecov Bot commented Jan 6, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.57%. Comparing base (5734744) to head (3c14118).
⚠️ Report is 126 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1359      +/-   ##
==========================================
+ Coverage   98.42%   98.57%   +0.15%     
==========================================
  Files          74       74              
  Lines        9139     9146       +7     
==========================================
+ Hits         8995     9016      +21     
+ Misses        144      130      -14     

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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