AsyncAPI EDA Design & Documentation ecosystem update (17 January 2022 - 28 January 2022)

asyncapi-eda-design-17-01-28-01-2022-update.md

AsyncAPI EDA Design & Documentation ecosystem update (17 January 2022 - 28 January 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:
  • We had wonderful contribution from Florian Greinacher. Now you can use the Studio using official Docker image. You can also define custom Base URL (needed functionality when you deploy studio e.g. in Kubernetes cluster). You can check this and this PR and of course here is a documentation for new functionality.
  • We added titles to the left sidebar's nodes. See this PR. Thanks Samriddhi for contribution!
  • We also fix spelling of one of our templates, PR. Thanks Ritik Rawal.
• Opened PRs:
  • Add integration with AsyncAPI Server API. After merge we will be able to generate all official templates with passing parameters. PR is already in the review phase, so if all goes good, we should merge it in this week.
  • 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!
  • Two PR opened by David Boyne: Add tooltips for navigation bar and Move template selection into modal UI. We are hope to merge them to the next update!
• Ideas/discussions/issues:
  • Mentioned in the last update The future of the Studio. Some people wrote feedback, so thanks very much, but we need more!

asyncapi-react

NOTE: Included changes only for next branch.

• New Features:
  • We didn't have documented styling things like no default fonts and no resetting of styles in the component, now we have. Thanks thim81 for such a great contribution! You can check that new docs here.
• Opened PRs: Nothing
• Ideas/discussions/issues: Two new feature request that we should consider to implement:
  • Config option to expand/collapse the examples payload
  • Anchor jump after page load

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:
  • We have opened PR with rewriting template from old Nunjucks code to the new JSX. You can check it here.
• Ideas/discussions/issues: Nothing

markdown-template

• New Features:
  • We released 1.0.0 version of template. We haven't received any new issues for a very long time so we decided that our template is production-ready and meets the expectations of the community. We currently support rendering the entire specification except for discriminator field in the Schema Object.
  • We integrated eslint in the repository.
• Opened PRs: Nothing
• Ideas/discussions/issues: Nothing

server-api

• New Features:
  • David Pereira added new /validate path. Name suggests what exactly it do :) Thanks David for that amazing contribution! For more information, please check that PR.
  • We added Helm chart with needed K8S resources. Now you can deploy our ServerAPI in your cluster! For more info, check this PR.
• Opened PRs:
  • Add /convert path for converting old AsyncAPI documents to the new one - asyncapi/server-api#26
  • We wanna enable all official supported templates in our generation in /generate path. You can check progress in this PR.
• Ideas/discussions/issues:
  • We wanna expose OpenAPI document for ServerAPI as separate page. We want to use Redocly UI component for that. You can check more info here.

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.

See you in the next update in 2 weeks!