fix: $ref not being rendered correctly #240
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aditygrg2
requested review from
ivangsa,
derberg and
asyncapi-bot-eve
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
|
|
/rtm |
ivangsa
approved these changes
Oct 16, 2024
|
/rtm |
|
/rtm |
|
🎉 This PR is included in version 0.6.4 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Fixes rendering of $ref references in AsyncAPI documents. After extensive debugging and investigation, I identified that the issue stemmed from how the schema was being injected into the AsyncAPI component.
During the testing phase, AsyncAPI documents containing $ref references were not rendering correctly in the VS Code extension, but were working well in our web envs (react-component and studio)
The main issue was the ordering of the definitions i.e, if the definition of operations is done at the last, the component will render properly. Better approach here was to directly first read the file and directly use it in the AsyncApiStandalone.render function instead of fetching it via URI.
Related issue(s)
Fixes #204 and closes asyncapi/asyncapi-react#913
Testing Screenshots:
