asyncapi-eda-design-31-01-27-02-2022-update.md

AsyncAPI EDA Design & Documentation ecosystem update (31 January 2022 - 27 February 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:

  • From now on we can generate all our officially supported templates within the Studio. If you want to use the feature, please click the Generate code/docs button in the top right sidebar in the editor, select a template, pass the parameters and click Generate. You can download generated template as zip file:

  

  Please have in mind that due to lack of full JSON Schema support in template's parameters we cannot render field in correct form, as <select> etc. We have to wait for asyncapi/generator#414 to support more complex form.

  • We moved template file selection from separate page to the model. Thanks Dave Boyne!

  

• Opened PRs:

  • POC: First draft of the panels/tabs functionality. POC showing functionality of the tabs/panels in the Studio. It was mention in previous update but we need feedback!

• Ideas/discussions/issues:

  • We have one proposal for GSOC: Drag&drop AsyncAPI block builder
  • Mentioned in the last update The future of the Studio. Some people wrote feedback, so thanks very much, but we need more!
  • We have feature request to Split out visulizer from code base.

asyncapi-react

NOTE: Included changes only for next branch.

• New Features:
  • Support for 2.3.0 version of AsyncAPI
  • Remove lowercase in the JSON Schema pattern field. Thanks Ludovic Dussart!
• 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:
  • Rewriting template from old Nunjucks code to the new JSX is almost done. To speed up the template generation we have to wait for the implementation of React templates make generation process longer. Here is a mentioned PR. Thanks Ritik Rawal!
• Ideas/discussions/issues: Nothing

markdown-template

• New Features:
  • We had small bug by which we could not render a binding that contained a null or undefined value. Here is a fix. Please use 1.0.1 version of template to ensure that template isn't broken.
• Opened PRs: Nothing
• Ideas/discussions/issues: Nothing

server-api

• New Features:
  • We enable all official supported templates in our generation in /generate path.
• Opened PRs:
  • Add /convert path for converting old AsyncAPI documents to the new one - asyncapi/server-api#26. We are close to merge it, we have to fix some things.
• Ideas/discussions/issues:
  • For OpenForce event we opened/converted several issues:
    • Add implementation for /bundle path
    • Add implementation for /diff path
    • Serve openapi.yaml file as documentation page
  • We have one proposal for GSOC: Measuring AsyncAPI spec adoption
  • We opened few good first issue:
    • Add Helmet to the project
    • Add livenessProbe and readinessProbe to K8s Deployment

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 the next update in 2 weeks!