Which AsyncAPI versions are supported? #456

leonheess · 2021-10-12T22:27:14Z

I expected the latest release to support all available AsyncAPI versions. However, this is not the case. Are the supported versions listed somewhere and is there maybe a roadmap telling me when support for the newer versions will drop?

derberg · 2021-10-13T06:49:02Z

@leonheess hey, we support all from 2.0.0 up. I think you did not notice info that was at the top of the readme

⚠️ We are in the process of rewriting the component under the next branch. The current version 0.X.X is in the maintenance mode, we are focusing mainly on the next branch. Check out releases with next suffix in the release tag or the next tag on NPM.

I'm pretty sure next releases support all AsyncAPI 2.x versions. Does it help?

magicmatatjahu · 2021-10-13T07:53:30Z

next - version 2.0.0 up are supported and new content from 2.1.0 and 2.2.0 is rendered
master - version 2.0.0 up are supported and but new content from 2.1.0 and 2.2.0 is not rendered

I made quick check with latest version of next and master branches with 2.2.0 AsyncAPI document:

<!DOCTYPE html>
<html>
  <head>
    <!-- next version -->
    <link rel="stylesheet" href="https://unpkg.com/@asyncapi/[email protected]/styles/default.min.css">

    <!-- master version -->
    <script src="https://unpkg.com/@webcomponents/[email protected]/webcomponents-bundle.js"></script>
    <script src="https://unpkg.com/@asyncapi/[email protected]/lib/asyncapi-web-component.js" defer></script>
  </head>
  <body>
  
    <!-- master version -->
    <asyncapi-component
      schemaUrl="https://raw.githubusercontent.com/asyncapi/spec/master/examples/streetlights-kafka.yml"
      schemaFetchOptions='{"method":"GET","mode":"cors"}'
      cssImportPath="https://unpkg.com/@asyncapi/[email protected]/lib/styles/fiori.css">
    </asyncapi-component>

    <div id="next"></div>

    <!-- next version -->
    <script src="https://unpkg.com/@asyncapi/[email protected]/browser/standalone/index.js"></script>
    <script>
      AsyncApiStandalone.render({
        schema: {
          url: 'https://raw.githubusercontent.com/asyncapi/spec/master/examples/streetlights-kafka.yml',
        },
        config: {
          show: {
            sidebar: true,
          }
        },
      }, document.getElementById('next'));
    </script>

  </body>
</html>

and I see:

leonheess · 2021-10-13T08:03:05Z

Thank you, @magicmatatjahu, maybe consider adding the first part to the readme. I don't think this distinction is clear otherwise (:

Is there a timeline on when master will support the new content?

derberg · 2021-10-13T09:24:59Z

@leonheess you can freely use next branch and related release candidates, they are constantly deployed and battle-tested on our https://playground.asyncapi.io/. @magicmatatjahu it might make sense to push latest release there 😉

but regarding readme on master, if you say it is not clear, I say we need to make it even more clearer, as community is the boss here. @leonheess best would be if you could open a PR with change suggestion. Let us know if you are keen to do it

Is there a timeline on when master will support the new content?

The goal is that once next goes into master we release a first 1.0.0 release. To make sure we can do it @magicmatatjahu is now working on a new playground -> https://github.com/asyncapi/studio/ to make sure it is really production-ready and not breaking changes need to be introduced. @magicmatatjahu correct me if I'm wrong but I think that once studio is released and replaces playground, we release 1.0 of react component?

magicmatatjahu · 2021-10-13T09:35:07Z

@derberg @leonheess

it might make sense to push latest release there 😉

Right, Fran will be back tomorrow so I will ping him :)

correct me if I'm wrong but I think that once studio is released and replaces playground, we release 1.0 of react component?

Partially right, but I wonder if we should also wait for the implementation of this proposition (Proposal to define Modules aka Plugins for UI component and Studio). If we go with 1.0.0, we will have to do 2.0.0 when implementing the proposition. Additionally, we finally have a graphic designer, so the styles will change again soon so again, next breaking-change :)

Thank you, @magicmatatjahu, maybe consider adding the first part to the readme. I don't think this distinction is clear otherwise (:

if you want to do the PR yourself, go ahead, but we can also do it ourselves if you don't have time :)

derberg · 2021-10-13T09:40:00Z

Partially right, but I wonder if we should also wait for the implementation of this proposition (Proposal to define Modules aka

Plugins for UI component and Studio). If we go with 1.0.0, we will have to do 2.0.0 when implementing the proposition. Additionally, we finally have a graphic designer, so the styles will change again soon so again, next breaking-change

I'm always in the position that we should not be afraid to release 2.0 a month after 1.0 if it makes sense and is useful for the community 🤷🏼 Work on plugins and using it and validating in studio is not something that will happen in a week or 2.

Regarding styling. Don't be a huge optimist here. We will have great designer here, but designer for entire AsyncAPI Initiative, where lots of help is needed in many different places. There is also an onboarding process. Therefore again, IMHO waiting is not good, not all people are comfortable using release candidates in production. We probably need a wider discussion here, trying to involve existing React component users

magicmatatjahu · 2021-10-13T10:22:50Z

I'm always in the position that we should not be afraid to release 2.0 a month after 1.0 if it makes sense and is useful for the community 🤷🏼 Work on plugins and using it and validating in studio is not something that will happen in a week or 2.

Regarding styling. Don't be a huge optimist here. We will have great designer here, but designer for entire AsyncAPI Initiative, where lots of help is needed in many different places. There is also an onboarding process. Therefore again, IMHO waiting is not good, not all people are comfortable using release candidates in production. We probably need a wider discussion here, trying to involve existing React component users

And for that I used sentence I wonder if we should also wait... 😄 I'm totally agree with you.

leonheess closed this as completed Oct 13, 2021

alex-zywicki mentioned this issue Oct 25, 2021

/docs does not work with asyncapi 2.2.0 dedoussis/asynction#109

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Which AsyncAPI versions are supported? #456

Which AsyncAPI versions are supported? #456

leonheess commented Oct 12, 2021 •

edited

Loading

derberg commented Oct 13, 2021

magicmatatjahu commented Oct 13, 2021

leonheess commented Oct 13, 2021 •

edited

Loading

derberg commented Oct 13, 2021

magicmatatjahu commented Oct 13, 2021

derberg commented Oct 13, 2021

magicmatatjahu commented Oct 13, 2021

Which AsyncAPI versions are supported? #456

Which AsyncAPI versions are supported? #456

Comments

leonheess commented Oct 12, 2021 • edited Loading

derberg commented Oct 13, 2021

magicmatatjahu commented Oct 13, 2021

leonheess commented Oct 13, 2021 • edited Loading

derberg commented Oct 13, 2021

magicmatatjahu commented Oct 13, 2021

derberg commented Oct 13, 2021

magicmatatjahu commented Oct 13, 2021

leonheess commented Oct 12, 2021 •

edited

Loading

leonheess commented Oct 13, 2021 •

edited

Loading