AsyncAPI spec v3 support in Diff

[jonaslagoni]

Reason/Context

This Issue is used to track changes needed to support AsyncAPI v3. As a code owner, please edit this list of TODO tasks in order to properly track the progress 🙂 Once this issue is closed it means that v3 is now fully supported in this library.

Remaining tasks:

• Update to parser v2 #201
• Figure out how to handle comparing v3 with v2 (if at all)
• Add diff for v3 documents
• Once AsyncAPI spec v3 support in parser-js parser-js#780 is solved, update parser dependency (might be automated)
• Update diff library in CLI

[github-actions]

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup 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.

[jonaslagoni]

cc codeowners @aayushmau5 @vinitshahdeo @onbit-uchenik @magicmatatjahu @derberg

Would be really cool to have this library work out the gate when we release v3, are any of you interested in scheduling a public call specifically to discuss how to enable this?

If you have any questions about how it can be achieved or v3-specific stuff I can help answer those in the meeting to enable you to progress with this 🙂

Let me know if it has any interest.

[aayushmau5]

@jonaslagoni I'll start working on this.

Would be really cool to have this library work out the gate when we release v3, are any of you interested in scheduling a public call specifically to discuss how to enable this?

Sure! I haven't particularly kept up with the new spec changes, so it would be cool to get on a call and discuss the changes that needs to be made to this library.

[jonaslagoni]

Cool!

@aayushmau5 just let me know a date and time that fits for you and I can schedule a meeting 🙂

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity 😴

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

There can be many reasons why some specific issue 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 issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

[aeworxet]

Bounty Issue's service comment

Text labels: bounty/2024-Q4, bounty/advanced, bounty/coding
First assignment to regular contributors: 2024-09-20 00:00:00 UTC+12:00
End Of Life after: 2024-10-31 23:59:59 UTC-12:00

@asyncapi/bounty_team

The Bounty Program is not a Mentorship Program. The accepted level of Bounty Program Participants is Middle/Senior.

Regular contributors should explain in meaningful words how they are going to approach the resolution process when expressing a desire to work on this Bounty Issue.

[chinma-yyy]

Hi @jonaslagoni @aeworxet,
I’d like to work on this issue under the bounty program. I’ll put together a detailed approach within the next day or two and share it here.

[aayushmau5]

@chinma-yyy i think it's best i work on this issue here. I already had some approach and some implementation done before this issue got stale. Will need to rework those so clubbed all the issues and will fix them on one go.

[aeworxet]

@aayushmau5 is an AsyncAPI Maintainer specified in https://raw.githubusercontent.com/asyncapi/community/master/MAINTAINERS.yaml, so they fall under the first category in the prioritization list.

[aeworxet]

Bounty Issue's Timeline

Complexity Level	Assignment Date (by GitHub)	Start Date (by BP Rules)	End Date (by BP Rules)	Draft PR Submission	Final PR Merge Start	Final PR Merge End
Advanced	2024-09-17	2024-10-07	2024-12-01	2024-10-27	2024-11-17	2024-12-01

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

Keep in mind the responsibility for violations of the Timeline.

[imabp]

@aeworxet @aayushmau5 @jonaslagoni is this open...i would. like to work on this?

[aayushmau5]

@imabp I'm working on this issue :)

[imabp]

Okay thanks for letting me know.. @aayushmau5
As I saw the draft PR submission is 27th Oct 2024, I thought, you are not having bandwidth for this.

cc: @aeworxet

[aayushmau5]

@imabp Yeah, i had some work already done which got stale. I reopened it just now but yeah, i'm actively working on this issue.

[imabp]

do you need any help? @aayushmau5

[aayushmau5]

@imabp not yet. I'll let you know once I get these changes done. Maybe you can pick up other issues for diff if you want to :)

[imabp]

Sure taking a look at them @aayushmau5 . I was developing Myer's Diff Algorithm, so had a chat with Souvik, he suggested me about this project. Thanks 🙏

[aeworxet]

@aayushmau5 (githubID 54525741), please provide an update to the PR.

[aayushmau5]

@aeworxet I'm done with adding support for asyncapi v3. I'm in the process of writing tests for the changes.

[aeworxet]

@aayushmau5 (githubID 54525741), please provide an update to the PR.

[aeworxet]

@aayushmau5 (githubID 54525741), please provide an update to the PR.

[aeworxet]

@aayushmau5 (githubID 54525741), please provide an update to the PR.

[aayushmau5]

@aeworxet I'm currently going through AsyncAPI spec v3 and adding the proper standard file for it.

[aeworxet]

@aayushmau5, are you on track to complete this Bounty Issue by 2024-12-01, or will you need an extension?

[aayushmau5]

Will need an extension by two weeks for updating diff for CLI

[aeworxet]

Upon request of the AsyncAPI Maintainer, who is responsible for the resolution of the Bounty Issue from the AsyncAPI's side and is also the Bounty Program Participant (@aayushmau5 (githubID 54525741)), all remaining target dates of the Bounty Issue's Timeline are extended by two calendar weeks.

Bounty Issue's Timeline Extended

Complexity Level	Assignment Date (by GitHub)	Start Date (by BP Rules)	End Date (by BP Rules)	Draft PR Submission	Final PR Merge Start	Final PR Merge End
Advanced	2024-09-17	2024-10-07	2024-12-15	2024-11-10	2024-12-01	2024-12-15

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

Keep in mind the responsibility for violations of the Timeline.

[aeworxet]

@aayushmau5 (githubID 54525741), please provide an update to the PR.

[aeworxet]

The Bounty Issue's PR is approved and ready to be merged.

[aeworxet]

@aayushmau5, please confirm that the merged code is functioning as expected, both as a standalone application and when integrated into the CLI, and close the GitHub issue.

[aeworxet]

Due to miscommunication, it was unclear whether support for this functionality by the CLI is part of this Bounty Issue. It is now clear that it is, and it is currently being developed; therefore, all remaining target dates of the Bounty Issue's Timeline are extended by two calendar weeks.

Bounty Issue's Timeline Extended

Complexity Level	Assignment Date (by GitHub)	Start Date (by BP Rules)	End Date (by BP Rules)	Draft PR Submission	Final PR Merge Start	Final PR Merge End
Advanced	2024-09-17	2024-10-07	2024-12-29	2024-11-10	2024-12-01	2024-12-29

Please note that the dates given represent deadlines, not specific dates, so if the goal is reached sooner, it's better.

Keep in mind the responsibility for violations of the Timeline.