AsyncAPI EDA Design & Documentation ecosystem update (28 February 2022 - 1 April 2022)

asyncapi-eda-design-28-02-01-04-2022-update.md

AsyncAPI EDA Design & Documentation ecosystem update (28 February 2022 - 1 April 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: Nothing
• Opened PRs: Nothing
• Ideas/discussions/issues:
  • Create onboarding for features of Studio for new users.
  • Drag&drop AsyncAPI block builder
  • The future of the Studio. Some people wrote feedback, so thanks very much, but we need more!
  • Split out visulizer from code base.

asyncapi-react

NOTE: Included changes only for next branch.

• New Features:
  • Bump of dependencies that had security vulnerabilities.
• Opened PRs: Nothing
• Ideas/discussions/issues: Nothing

html-template

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

• New Features: Nothing
• Opened PRs: Nothing
• Ideas/discussions/issues:
  • Bug - If / then / else blocks generate incomplete document
  • Bug - Array of objects has wrong uid in generated HTML

markdown-template

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

server-api

• New Features:
  • Add /convert path for converting old AsyncAPI documents to the new one - thanks @BOLT04
  • Add /bundle path for bundling AsyncAPI document(s) to the single one - thanks @Samridhi-98
  • Add /diff path for checking differences between two AsyncAPI documents - thanks @ritik307
  • We serve under /docs path the documentation for ServerAPI described by OpenAPI - thanks @everly-gif
  • Add Liveliness and Readiness Probes to K8S deployment - thanks @abhijeetjejurkar
• Opened PRs:
  • Add /parse path for parsing AsyncAPI document - asyncapi/server-api#83.
  • Add /optimize path for optimizing AsyncAPI document - asyncapi/server-api#82.
  • Add the ability to send document references - asyncapi/server-api#84.
• Ideas/discussions/issues:
  • Add implementation for /parse path
  • Add implementation for /optimize path

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 month!