diff icon indicating copy to clipboard operation
diff copied to clipboard

feat: add spec v3 support

Open aayushmau5 opened this issue 1 year ago • 4 comments

Description

Add support for AsyncAPI v3

Related issue(s) https://github.com/asyncapi/diff/issues/154

aayushmau5 avatar Sep 07 '23 15:09 aayushmau5

SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 4 Code Smells

No Coverage information No Coverage information
78.1% 78.1% Duplication

idea Catch issues before they fail your Quality Gate with our IDE extension sonarlint SonarLint

sonarqubecloud[bot] avatar Sep 07 '23 15:09 sonarqubecloud[bot]

@jonaslagoni @derberg here's a PR for spec v3 support in diff. It's a draft PR(right now there's no tests, and docs, etc). Please review the approach and the code changes I have made here.

One question:

As discussed in the meeting I had with Jonas, we aren't going to compare v2 against v3. I'm not sure what type of error do we show here? An early return? Keep in mind that this will be used by CLI, so we need to have it so that CLI is able to show the error as well.

aayushmau5 avatar Sep 07 '23 15:09 aayushmau5

sorry for late response.

so basically the diff tool purpose is to help people with review of changes that they are doing in their documents to identify breaking changes or new topics, or other things. So yeah, I think you should disallow comparing files between versions and throw error that it is technically not possible and why. Does that help?

derberg avatar Oct 11 '23 12:10 derberg

This pull request has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Feb 09 '24 00:02 github-actions[bot]