-
-
Notifications
You must be signed in to change notification settings - Fork 37
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
fix: add the suggested incorrect spec preview changes #230
base: feature/mermaid-markdown
Are you sure you want to change the base?
fix: add the suggested incorrect spec preview changes #230
Conversation
Signed-off-by: nikhilkalburgi <nikhilkalburgi19@gmail.com>
Signed-off-by: nikhilkalburgi <nikhilkalburgi19@gmail.com>
Signed-off-by: nikhilkalburgi <nikhilkalburgi19@gmail.com>
Signed-off-by: nikhilkalburgi <nikhilkalburgi19@gmail.com>
Signed-off-by: nikhilkalburgi <nikhilkalburgi19@gmail.com>
Signed-off-by: nikhilkalburgi <nikhilkalburgi19@gmail.com>
…vs-asyncapi-preview into mermaid-markdown
Sorry! A small code went missing in the webpack config file and was causing this issue. I have committed the latest change in the same mermaid-markdown branch. Can you please check again? |
Hi Ivan, I have updated this PR also to include support for the AVRO syntax preview. Are you still not able to access those two files? |
Hi @ivangsa , I have finally implemented the Flowchart and ClassDiagram with this PR. With this:
Have a look: 11.06.2024_13.08.07_REC.mp4Nextly, I will:
|
Hi @ivangsa, How are you doing? Updating you after a long time. I have improved the rendering of incorrect spec to a better extent and also integrated the export to markdown button to top-right corner of the webview. This new button will copy the MD version of preview to clipboard. The preview supports both the V3 & V2 version for Incorrect Spec. |
@nikhilkalburgi great!! I hope to have some time this week to review your work.. cheers! |
Hi @ivangsa, Sorry for the late response! I have some doubts and info on your suggestions: 1. Markdown:Can you share with me a mockup UI design on a real sample spec for a better understanding of indexing? 2. Flowchart:
3. Class Diagram:Currently, I am showing the hierarchy of message->payload->properties->propOne. Channel:
Operation:
Message:
lightMeasuredPayload (Schema)
Then, the same spec is represented as:So, the period ('.') separated string represents the hierarchy from the top to the bottom. For example: If you are expecting something else then can you also use the same example and create a Mockup classDiagram on it? |
Hi @nikhilkalburgi , sorry for the late response
This is what I would try to generate with mermaid for that schema: (it may not be exact, because of the api version screenshot, but I think it's easy to get the idea) I'll be mostly of line next days, but let me know if you need any help |
Hi @ivangsa, I have made changes to class diagram and this is how it looks: For the following objects: CHANNEL:
Operation:
Message:
Payload Schema:
Can you check it from your side and let me know if it works? |
Hi @ivangsa , I was planning to build the index like the below image: What do you think about this? |
Nice, dont forget to add channels and messages to index as well |
Quality Gate failedFailed conditions See analysis details on SonarCloud Catch issues before they fail your Quality Gate with our IDE extension SonarLint |
Hi @ivangsa, I have also implemented the indexing in my latest commit. |
Hi @ivangsa I sincerely apologize. I'm always eager to contribute to AsyncAPI, and I deeply appreciate the support you've shown me, which I will value for the rest of my life. I wanted to revisit the GitHub thread and discuss why it's not quite ready for merging. I have dedicated multiple hours to finishing the task that was not even part of the proposal. Just to give the best I can We haven't had the chance to connect over a video call, and this may have led to some misunderstandings. Could we connect sometime? I’d love to hear what your expectations were so I can better understand and align with them. Looking forward to your thoughts. |
Description
Check this demo:
20.05.2024_21.46.13_REC-ezgif.com-video-cutter.mp4