Skip to content

Render x-enumDescriptions in table#951

Merged
sserrata merged 5 commits intoPaloAltoNetworks:mainfrom
omonk:ollie.monk/x-enumDescriptions
Sep 10, 2024
Merged

Render x-enumDescriptions in table#951
sserrata merged 5 commits intoPaloAltoNetworks:mainfrom
omonk:ollie.monk/x-enumDescriptions

Conversation

@omonk
Copy link
Contributor

@omonk omonk commented Sep 6, 2024

Description

This PR adds the ability to render x-enumDescription values alongside enum lists

Motivation 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

image

Parameter

image

Types of changes

  • New feature (non-breaking change which adds functionality)

Checklist

  • [ x ] I have updated the documentation accordingly.
  • [ x ] I have read the CONTRIBUTING document.
  • [ x ] I have added tests to cover my changes if appropriate.
  • [ x ] All new and existing tests passed.

@omonk omonk changed the title Ollie.monk/x enum descriptions Render x-enumDescriptions in table Sep 6, 2024
@github-actions
Copy link

github-actions bot commented Sep 6, 2024 •
edited
Loading

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

@sserrata
Copy link
Member

sserrata commented Sep 9, 2024

Thanks for the PR @omonk - made me realize we should probably try to document the vendor extensions supported by the plugin.

sserrata
sserrata approved these changes Sep 9, 2024
View reviewed changes
packages/docusaurus-plugin-openapi-docs/src/openapi/types.ts
@@ -197,6 +197,7 @@ export interface ParameterObject {
param?: Object;
// ignoring stylings: matrix, label, form, simple, spaceDelimited,
Copy link
Member

@sserrata sserrata Sep 9, 2024

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.

@sserrata
Copy link
Member

sserrata commented Sep 9, 2024

Small request - can we rename "Enum" to "Enum Value" for clarity/consistency? Thanks!

@omonk
Copy link
Contributor Author

omonk commented Sep 10, 2024

Small request - can we rename "Enum" to "Enum Value" for clarity/consistency? Thanks!

Ah yes, resolved this now, thanks @sserrata

@sserrata sserrata merged commit 961aecd into PaloAltoNetworks:main Sep 10, 2024
@omonk
Copy link
Contributor Author

omonk commented Sep 10, 2024

Many thanks @sserrata - what are you plans with the next release?

@sserrata sserrata added v4.0.0 v4.0.0 enhancement New feature or request labels Sep 10, 2024
@sserrata
Copy link
Member

sserrata commented Sep 10, 2024

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 main.

@tuanpt-0634 tuanpt-0634 mentioned this pull request Oct 2, 2024
Merged
4 tasks
@omonk omonk mentioned this pull request Oct 3, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sserrata sserrata sserrata approved these changes

Assignees

No one assigned

Labels

enhancement New feature or request v4.0.0 v4.0.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@omonk @sserrata