-
Notifications
You must be signed in to change notification settings - Fork 276
Render x-enumDescriptions in table #951
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.
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
Render x-enumDescriptions in table #951
Conversation
Visit the preview URL for this PR (updated for commit d0b5160): https://docusaurus-openapi-36b86--pr951-0d07hg1l.web.app (expires Thu, 10 Oct 2024 12:18:33 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
Thanks for the PR @omonk - made me realize we should probably try to document the vendor extensions supported by the plugin. |
@@ -197,6 +197,7 @@ export interface ParameterObject { | |||
param?: Object; | |||
// ignoring stylings: matrix, label, form, simple, spaceDelimited, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, it's on the roadmap to tackle param serialization styles, but this should be ok for now.
Small request - can we rename "Enum" to "Enum Value" for clarity/consistency? Thanks! |
Ah yes, resolved this now, thanks @sserrata |
Many thanks @sserrata - what are you plans with the next release? |
Hopefully by end of week. Reminder that canary releases are published with each merge to |
Description
This PR adds the ability to render
x-enumDescription
values alongside enum listsMotivation and Context
I am working on a spec with ~100 uses of
x-enumDescription
, a feature of redocly. We have just migrated from redocly and would rather not require reformatting my spec to.How Has This Been Tested?
See new entries to parameters and response body in the petstore yaml
Screenshots (if appropriate)
Response body
Parameter
Types of changes
Checklist