Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

AsyncAPI spec v3 support in generator #979

Closed
2 tasks done
Tracked by #294 ...
jonaslagoni opened this issue Jun 5, 2023 · 4 comments 路 Fixed by #1017
Closed
2 tasks done
Tracked by #294 ...

AsyncAPI spec v3 support in generator #979

jonaslagoni opened this issue Jun 5, 2023 · 4 comments 路 Fixed by #1017
Labels
enhancement New feature or request

Comments

@jonaslagoni
Copy link
Sponsor Member

jonaslagoni commented Jun 5, 2023

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.

Scope

@jonaslagoni
Copy link
Sponsor Member Author

We need to add https://github.com/smoya/multi-parser-js as a dependency, and support a new apiVersion as 2 along side the rest.

@derberg
Copy link
Member

derberg commented Sep 6, 2023

I'm all for apiVersion flag, main reason is to not harm adoption of future 3.x releases

How removing flag will harm future release:

  • forget about v2, lets see we release v3 in September
  • imagine apiVersion is not there
  • generator supports only Parser API v2
  • imagine there is AsciiDoc template (there actually is one, on GitLab, but imagine different)
  • AsciiDoc maintainers took the effort to update the template to support spec v3.0
  • Months pass, Parser API v3 is released for some reason which means:
    • new JS Parser is released (probably major)
    • Generator new major must be released
  • Month after spec 3.1 is released
  • AsciiDoc maintainers do not have time to migrate to new Generator and new Parser API
  • Community do not adopt 3.1 as they prefer to workaround missing features and just use 3.0

No go for me

Unless we can assure that new Parser API in JS Parser will never mean a breaking change in library API


regarding multi-parser-js - I strongly suggest it is part of the parser, not lib but parser repo, and versioned and released together with JS Parser, to simplify workflows.

@derberg
Copy link
Member

derberg commented Sep 6, 2023

Btw recording of online discussion about the generator -> https://www.youtube.com/watch?v=b4KcouHm958

@jonaslagoni
Copy link
Sponsor Member Author

Agree 馃憤

regarding multi-parser-js - I strongly suggest it is part of the parser, not lib but parser repo, and versioned and released together with JS Parser, to simplify workflows.

It's something we can always figure out how to do at any time, so I am gonna integrate it with the generator to move this issue along.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants