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

Feature Request: add AsyncAPI Document tab in UI #1011

Closed
mbande opened this issue Nov 16, 2020 · 5 comments · Fixed by #2714
Closed

Feature Request: add AsyncAPI Document tab in UI #1011

mbande opened this issue Nov 16, 2020 · 5 comments · Fixed by #2714
Assignees
Labels
Enhancement New feature or request

Comments

@mbande
Copy link

mbande commented Nov 16, 2020

as there is a (auto generated) Documentation for OpenAPI, please add the same functionality for AsyncAPI.

@EricWittmann EricWittmann added the Enhancement New feature or request label Nov 17, 2020
@EricWittmann
Copy link
Member

I actually tried adding the AsyncAPI UI when I initially implemented the UI but it wouldn't render. I don't recall the exact errors, but due to time constraints I had to drop it. But I agree we should include it if we can!

@EricWittmann EricWittmann self-assigned this Nov 17, 2020
@mbande
Copy link
Author

mbande commented Nov 19, 2020

@EricWittmann thank you. maybe the official html-template could help

@EricWittmann
Copy link
Member

Perhaps - I was trying this: https://github.com/asyncapi/asyncapi-react

Since our UI is also React it seemed to make sense.

@tpresthus
Copy link
Contributor

I was able to use the asyncapi-react component to render documentation in Apicurio, but because of dependencies in asyncapi-react, quite a few node core polyfills were needed.

Would be happy to clean up my attempt and open a pull request, but unsure what Apicurio's policy on these polyfills are?

@EricWittmann
Copy link
Member

I would love a PR. At the very least it can be a starting point for me. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants