-
-
Notifications
You must be signed in to change notification settings - Fork 145
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
feat([AsyncApi]): add asyncapi viewer #747
Conversation
🦋 Changeset detectedLatest commit: 4540281 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
a6e171c
to
1fd28d8
Compare
Thank you @XaaXaaX I have reviewed, looking great! Actually whilst I was reviewing and fixing some stuff, I had a rethink of some things and actually going to make some changes to the AsyncAPI and OpenAPI components. ProblemsThese components both rely on certain hacks and custom JS to get working in EventCataog cost they are MDX components, and it's hard to share the configuration around the application this way. The component itself was just rendering a title with a link.... so given this I have decided to remove them as MDX componnets in favour of frontmatter API. Why frontmater APIThis allows EventCatalog to read all domains, services and messages and check if they have any openapi spec or asyncapi spec on them, benefits we get
New API looks like this
Here is a new specifications (optional) frontmatter config, where people can add openapi or asyncapi paths to it. This is a breaking change, but I think its for the better and cleans up our code! Thank you for the time for the PR @XaaXaaX ! |
@all-contributors add @XaaXaaX for code |
I've put up a pull request to add @XaaXaaX! 🎉 |
Issue : #746
Motivation
Having a comprehensive and standard rendering of asyncapi spec can be useful for users as a used to visualization that they are confortable with