AsyncAPI EDA Design & Documentation ecosystem update (1 April - 30 June 2022)

asyncapi-eda-design-01-04-30-06-2022-update.md

AsyncAPI EDA Design & Documentation ecosystem update (1 April - 30 June 2022)

Update refers to repositories:

• studio
• asyncapi-react
• html-template
• markdown-template
• server-api
• generator
• cli

Note: the generator and cli update is described from an EDA design & documentation point of view. For more changes please refer to update in the EDA Development area.

studio

• New Features:
  • Change logo of the AsyncAPI Studio, update OG image and icons
  • Studio supports 2.4.0 AsyncAPI
  • We created Survey Popover and after few days hide it to collect needed information from users about UX/UI.
• Opened PRs:
  • @jonaslagoni created a PR with replacing the Studio's built-in Visualiser with a Visualiser exported as a separate library. Due to the fact that the library does not support all things what the current Visualiser does, PR is "locked" and will be unlocked when all things are supported. More info in Switch to visualiser library PR.
• Ideas/discussions/issues:
  • Mentorship program started and @wh0sumit started working on Drag&drop AsyncAPI block builder. We are discussing about the types of blocks we will be able to have and how to edit the data in the blocks - it will probably be a modal that will be opened with a double click. For more info and udpates please check mentioned issue. With each new iteration, I'll let you know the progress.
  • Create onboarding for features of Studio for new users. @yashsehgal started working on that. There is currently discussion about the design and way of display of the tutorials. It will probably be a modal, which we will be able to open identically to the settings modal - the corresponding icon will be located just above the settings icon in the bottom left corner of the application. We also have a problem with choosing a library for the slider, currently we are testing several and will choose the best one. For more info and udpates please check mentioned issue.
  • Add the ability to launch studio without editor and new file options.

asyncapi-react

NOTE: Included changes only for next branch.

• New Features:
  • Bump of dependencies that had security vulnerabilities.
  • Component supports 2.4.0 AsyncAPI - messageId on Message Object and security field on Operation Object.
  • Add fallback for null parameter's schema - prevent errors when someone define schema's parameter as null or undefined. Very often problem in the Studio.
• Opened PRs: Nothing
• Ideas/discussions/issues:
  • Anchor-link to a specific channel
  • How to use pretty template from playground app?
  • Pretty-print schema examples

html-template

You can find more info about changes in the look of generated sections in the react-component section.

• New Features:
  • Template supports 2.4.0 version of AsyncAPI
• Opened PRs: Nothing
• Ideas/discussions/issues: Nothing

markdown-template

• New Features:
  • Template supports 2.4.0 version of AsyncAPI
• Opened PRs: Nothing
• Ideas/discussions/issues: Nothing

server-api

• New Features: Nothing
• Opened PRs:
  • Add the ability to send document references
  • Add /optimize path
• Ideas/discussions/issues: Nothing

generator

• New Features: Nothing
• Opened PRs: Nothing
• Ideas/discussions/issues: Nothing

cli

• New Features: Nothing
• Opened PRs: Nothing
• Ideas/discussions/issues: Nothing

Reminder: latest cli uses latest studio that you can open by asyncapi new --studio or asyncapi start studio.

See you in next time!