Skip to content
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

SwaggerEditor@next: does not render model extensions within SwaggerUI #4493

Open
frankkilcommins opened this issue Oct 24, 2023 · 8 comments

Comments

@frankkilcommins
Copy link
Contributor

SwaggerEditor@Next does not enable the showExtensions property when initializing SwaggerUI.

This is a regression in SwaggerEditor@Next for OpenAPI. The heritage version of SwaggerEditor supports it as well as AsyncAPI extensions being supported in the Next version of the editor.

SwaggerEditor@Next:
new_ui

SwaggerEditor:
old_ui

@char0n
Copy link
Member

char0n commented Nov 1, 2023

For OpenAPI 2.0 and 3.0.x this should be a configuration change.

For OpenAPI 3.1.0 we need to check if the new JSON Schema 2020-12 renderer (used with OpenAPI 3.1.0 definitions) supports rendering the extensions at all.

@frankkilcommins
Copy link
Contributor Author

@char0n additional work will have to be done to accommodate the new renderers. Suggest to split that out into a separate issue.

@char0n char0n changed the title SwaggerEditor@Next does not render model extensions within SwaggerUI SwaggerEditor@next: does not render model extensions within SwaggerUI Nov 13, 2023
@char0n char0n assigned char0n and unassigned frankkilcommins Nov 13, 2023
@char0n
Copy link
Member

char0n commented Nov 13, 2023

Extension rendering enhancement for OpenAPI 2.0/3.0.x is being handled in: swagger-api/swagger-ui#9377

Extension rendering for OpenAPI 3.1.0 is being handled in: swagger-api/swagger-ui#9376

@swagger-bot
Copy link
Contributor

🎉 This issue has been resolved in version 5.0.0-alpha.81 🎉

The release is available on:

Your semantic-release bot 📦🚀

@char0n
Copy link
Member

char0n commented Apr 3, 2024

This hasn't been addressed yet

@char0n char0n reopened this Apr 3, 2024
@pavelkornev
Copy link

@char0n @frankkilcommins we (SAP) made this contribution to AsyncAPI UI component:
asyncapi/asyncapi-react#994

  1. We need a way to pass the configuration to AsyncAPI plugin via Swagger UI constructor. Is there a way already?
  2. We need a similar extension mechanism for OpenAPI rendering. Are you open for a similar contribution to Swagger UI component as we did to AsyncAPI UI? If so, we will prepare a PR.

@char0n
Copy link
Member

char0n commented May 6, 2024

Hi @pavelkornev,

  1. We need a way to pass the configuration to AsyncAPI plugin via Swagger UI constructor. Is there a way already?

Extracted in #5006 and resolved there.

@char0n
Copy link
Member

char0n commented May 6, 2024

  1. We need a similar extension mechanism for OpenAPI rendering. Are you open for a similar contribution to Swagger UI component as we did to AsyncAPI UI? If so, we will prepare a PR.

This is a multi-step effort, we'll be addressing this in foreseeable future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants